From patchwork Mon Apr 3 17:42:18 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Paul X-Patchwork-Id: 9660035 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 5CCA160352 for ; Mon, 3 Apr 2017 17:42:31 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 5105828338 for ; Mon, 3 Apr 2017 17:42:31 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 45B022837F; Mon, 3 Apr 2017 17:42:31 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.1 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_MED,T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 2BCDF28338 for ; Mon, 3 Apr 2017 17:42:29 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 29F046E033; Mon, 3 Apr 2017 17:42:29 +0000 (UTC) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mail-qt0-x235.google.com (mail-qt0-x235.google.com [IPv6:2607:f8b0:400d:c0d::235]) by gabe.freedesktop.org (Postfix) with ESMTPS id 0553B6E033 for ; Mon, 3 Apr 2017 17:42:28 +0000 (UTC) Received: by mail-qt0-x235.google.com with SMTP id r45so118628669qte.3 for ; Mon, 03 Apr 2017 10:42:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=from:to:cc:subject:date:message-id; bh=tMdzhtyqwwfub+i4DXQbhLcJfF8E+85dg7ieKPEW14M=; b=fOJyrkvI/eFJeluQAO/T/d0OM/0wWAbCAb9tfZ3+O7y+RpzMcUJQE2u+JgILZP3dnK hCVrwyACrH1zzCZ0cpHjSi/CIM5Q2e8P5BwlN+9J03G4Qpp4Sg6v+fYH3opdNw1HQVu1 MI/lkcxbnWjAvX9/CUbg4/bgAjzBCO5fVVtmc= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=tMdzhtyqwwfub+i4DXQbhLcJfF8E+85dg7ieKPEW14M=; b=HBKwcEwqQZb6cm0Ot/ZYLYcR1eyzwA0Xr6zJbQDcsOSa42xwKTLwQw+fLPHBJlmcBq LnY0jYUDtA9/Lxdd0suGnExajh3cor9hlqyJHYDR4ZGWOLf/mgVyL8+CYK1/lkJlEsiB xGTCtxI/dtkI2xd9RgAnbcea7KpLKTDd04wRD9Tm9Md5RB10o0nuaqyD3KBSkbpy0rUK qPhpEhTnQmcT37k2fE0+ShCukaq4lFXVeequWcc/1+S/odTHBPJI4qIQj4C6zVMXX/3z QMBh+IyJCqPeusWTfMlx2BbarPCGh9HuREf7fD3trQgKGmHdCVqghTiZFZxKbitV+Kst miaw== X-Gm-Message-State: AFeK/H2t/yNEelb4nno1UOV2Qxobh2mVZwQ/3IdVueJOPWlp+zQBAzxvsGHLvF9JonhulmT5 X-Received: by 10.237.53.143 with SMTP id c15mr17218687qte.49.1491241346042; Mon, 03 Apr 2017 10:42:26 -0700 (PDT) Received: from boxwood.roam.corp.google.com (cpe-75-189-128-87.nc.res.rr.com. [75.189.128.87]) by smtp.gmail.com with ESMTPSA id o23sm354008qko.12.2017.04.03.10.42.24 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 03 Apr 2017 10:42:25 -0700 (PDT) From: Sean Paul To: intel-gfx@lists.freedesktop.org Date: Mon, 3 Apr 2017 13:42:18 -0400 Message-Id: <20170403174224.39021-1-seanpaul@chromium.org> X-Mailer: git-send-email 2.12.2.564.g063fe858b8-goog Cc: daniel.vetter@intel.com Subject: [Intel-gfx] [maintainer-tools PATCH] dim: Add examples section to dim.rst X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" X-Virus-Scanned: ClamAV using ClamSMTP Along with a recipe for creating a topic branch and sending a pull request from it. Signed-off-by: Sean Paul --- dim.rst | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/dim.rst b/dim.rst index bc4d9a0..4b905ad 100644 --- a/dim.rst +++ b/dim.rst @@ -465,6 +465,56 @@ listed using the **list-aliases** subcommand. The alias functionality requires **bash(1)** version 4.3 or later to work. +EXAMPLES +======== + +Cross-subsystem pull requests +----------------------------- +So you want to send a pull request to another subsystem? Maintainers will likely +get cranky if you ask them to pull a swath of unrelated drm patches, so we'll +use a topic branch based upon Linus' tree with only the relevant patches. + +First, create the topic branch using dim. Use whichever dim remote is most +applicable, and name the branch in a manner that describes the set of patches +you want pulled. The upstream will be Linus' tree. + + $ dim create-branch *dim-remote*/topic/*topic-branch* origin/master + +Once the branch is created, you can apply the patches to be pulled. + + $ dim apply-branch topic/*topic-branch* + +Build test your new topic branch and push it. + + $ dim push-branch topic/*topic-branch* + +Ensure that your topic branch was merged into drm-tip. The drm-tip tree is +located in $DIM_PREFIX/drm-tip, build test it to ensure the new topic branch +didn't break anything. + +Once you're satisfied that nothing is broken, create the pull request. + + $ dim pull-request topic/*topic-branch* origin/master + +You'll be prompted to enter a tag description and your mail user agent will open +with the pull request email. Change names and emails as appropriate to reflect +who the sender and recipient of the pull is, and send it. + +Once the pull has been acked by your maintainer counterpart, you can pull it +into the appropriate local dim branch. + + $ dim apply-pull *dim-branch* + +Perform a final build test, and push *dim-branch* to *dim-remote*. + + $ dim push-branch *dim-branch* + +You can now remove the topic branch, as it is no longer useful (you could remove +it any time after the pull request, since it creates a tag, but this is as good +a place as any). + + $ dim remote-branch topic/*topic-branch* + CONTRIBUTING ============