git/Documentation/gittutorial.txt, branch v2.48.2

Merge branch 'jc/grammo-fixes'

2024-08-21T19:02:24Z

Doc updates. * jc/grammo-fixes: doc: grammofix in git-diff-tree tutorial: grammofix

tutorial: grammofix

2024-08-09T17:14:48Z

We say "these", so "range notations" must be plural. Reported-by: Furkan Akkurt Signed-off-by: Junio C Hamano

doc: correct the 50 characters soft limit (+)

2023-10-09T19:07:26Z

The soft limit of the first line of the commit message should be "no more than 50 characters" or "50 characters or less", but not "less than 50 character". This is an addition to commit c2c349a15c (doc: correct the 50 characters soft limit, 2023-09-28). Signed-off-by: 谢致邦 (XIE Zhibang) Signed-off-by: Junio C Hamano

gittutorial: wrap literal examples in backticks

2023-04-20T21:34:08Z

Our coding guidelines prefer literal examples to be wrapped in `backticks` to typeset them in monospace. Signed-off-by: Martin Ågren Signed-off-by: Junio C Hamano

gittutorial: drop early mention of origin

2023-04-20T21:34:07Z

We don't have an origin at this point in the tutorial, so "Your branch is up to date" won't actually show up in the output of `git status`. This line was introduced in 8942821ec0 ("gittutorial: fix output of 'git status'", 2014-11-13) in what looks like a mistake -- that commit mostly just wanted to remove leading '#' characters. Signed-off-by: Martin Ågren Signed-off-by: Junio C Hamano

Documentation: render special characters correctly

2021-07-30T16:08:12Z

Three hyphens are rendered verbatim, so "--" has to be used to produce a dash. There is no double arrow ("<->" is rendered as "<→"), so a left and right arrow "<-->" have to be combined for that. So fix asciidoc output for special characters. This is similar to fixes in commit de82095a95 (doc hash-function-transition: fix asciidoc output, 2021-02-05). Signed-off-by: Andrei Rybak Acked-by: Jeff King Signed-off-by: Junio C Hamano

doc: promote "git restore"

2019-05-07T04:04:48Z

The new command "git restore" (together with "git switch") are added to avoid the confusion of one-command-do-all "git checkout" for new users. They are also helpful to avoid ambiguous context. For these reasons, promote it everywhere possible. This includes documentation, suggestions/advice from other commands. One nice thing about git-restore is the ability to restore "everything", so it can be used in "git status" advice instead of both "git checkout" and "git reset". The three commands suggested by "git status" are add, rm and restore. "git checkout" is also removed from "git help" (i.e. it's no longer considered a commonly used command) Signed-off-by: Nguyễn Thái Ngọc Duy Signed-off-by: Junio C Hamano

doc: promote "git switch"

2019-04-02T04:57:00Z

The new command "git switch" is added to avoid the confusion of one-command-do-all "git checkout" for new users. They are also helpful to avoid ambiguation context. For these reasons, promote it everywhere possible. This includes documentation, suggestions/advice from other commands... The "Checking out files" progress line in unpack-trees.c is also updated to "Updating files" to be neutral to both git-checkout and git-switch. Signed-off-by: Nguyễn Thái Ngọc Duy Signed-off-by: Junio C Hamano

treewide: correct several "up-to-date" to "up to date"

2017-08-23T19:17:22Z

Follow the Oxford style, which says to use "up-to-date" before the noun, but "up to date" after it. Don't change plumbing (specifically send-pack.c, but transport.c (git push) also has the same string). This was produced by grepping for "up-to-date" and "up to date". It turned out we only had to edit in one direction, removing the hyphens. Fix a typo in Documentation/git-diff-index.txt while we're there. Reported-by: Jeffrey Manian Reported-by: STEVEN WHITE Signed-off-by: Martin Ågren Signed-off-by: Junio C Hamano

Documentation: unify bottom "part of git suite" lines

2017-02-09T23:14:01Z

We currently have 168 man pages that mention they are part of Git, you can check yourself easily via: $ git grep "Part of the linkgit:git\[1\] suite" |wc -l 168 However some have a trailing period, i.e. $ git grep "Part of the linkgit:git\[1\] suite." |wc -l 8 Unify the bottom line in all man pages to not end with a period. Signed-off-by: Stefan Beller Signed-off-by: Junio C Hamano