From: Chris Packham <judge.packham@gmail.com>
To: Jeremiah Mahler <jmmahler@gmail.com>, git@vger.kernel.org
Subject: Re: [PATCH] wording fixes in the user manual and glossary
Date: Sun, 25 May 2014 19:56:41 +1200 [thread overview]
Message-ID: <5381A239.2060809@gmail.com> (raw)
In-Reply-To: <1400989841-2845-1-git-send-email-jmmahler@gmail.com>
On 25/05/14 15:50, Jeremiah Mahler wrote:
> Some minor wording fixes in the user manual and glossary.
>
> Signed-off-by: Jeremiah Mahler <jmmahler@gmail.com>
> ---
> Documentation/glossary-content.txt | 2 +-
> Documentation/user-manual.txt | 8 ++++----
> 2 files changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
> index be0858c..4e0b971 100644
> --- a/Documentation/glossary-content.txt
> +++ b/Documentation/glossary-content.txt
> @@ -1,7 +1,7 @@
> [[def_alternate_object_database]]alternate object database::
> Via the alternates mechanism, a <<def_repository,repository>>
> can inherit part of its <<def_object_database,object database>>
> - from another object database, which is called "alternate".
> + from another object database, which is called an "alternate".
>
> [[def_bare_repository]]bare repository::
> A bare repository is normally an appropriately
> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
> index d33f884..efb3c97 100644
> --- a/Documentation/user-manual.txt
> +++ b/Documentation/user-manual.txt
> @@ -416,7 +416,7 @@ REVISIONS" section of linkgit:gitrevisions[7].
> Updating a repository with git fetch
> ------------------------------------
>
> -Eventually the developer cloned from will do additional work in her
> +Eventually the developer will do additional work in her cloned
> repository, creating new commits and advancing the branches to point
> at the new commits.
I agree that the original wording isn't clear but I'm not sure the new
wording is any clearer. The paragraph is trying to explain how to fetch
upstream changes when they happen. My initial thought was to say
"Eventually the developer will do additional work in the upstream
repository" but perhaps it is to early to start throwing around terms
like upstream. Perhaps just saying "her repository" would be clearest.
>
> @@ -1811,8 +1811,8 @@ manner.
> You can then import these into your mail client and send them by
> hand. However, if you have a lot to send at once, you may prefer to
> use the linkgit:git-send-email[1] script to automate the process.
> -Consult the mailing list for your project first to determine how they
> -prefer such patches be handled.
> +Consult the mailing list for your project first to determine
> +their requirements for submitting patches.
>
> [[importing-patches]]
> Importing patches to a project
> @@ -2255,7 +2255,7 @@ $ git checkout test && git merge speed-up-spinlocks
> It is unlikely that you would have any conflicts here ... but you might if you
> spent a while on this step and had also pulled new versions from upstream.
>
> -Some time later when enough time has passed and testing done, you can pull the
> +Sometime later when enough time has passed and testing done, you can pull the
> same branch into the `release` tree ready to go upstream. This is where you
> see the value of keeping each patch (or patch series) in its own branch. It
> means that the patches can be moved into the `release` tree in any order.
>
next prev parent reply other threads:[~2014-05-25 7:56 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-05-25 3:50 [PATCH] wording fixes in the user manual and glossary Jeremiah Mahler
2014-05-25 7:56 ` Chris Packham [this message]
2014-05-25 8:37 ` Jeremiah Mahler
2014-05-26 7:50 ` Chris Packham
2014-05-26 8:11 ` Ben Aveling
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=5381A239.2060809@gmail.com \
--to=judge.packham@gmail.com \
--cc=git@vger.kernel.org \
--cc=jmmahler@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).