[Intel-gfx] [maintainer-tools PATCH] dim: Fix assorted documentation typos
Jani Nikula
jani.nikula at linux.intel.com
Thu Mar 30 06:37:15 UTC 2017
On Wed, 29 Mar 2017, Lukas Wunner <lukas at wunner.de> wrote:
> Just a bunch of trivial typos that caught my eye while perusing the
> documentation.
>
> Signed-off-by: Lukas Wunner <lukas at wunner.de>
Reviewed-by: Jani Nikula <jani.nikula at intel.com>
Thanks, please push yourself!
> ---
> 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 <username>' >> ~/.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
> <drm-intel.html#resolving-conflicts-when-rebuilding-drm-tip>`_.
--
Jani Nikula, Intel Open Source Technology Center
More information about the Intel-gfx
mailing list