git/Documentation/git-var.adoc, branch jch

doc: replace git config --list/-l with `list`

2026-04-06T16:57:07Z

Replace uses of `git config --list` (short or long) with the subcommand `list` since `--list` is deprecated. We will change the “man page” phrasing in gitcvs-migration(7) in the next commit, since we are already visiting that sentence. But note that we leave the “man page” phrasing in the sentence that we touch in gittutorial(7) since it’s a tutorial and not a manual page. We can be more wordy in a tutorial context. Signed-off-by: Kristoffer Haugsbakk Signed-off-by: Junio C Hamano

git-var doc: fix usage of $ENV_VAR vs ENV_VAR

2025-05-12T16:25:27Z

When refering to environment variables in the documentation, use the ENV_VARIABLE format instead of $ENV_VARIABLE. The latter is used in the documentation to refer to the actual value of the variable, not the name of the variable. Signed-off-by: Jean-Noël Avila Signed-off-by: Junio C Hamano

git-{var,write-tree} docs: update mark-up of synopsis option descriptions

2025-05-12T16:25:26Z

To unify mark-up used in our documentation to a newer convention, started by 22293895 (doc: apply synopsis simplification on git-clone and git-init, 2024-09-24), update the documentation for 'git var' and 'git write-tree' to * use [synopsis], not [verse] in the SYNOPSIS section * enclose `--option=` in backquotes Signed-off-by: Junio C Hamano Helped-by: Jean-Noël Avila Signed-off-by: Junio C Hamano

doc: use .adoc extension for AsciiDoc files

2025-01-21T20:56:06Z

We presently use the ".txt" extension for our AsciiDoc files. While not wrong, most editors do not associate this extension with AsciiDoc, meaning that contributors don't get automatic editor functionality that could be useful, such as syntax highlighting and prose linting. It is much more common to use the ".adoc" extension for AsciiDoc files, since this helps editors automatically detect files and also allows various forges to provide rich (HTML-like) rendering. Let's do that here, renaming all of the files and updating the includes where relevant. Adjust the various build scripts and makefiles to use the new extension as well. Note that this should not result in any user-visible changes to the documentation. Signed-off-by: brian m. carlson Signed-off-by: Junio C Hamano