git/Documentation/git-diff-index.txt, branch v2.45.3

documentation: wording improvements

2023-10-09T19:04:21Z

Diff best viewed with --color-diff. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano

diff-index.txt: update raw output format in examples

2022-06-13T18:59:16Z

The two examples in the doc for 'git diff-index' were not updated when the raw output format was changed in 81e50eabf0 ([PATCH] The diff-raw format updates., 2005-05-21) (first example) and in b6d8f309d9 ([PATCH] diff-raw format update take #2., 2005-05-23) and 7cb6ac1e4b (diff: diff_aligned_abbrev: remove ellipsis after abbreviated SHA-1 value, 2017-12-03) (second example). Update the output, inventing some characters to complete the source hash in the second example. Also correct the destination mode in the second example, which was wrongly '100664' since the addition of the example in c64b9b8860 (Reference documentation for the core git commands., 2005-05-05). Signed-off-by: Philippe Blain Signed-off-by: Junio C Hamano

doc: use only hyphens as word separators in placeholders

2021-11-09T17:39:11Z

According to CodingGuidelines, multi-word placeholders should use hyphens as word separators. Signed-off-by: Jean-Noël Avila Signed-off-by: Junio C Hamano Reviewed-by: Eli Schwartz Signed-off-by: Junio C Hamano

builtin/diff-index: learn --merge-base

2020-09-21T04:30:26Z

There is currently no easy way to take the diff between the working tree or index and the merge base between an arbitrary commit and HEAD. Even diff's `...` notation doesn't allow this because it only works between commits. However, the ability to do this would be desirable to a user who would like to see all the changes they've made on a branch plus uncommitted changes without taking into account changes made in the upstream branch. Teach diff-index and diff (with one commit) the --merge-base option which allows a user to use the merge base of a commit and HEAD as the "before" side. Signed-off-by: Denton Liu Signed-off-by: Junio C Hamano

git-diff-index.txt: make --cached description a proper sentence

2020-09-17T16:38:46Z

Signed-off-by: Denton Liu Signed-off-by: Junio C Hamano

doc: keep first level section header in upper case

2018-05-02T08:03:33Z

When formatted as a man page, 1st section header is always in upper case even if we write it otherwise. Make all 1st section headers uppercase to keep it close to the final output. This does affect html since case is kept there, but I still think it's a good idea to maintain a consistent style for 1st section headers. Some sections perhaps should become second sections instead, where case is kept, and for better organization. I will update if anyone has suggestions about this. While at there I also make some header more consistent (e.g. examples vs example) and fix a couple minor things here and there. 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

doc: typeset long command-line options as literal

2016-06-28T15:36:45Z

Similarly to the previous commit, use backquotes instead of forward-quotes, for long options. This was obtained with: perl -pi -e "s/'(--[a-z][a-z=<>-]*)'/\`\$1\`/g" *.txt and manual tweak to remove false positive in ascii-art (o'--o'--o' to describe rewritten history). Signed-off-by: Matthieu Moy Signed-off-by: Junio C Hamano

Documentation/diff-index: mention two modes of operation

2013-05-20T22:50:44Z

"diff-index" can be used to compare a tree with the tracked working tree files (when used without the --index option), or with the index (when used with the --index option). The text however did not say anything about the comparison with the working tree at all. Fix this. Reported-by: Albert Netymk Helped-by: Jonathan Nieder Signed-off-by: Junio C Hamano

Documentation: use [verse] for SYNOPSIS sections

2011-07-06T21:26:26Z

The SYNOPSIS sections of most commands that span several lines already use [verse] to retain line breaks. Most commands that don't span several lines seem not to use [verse]. In the HTML output, [verse] does not only preserve line breaks, but also makes the section indented, which causes a slight inconsistency between commands that use [verse] and those that don't. Use [verse] in all SYNOPSIS sections for consistency. Also remove the blank lines from git-fetch.txt and git-rebase.txt to align with the other man pages. In the case of git-rebase.txt, which already uses [verse], the blank line makes the [verse] not apply to the last line, so removing the blank line also makes the formatting within the document more consistent. While at it, add single quotes to 'git cvsimport' for consistency with other commands. Signed-off-by: Martin von Zweigbergk Signed-off-by: Junio C Hamano