From patchwork Tue Mar 28 21:09:38 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lukas Wunner X-Patchwork-Id: 9652625 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 015FF602C8 for ; Wed, 29 Mar 2017 21:16:32 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id E53102855E for ; Wed, 29 Mar 2017 21:16:31 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id D63712855D; Wed, 29 Mar 2017 21:16: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=-3.2 required=2.0 tests=BAYES_00, DATE_IN_PAST_12_24, RCVD_IN_DNSWL_MED 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 0FB482855D for ; Wed, 29 Mar 2017 21:16:30 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id CBBB3893DB; Wed, 29 Mar 2017 21:16:29 +0000 (UTC) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org X-Greylist: delayed 408 seconds by postgrey-1.35 at gabe; Wed, 29 Mar 2017 21:16:28 UTC Received: from mailout2.hostsharing.net (mailout2.hostsharing.net [83.223.90.233]) by gabe.freedesktop.org (Postfix) with ESMTPS id E728189E01 for ; Wed, 29 Mar 2017 21:16:28 +0000 (UTC) Received: from h08.hostsharing.net (h08.hostsharing.net [83.223.95.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mailout2.hostsharing.net (Postfix) with ESMTPS id E152010189C1A; Wed, 29 Mar 2017 23:09:34 +0200 (CEST) Received: from localhost (5-38-90-81.adsl.cmo.de [81.90.38.5]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-SHA (128/128 bits)) (No client certificate requested) by h08.hostsharing.net (Postfix) with ESMTPSA id 8D79E6000578; Wed, 29 Mar 2017 23:09:35 +0200 (CEST) X-Mailbox-Line: From 30390d3add1bb5a8decbfe49f38034bea516ce4c Mon Sep 17 00:00:00 2001 Message-Id: <30390d3add1bb5a8decbfe49f38034bea516ce4c.1490795284.git.lukas@wunner.de> From: Lukas Wunner Date: Tue, 28 Mar 2017 23:09:38 +0200 To: intel-gfx@lists.freedesktop.org Subject: [Intel-gfx] [maintainer-tools PATCH] dim: Fix assorted documentation typos 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 Just a bunch of trivial typos that caught my eye while perusing the documentation. Signed-off-by: Lukas Wunner Reviewed-by: Jani Nikula --- dim.rst | 14 +++++++------- drm-intel.rst | 10 +++++----- drm-misc.rst | 2 +- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/dim.rst b/dim.rst index aed79ca1d43c..3aa0eeae9a7a 100644 --- a/dim.rst +++ b/dim.rst @@ -31,7 +31,7 @@ Used to maintain drm-intel_ and drm-misc_ git repositories. QUICKSTART ========== -For getting started grab the latest drm (drm-intel-maintainer) script from:: +For getting started grab the latest dim (drm-intel-maintainer) script from:: http://cgit.freedesktop.org/drm-intel/tree/dim?h=maintainer-tools @@ -56,7 +56,7 @@ you have improvements for dim, please submit them to intel-gfx. If you have a freedesktop.org account and plan to push things on one of the drm-xxx repos, you should use the ssh://git.freedesktop.org/git/drm-xxx urls -when adding a remote and, if it's not already done, you should add new entry in +when adding a remote and, if it's not already done, you should add a new entry in ~/.ssh/config:: $ printf '\nHost git.freedesktop.org\n\tUser ' >> ~/.ssh/config @@ -200,7 +200,7 @@ apply-queued [*git am arguments*] extract-tags *branch* [*git-rangeish*] -------------------------------------- -This extracts various tags (eg. Reviwed-by:) from emails and applies them to the +This extracts various tags (e.g. Reviewed-by:) from emails and applies them to the top commit on the given branch. You can give the command a rangeish to add the tags from the same email to multiple already applied patches. @@ -277,12 +277,12 @@ add-link-queued magic-rebase-resolve -------------------- Tries to resolve a rebase conflict by first resetting the tree -and the using the magic patch tool. Then builds the tree, adds +and then using the magic patch tool. Then builds the tree, adds any changes with git add -u and continues the rebase. apply-resolved -------------- -Compile-test the current tree and if successfully resolve a +Compile-test the current tree and if successful resolve a conflicted git am. Also runs the patch checker afterwards. This fails to add the Link: tag, so you'll need to add it manually or use the **add-link** subcommand. @@ -292,7 +292,7 @@ Create a new topic branch with the given name. Note that topic/ is not automatically prepended. The branch starts at HEAD or the given commit-ish. Note that by default the new branch is created in the drm-intel.git repository. If you want to create a branch somewhere else, then you need to prepend the remote -name from nigthly.conf, e.g. "drm-misc/topic/branch". +name from nightly.conf, e.g. "drm-misc/topic/branch". remove-branch *branch* ---------------------- @@ -413,7 +413,7 @@ Show this help. Install **rst2man(1)** for best results. usage ----- -Short form usage help listening all subcommands. Run by default or if an unknown +Short form usage help listing all subcommands. Run by default or if an unknown subcommand was passed on the cmdline. ENVIRONMENT diff --git a/drm-intel.rst b/drm-intel.rst index 9be1f086e925..c9c8812dc254 100644 --- a/drm-intel.rst +++ b/drm-intel.rst @@ -87,7 +87,7 @@ This is the branch where all new features, as well as any non-trivial or controversial fixes, are applied. This branch "hides" the merge window from the drm/i915 developers; patches are -applied here regardless of the development phase of the Linus' upstream kernel. +applied here regardless of the development phase of Linus' upstream kernel. drm-intel-next ~~~~~~~~~~~~~~ @@ -220,7 +220,7 @@ Signed-off-by: line in the commit message: Resolving Conflicts when Rebuilding drm-tip =========================================== -When you push patches with dim drm-tip always gets rebuild and this can +When you push patches with dim drm-tip always gets rebuilt and this can sometimes fail, for example like this: :: Updating rerere cache and nightly.conf... Done. @@ -263,7 +263,7 @@ when it's tricky or something fails in the below procedure. $ git commit -a git will then store the conflict resolution internally (see git help rerere - for how this is implemented). Then re-run -nigthly generation to confirm the + for how this is implemented). Then re-run drm-tip generation to confirm the resolution has been captured correctly by git (sometimes git rerere can't match up your resolution with the conflict for odd reasons) and to make sure there's no other conflict in later merges: :: @@ -457,7 +457,7 @@ stakeholders. There's three components for that: domain experts, maybe maintainers. Also include maintainers and reviewers of the userspace component for new ABI, which often means non-Intel people. In case of doubt ask maintainers for a reasonable list of people. Make sure you - gather their input actively, don't expect them to deliver it on their on - + gather their input actively, don't expect them to deliver it on their own - most are really busy. * Have agreement among all these stakeholders what the code should look like in @@ -485,7 +485,7 @@ stakeholders. There's three components for that: Try to reach rough consensus before spending months writing code you might need to throw away or at least entirely rewrite again. Also make sure that all discussions happen in public forums, and make sure there's a searchable -permanent record of any discussions for later references. This means that for +permanent record of any discussions for later reference. This means that for most things internal meetings are not the most suitable venue. Pre-Merge Testing diff --git a/drm-misc.rst b/drm-misc.rst index b6d01f2c7c2b..8c007b3da9f1 100644 --- a/drm-misc.rst +++ b/drm-misc.rst @@ -63,7 +63,7 @@ drm-tip This is the overall integration tree for drm, and lives in `git://anongit.freedesktop.org/drm-tip`. Every time one of the above branches is -update drm-tip gets rebuild. If there's a conflict see section on `resolving +updated drm-tip gets rebuilt. If there's a conflict see section on `resolving conflicts when rebuilding drm-tip `_.