From patchwork Wed Apr 5 19:59:52 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Paul X-Patchwork-Id: 9665583 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 3918760353 for ; Wed, 5 Apr 2017 20:00:12 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 2BA5722638 for ; Wed, 5 Apr 2017 20:00:12 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 2045B2859F; Wed, 5 Apr 2017 20:00:12 +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 0105222638 for ; Wed, 5 Apr 2017 20:00:10 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 28F6C89722; Wed, 5 Apr 2017 20:00:10 +0000 (UTC) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mail-qk0-x230.google.com (mail-qk0-x230.google.com [IPv6:2607:f8b0:400d:c09::230]) by gabe.freedesktop.org (Postfix) with ESMTPS id 9CD7E89722 for ; Wed, 5 Apr 2017 20:00:08 +0000 (UTC) Received: by mail-qk0-x230.google.com with SMTP id d10so21030547qke.1 for ; Wed, 05 Apr 2017 13:00:08 -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:in-reply-to:references; bh=mHj0hqjO0navLGyydXbZ61LAKG2xGDloeUWaPHFdevE=; b=ddU6xLYXiwlNxOEolaZLhttzXaZtfgRQeAPdBKd6sOSgtVo3zBgbIuDkE7yEVkrvov +Y80UDKWUvrcQBBKi7zrnYQNjkCHtmPJeVLKuuaWJo3bx9ddnr2FsL9Szyvbn0HupCDv XBikmS4UYXTwFqvOVIQbQanhQQ8JR5C5pa/Cg= 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:in-reply-to :references; bh=mHj0hqjO0navLGyydXbZ61LAKG2xGDloeUWaPHFdevE=; b=hNeY2PhIe3lh6R21dcGdYFNmCWTG0evAeK7eKOwyLFIMnBog8rravEU8FFYmH2/gP/ WLSKRGxm1PJz9a/UhRSwQZBMib+sy+mHN1wrZ2UbFRxTOk3Oe4WJVoYT4ql6Dq3c6R58 ioc8ar+6TPtqJA4k5cPE6HhHcNhNJmK5fdWT4cF9Bo+J5n7yHekoDz467j0iSnnrz3iH +mYFbFqDB/AsSCU8TtiIRXtZ1qYBtYaZuC9F6iu3/9X1Fck4D1BU0kZkXm/STUccZeCl nbLK7n/td4dRWM31MTlakPN+IjJfM0Ss73ve0T0+r/fwdWPxkev9rcnszfjKn782Gxyt 7B0g== X-Gm-Message-State: AFeK/H1ziUDfYoEnEnnH6jL2G/YP8yMurd3jmf7I6ceuDv9i9K3Kj43phm81RUDCs55dhUEb X-Received: by 10.55.22.217 with SMTP id 86mr22105769qkw.139.1491422406910; Wed, 05 Apr 2017 13:00:06 -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 19sm14669482qtv.38.2017.04.05.13.00.05 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 05 Apr 2017 13:00:06 -0700 (PDT) From: Sean Paul To: daniel@ffwll.ch, intel-gfx@lists.freedesktop.org Date: Wed, 5 Apr 2017 15:59:52 -0400 Message-Id: <20170405200004.1921-1-seanpaul@chromium.org> X-Mailer: git-send-email 2.12.2.715.g7642488e1d-goog In-Reply-To: <20170404062326.6pw56w4a3zk37hij@phenom.ffwll.local> References: <20170404062326.6pw56w4a3zk37hij@phenom.ffwll.local> Subject: [Intel-gfx] [maintainer-tools PATCH v2] 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 --- Changes in v2: - Address danvet's comments - added paragraph about selecting a baseline - s_origin/master_*baseline*_ - s/build test/test/ - add breadcrumb in drm-misc docs dim.rst | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ drm-misc.rst | 3 ++- 2 files changed, 59 insertions(+), 1 deletion(-) diff --git a/dim.rst b/dim.rst index b99248e..3dd19f9 100644 --- a/dim.rst +++ b/dim.rst @@ -472,6 +472,63 @@ listed using the **list-aliases** subcommand. The alias functionality requires **bash(1)** version 4.3 or later to work. +EXAMPLES +======== + +Cross-subsystem topic branches +------------------------------ +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 select a suitable *baseline* for your topic branch. For topic +branches shared within the gpu/drm subsystem, base it on the latest +drm-next branch. For anything else, base it on the latest -rc tag from +Upstream (not just any random position). In very rare cases you might need +to apply topic branch pull requests from other maintainers before you can +apply patches to construct a suitable baseline first. + +Next, 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* *baseline* + +Once the branch is created, you can apply the patches to be pulled. + + $ dim apply-branch topic/*topic-branch* + +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, 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* *baseline* + +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 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 remove-branch topic/*topic-branch* + CONTRIBUTING ============ diff --git a/drm-misc.rst b/drm-misc.rst index 8c6e4bf..45ea795 100644 --- a/drm-misc.rst +++ b/drm-misc.rst @@ -86,7 +86,8 @@ Right now the only hard merge criteria are: * Any non-linear actions (backmerges, merging topic branches and sending out pull requests) are only done by the official drm-misc maintainers (currently - Daniel, Jani and Sean, see MAINTAINERS), and not by committers. + Daniel, Jani and Sean, see MAINTAINERS), and not by committers. See the + `examples section in dim `_ for more info * All the x86, arm and arm64 DRM drivers need to still compile. To simplify this we track defconfigs for all three platforms in the `drm-intel-rerere` branch.