git/Documentation/git-notes.txt, branch v2.40.2

notes docs: de-duplicate and combine configuration sections

2022-09-07T16:46:06Z

Combine the various "notes" configuration sections spread across Documentation/config/notes.txt and Documentation/git-notes.txt to live in the former, and to be included in the latter. We'll now forward link from "git notes" to the "CONFIGURATION" section below, rather than to "git-config(1)" when discussing configuration variables that are (also) discussed in that section. Signed-off-by: Ævar Arnfjörð Bjarmason Reviewed-by: Matheus Tavares Signed-off-by: Junio C Hamano

docs: improve the example that illustrates git-notes path names

2020-08-03T19:40:09Z

Make it clear that the filename has only the rest of the object ID, not the entirety of it. Signed-off-by: Noam Yorav-Raphael Acked-by: Taylor Blau Signed-off-by: Junio C Hamano

notes: fix minimum number of parameters to "copy" subcommand

2019-10-18T00:43:10Z

The builtin/notes.c::copy() function is prepared to handle either one or two arguments given from the command line; when one argument is given, to-obj defaults to HEAD. bbb1b8a3 ("notes: check number of parameters to "git notes copy"", 2010-06-28) tried to make sure "git notes copy" (with *no* other argument) does not dereference NULL by checking the number of parameters, but it incorrectly insisted that we need two arguments, instead of either one or two. This disabled the defaulting to-obj to HEAD. Correct it. Signed-off-by: Doan Tran Cong Danh Signed-off-by: Junio C Hamano

Documentation: turn middle-of-line tabs into spaces

2019-03-07T00:25:32Z

These tabs happen to appear in columns where they don't stand out too much, so the diff here is non-obvious. Some of these are rendered differently by AsciiDoc and Asciidoctor (although the difference might be invisible!), which is how I found a few of them. The remainder were found using `git grep "[a-zA-Z.,)]$TAB[a-zA-Z]"`. Signed-off-by: Martin Ågren Signed-off-by: Junio C Hamano

Documentation: spelling and grammar fixes

2018-06-22T21:26:23Z

Signed-off-by: Ville Skyttä Reviewed-by: Eric Sunshine Signed-off-by: Junio C Hamano

Merge branch 'rd/doc-notes-prune-fix'

2017-12-06T17:23:40Z

Doc update. * rd/doc-notes-prune-fix: notes: correct 'git notes prune' options to '[-n] [-v]'

notes: correct 'git notes prune' options to '[-n] [-v]'

2017-11-22T03:59:02Z

Currently, 'git notes prune' in man page and usage message incorrectly lists options as '[-n | -v]', rather than '[-n] [-v]'. Signed-off-by: Robert P. J. Day Reviewed-by: Jonathan Nieder Signed-off-by: Junio C Hamano

doc: fix minor typos (extra/duplicated words)

2017-09-14T06:09:02Z

Following are several fixes for duplicated words ("of of") and one case where an extra article ("a") slipped in. Signed-off-by: Evan Zacks Signed-off-by: Junio C Hamano

doc: typeset short command-line options as literal

2016-06-28T15:20:52Z

It was common in our documentation to surround short option names with forward quotes, which renders as italic in HTML. Instead, use backquotes which renders as monospace. This is one more step toward conformance to Documentation/CodingGuidelines. This was obtained with: perl -pi -e "s/'(-[a-z])'/\`\$1\`/g" *.txt Signed-off-by: Matthieu Moy Signed-off-by: Junio C Hamano

doc: change environment variables format

2016-06-08T19:04:37Z

This change GIT_* variables that where in italic style to monospaced font according to the guideline. It was obtained with perl -pi -e "s/\'(GIT_.*?)\'/\`\1\`/g" *.txt One of the main purposes is to stick to the CodingGuidelines as possible so that people writting new documentation by mimicking the existing are more likely to have it right (even if they didn't read the CodingGuidelines). Signed-off-by: Tom Russello Signed-off-by: Erwan Mathoniere Signed-off-by: Samuel Groot Signed-off-by: Matthieu Moy Reviewed-by: Matthieu Moy Signed-off-by: Junio C Hamano