git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Rory O’Kane" <rory@roryokane.com>
To: git@vger.kernel.org
Subject: Minor typos in the documentation for git checkout <branch>
Date: Wed, 16 Jan 2019 19:17:07 -0500	[thread overview]
Message-ID: <CAD_ag1MODHkfkMyaovg2JgcsX-=Tk6+BHFSYxwE8g5HGhvZ-1g@mail.gmail.com> (raw)

I noticed some errors in one paragraph of the documentation for the <branch>
argument of git-checkout. A convenient link to that documentation:
https://git-scm.com/docs/git-checkout#git-checkout-ltbranchgt

This is the current AsciiDoc source for that paragraph:

    You can use the `"@{-N}"` syntax to refer to the N-th last
    branch/commit checked out using "git checkout" operation. You may
    also specify `-` which is synonymous to `"@{-1}`.

That source comes from Documentation/git-checkout.txt:
https://github.com/git/git/blob/77556354bb7ac50450e3b28999e3576969869068/Documentation/git-checkout.txt#L290-L292

I suggest changing that source to this:

    You can use the `"@{-<n>}"` syntax to refer to the <n>th last
    branch/commit checked out using the "git checkout" operation. You
    may also specify `"-"`, which is synonymous to `"@{-1}"`.

These are the changes:

- Added the missing closing double quote to `"@{-1}` at the end.
- Added the word “the” before ‘"git checkout” operation’.
- Added quotes around “-”, to make it more visible and consistent with the
  other syntax in the paragraph.
- Added comma before “which”.
- For consistency, used the angle bracket style of placeholder also used by
  the explanation of the “@{-<n>}, e.g. @{-1}” syntax (see link) within the
  documentation for gitrevisions (see link).
  [gitrevisions source]:
https://github.com/git/git/blob/77556354bb7ac50450e3b28999e3576969869068/Documentation/revisions.txt#L94-L96
  [gitrevisions rendered]:
https://git-scm.com/docs/gitrevisions#gitrevisions-em-ltngtemegem-1em

(This is my first email to the Git mailing list; I hope I did it right.)

                 reply	other threads:[~2019-01-17  0:17 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAD_ag1MODHkfkMyaovg2JgcsX-=Tk6+BHFSYxwE8g5HGhvZ-1g@mail.gmail.com' \
    --to=rory@roryokane.com \
    --cc=git@vger.kernel.org \
    /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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).