{"thread":{"id":"63380","subject":"[PATCH 0/4] A handful of doc synopsis/options update","startedAt":"2025-05-01T21:34:17Z","lastAt":"2025-05-10T12:34:53Z","messageCount":26,"participants":["Junio C Hamano","Eric Sunshine","Jean-Noël Avila","Jean-Noël AVILA"],"isPatch":true,"patchVersion":1,"patchTotal":4},"messages":[{"id":"517060","messageId":"20250501213414.370514-1-gitster@pobox.com","threadId":"63380","inReplyTo":null,"subject":"[PATCH 0/4] A handful of doc synopsis/options update","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-01T21:34:10Z","receivedAt":"2025-05-01T21:34:17Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Continuing what Jean-Noël started with 22293895 (doc: apply synopsis\nsimplification on git-clone and git-init, 2024-09-24), use more\n[synopsis] (rather than [verse]) mark-up and also make sure\n\n - dashed options in the text, including the heading for enumerated\n   dashed options in the OPTIONS section, are `backquoted` to be\n   typeset verbatim.\n\n - both positive and negative variants are spelled out when the\n   option is negatable, i.e. a heading \"--[no-]opt::\" is separated\n   into \"--opt::\" and \"--no-opt::\", to help grep hit with simpler\n   patterns.\n\n - non-options are not described in the OPTIONS section.\n\nThe \"git worktree\" one is a bit unsatisfactory and should be\nconsidered WIP.\n\nJunio C Hamano (4):\n  git-verify-* doc: update mark-up of synopsis option descriptions\n  git-{var,write-tree} docs: update mark-up of synopsis option\n    descriptions\n  git-daemon doc: update mark-up of synopsis option descriptions\n  git-worktree doc: update mark-up of synopsis option descriptions\n\n Documentation/git-daemon.adoc        | 107 ++++++++++++++-------------\n Documentation/git-var.adoc           |   6 +-\n Documentation/git-verify-commit.adoc |  16 ++--\n Documentation/git-verify-pack.adoc   |  28 +++----\n Documentation/git-verify-tag.adoc    |  16 ++--\n Documentation/git-worktree.adoc      |  71 +++++++++---------\n Documentation/git-write-tree.adoc    |  16 ++--\n 7 files changed, 129 insertions(+), 131 deletions(-)\n\n-- \n2.49.0-599-g90c2cffacf\n"},{"id":"517061","messageId":"20250501213414.370514-2-gitster@pobox.com","threadId":"63380","inReplyTo":"20250501213414.370514-1-gitster@pobox.com","subject":"[PATCH 1/4] git-verify-* doc: update mark-up of synopsis option descriptions","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-01T21:34:11Z","receivedAt":"2025-05-01T21:34:18Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"To unify mark-up used in our documentation to a newer convention,\nstarted by 22293895 (doc: apply synopsis simplification on git-clone\nand git-init, 2024-09-24), update the documentation pages for 'git\nverify-commit', 'git verify-tag', and 'git verify-pack' to\n\n * use [synopsis], not [verse] in the SYNOPSIS section\n * enclose `--option=<value>` in backquotes\n * do not describe non-option arguments in the OPTIONS section\n\nSigned-off-by: Junio C Hamano <gitster@pobox.com>\n---\n Documentation/git-verify-commit.adoc | 16 +++++++---------\n Documentation/git-verify-pack.adoc   | 28 ++++++++++++----------------\n Documentation/git-verify-tag.adoc    | 16 +++++++---------\n 3 files changed, 26 insertions(+), 34 deletions(-)\n\ndiff --git a/Documentation/git-verify-commit.adoc b/Documentation/git-verify-commit.adoc\nindex aee4c40eac..ff5b8b97ef 100644\n--- a/Documentation/git-verify-commit.adoc\n+++ b/Documentation/git-verify-commit.adoc\n@@ -7,26 +7,24 @@ git-verify-commit - Check the GPG signature of commits\n \n SYNOPSIS\n --------\n-[verse]\n-'git verify-commit' [-v | --verbose] [--raw] <commit>...\n+[synopsis]\n+git verify-commit [-v | --verbose] [--raw] <commit>...\n \n DESCRIPTION\n -----------\n-Validates the GPG signature created by 'git commit -S'.\n+Validates the GPG signature created by `git commit -S`\n+on the commit objects given on the command line.\n \n OPTIONS\n -------\n---raw::\n+`--raw`::\n \tPrint the raw gpg status output to standard error instead of the normal\n \thuman-readable output.\n \n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tPrint the contents of the commit object before validating it.\n \n-<commit>...::\n-\tSHA-1 identifiers of Git commit objects.\n-\n GIT\n ---\n Part of the linkgit:git[1] suite\ndiff --git a/Documentation/git-verify-pack.adoc b/Documentation/git-verify-pack.adoc\nindex d7e886918a..b0462d8db3 100644\n--- a/Documentation/git-verify-pack.adoc\n+++ b/Documentation/git-verify-pack.adoc\n@@ -8,43 +8,39 @@ git-verify-pack - Validate packed Git archive files\n \n SYNOPSIS\n --------\n-[verse]\n-'git verify-pack' [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...\n+[synopsis]\n+git verify-pack [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...\n \n \n DESCRIPTION\n -----------\n-Reads given idx file for packed Git archive created with the\n-'git pack-objects' command and verifies the idx file and the\n-corresponding pack file.\n+Read each idx file for packed Git archive given on the command line,\n+and verify the idx file and the corresponding pack file.\n \n OPTIONS\n -------\n-<pack>.idx ...::\n-\tThe idx files to verify.\n-\n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tAfter verifying the pack, show the list of objects contained\n \tin the pack and a histogram of delta chain length.\n \n--s::\n---stat-only::\n+`-s`::\n+`--stat-only`::\n \tDo not verify the pack contents; only show the histogram of delta\n \tchain length.  With `--verbose`, the list of objects is also shown.\n \n-\\--::\n+`--`::\n \tDo not interpret any more arguments as options.\n \n OUTPUT FORMAT\n -------------\n-When specifying the -v option the format used is:\n+When specifying the `-v` option the format used is:\n \n-\tSHA-1 type size size-in-packfile offset-in-packfile\n+\tobject-name type size size-in-packfile offset-in-packfile\n \n for objects that are not deltified in the pack, and\n \n-\tSHA-1 type size size-in-packfile offset-in-packfile depth base-SHA-1\n+\tobject-name type size size-in-packfile offset-in-packfile depth base-object-name\n \n for objects that are deltified.\n \ndiff --git a/Documentation/git-verify-tag.adoc b/Documentation/git-verify-tag.adoc\nindex 81d50ecc4c..ec995323f6 100644\n--- a/Documentation/git-verify-tag.adoc\n+++ b/Documentation/git-verify-tag.adoc\n@@ -7,26 +7,24 @@ git-verify-tag - Check the GPG signature of tags\n \n SYNOPSIS\n --------\n-[verse]\n-'git verify-tag' [-v | --verbose] [--format=<format>] [--raw] <tag>...\n+[synopsis]\n+git verify-tag [-v | --verbose] [--format=<format>] [--raw] <tag>...\n \n DESCRIPTION\n -----------\n-Validates the gpg signature created by 'git tag'.\n+Validates the gpg signature created by 'git tag' in the tag\n+objects listed on the command line.\n \n OPTIONS\n -------\n---raw::\n+`--raw`::\n \tPrint the raw gpg status output to standard error instead of the normal\n \thuman-readable output.\n \n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tPrint the contents of the tag object before validating it.\n \n-<tag>...::\n-\tSHA-1 identifiers of Git tag objects.\n-\n GIT\n ---\n Part of the linkgit:git[1] suite\n-- \n2.49.0-599-g90c2cffacf\n\n"},{"id":"517062","messageId":"20250501213414.370514-3-gitster@pobox.com","threadId":"63380","inReplyTo":"20250501213414.370514-1-gitster@pobox.com","subject":"[PATCH 2/4] git-{var,write-tree} docs: update mark-up of synopsis option descriptions","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-01T21:34:12Z","receivedAt":"2025-05-01T21:34:20Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"To unify mark-up used in our documentation to a newer convention,\nstarted by 22293895 (doc: apply synopsis simplification on git-clone\nand git-init, 2024-09-24), update the documentation for 'git var' and\n'git write-tree' to\n\n * use [synopsis], not [verse] in the SYNOPSIS section\n * enclose `--option=<value>` in backquotes\n\nSigned-off-by: Junio C Hamano <gitster@pobox.com>\n---\n Documentation/git-var.adoc        |  6 +++---\n Documentation/git-write-tree.adoc | 16 ++++++++--------\n 2 files changed, 11 insertions(+), 11 deletions(-)\n\ndiff --git a/Documentation/git-var.adoc b/Documentation/git-var.adoc\nindex 0680568dfd..909963b1c2 100644\n--- a/Documentation/git-var.adoc\n+++ b/Documentation/git-var.adoc\n@@ -8,8 +8,8 @@ git-var - Show a Git logical variable\n \n SYNOPSIS\n --------\n-[verse]\n-'git var' (-l | <variable>)\n+[synopsis]\n+git var (-l | <variable>)\n \n DESCRIPTION\n -----------\n@@ -18,7 +18,7 @@ no value.\n \n OPTIONS\n -------\n--l::\n+`-l`::\n \tDisplay the logical variables. In addition, all the\n \tvariables of the Git configuration file .git/config are listed\n \tas well. (However, the configuration variables listing functionality\ndiff --git a/Documentation/git-write-tree.adoc b/Documentation/git-write-tree.adoc\nindex f22041a9dc..4e1c3b9c0c 100644\n--- a/Documentation/git-write-tree.adoc\n+++ b/Documentation/git-write-tree.adoc\n@@ -8,8 +8,8 @@ git-write-tree - Create a tree object from the current index\n \n SYNOPSIS\n --------\n-[verse]\n-'git write-tree' [--missing-ok] [--prefix=<prefix>/]\n+[synopsis]\n+git write-tree [--missing-ok] [--prefix=<prefix>/]\n \n DESCRIPTION\n -----------\n@@ -18,21 +18,21 @@ tree object is printed to standard output.\n \n The index must be in a fully merged state.\n \n-Conceptually, 'git write-tree' sync()s the current index contents\n+Conceptually, `git write-tree` sync()s the current index contents\n into a set of tree files.\n In order to have that match what is actually in your directory right\n-now, you need to have done a 'git update-index' phase before you did the\n-'git write-tree'.\n+now, you need to have done a `git update-index` phase before you did the\n+`git write-tree`.\n \n \n OPTIONS\n -------\n---missing-ok::\n-\tNormally 'git write-tree' ensures that the objects referenced by the\n+`--missing-ok`::\n+\tNormally `git write-tree` ensures that the objects referenced by the\n \tdirectory exist in the object database.  This option disables this\n \tcheck.\n \n---prefix=<prefix>/::\n+`--prefix=<prefix>/`::\n \tWrites a tree object that represents a subdirectory\n \t`<prefix>`.  This can be used to write the tree object\n \tfor a subproject that is in the named subdirectory.\n-- \n2.49.0-599-g90c2cffacf\n\n"},{"id":"517063","messageId":"20250501213414.370514-4-gitster@pobox.com","threadId":"63380","inReplyTo":"20250501213414.370514-1-gitster@pobox.com","subject":"[PATCH 3/4] git-daemon doc: update mark-up of synopsis option descriptions","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-01T21:34:13Z","receivedAt":"2025-05-01T21:34:22Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"To unify mark-up used in our documentation to a newer convention,\nstarted by 22293895 (doc: apply synopsis simplification on git-clone\nand git-init, 2024-09-24), update the documentation of 'git daemon'\nto\n\n * use [synopsis], not [verse] in the SYNOPSIS section\n * enclose `--option=<value>` in backquotes\n\nAlso, split '--[no-]option' into '--option' and '--no-option'\nto make it easier to grep for them.\n\nSigned-off-by: Junio C Hamano <gitster@pobox.com>\n---\n Documentation/git-daemon.adoc | 107 +++++++++++++++++-----------------\n 1 file changed, 54 insertions(+), 53 deletions(-)\n\ndiff --git a/Documentation/git-daemon.adoc b/Documentation/git-daemon.adoc\nindex ede7b935d6..3eb9332e55 100644\n--- a/Documentation/git-daemon.adoc\n+++ b/Documentation/git-daemon.adoc\n@@ -7,21 +7,21 @@ git-daemon - A really simple server for Git repositories\n \n SYNOPSIS\n --------\n-[verse]\n-'git daemon' [--verbose] [--syslog] [--export-all]\n-\t     [--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]\n-\t     [--strict-paths] [--base-path=<path>] [--base-path-relaxed]\n-\t     [--user-path | --user-path=<path>]\n-\t     [--interpolated-path=<pathtemplate>]\n-\t     [--reuseaddr] [--detach] [--pid-file=<file>]\n-\t     [--enable=<service>] [--disable=<service>]\n-\t     [--allow-override=<service>] [--forbid-override=<service>]\n-\t     [--access-hook=<path>] [--[no-]informative-errors]\n-\t     [--inetd |\n-\t      [--listen=<host-or-ipaddr>] [--port=<n>]\n-\t      [--user=<user> [--group=<group>]]]\n-\t     [--log-destination=(stderr|syslog|none)]\n-\t     [<directory>...]\n+[synopsis]\n+git daemon [--verbose] [--syslog] [--export-all]\n+\t   [--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]\n+\t   [--strict-paths] [--base-path=<path>] [--base-path-relaxed]\n+\t   [--user-path | --user-path=<path>]\n+\t   [--interpolated-path=<pathtemplate>]\n+\t   [--reuseaddr] [--detach] [--pid-file=<file>]\n+\t   [--enable=<service>] [--disable=<service>]\n+\t   [--allow-override=<service>] [--forbid-override=<service>]\n+\t   [--access-hook=<path>] [--[no-]informative-errors]\n+\t   [--inetd |\n+\t     [--listen=<host-or-ipaddr>] [--port=<n>]\n+\t     [--user=<user> [--group=<group>]]]\n+\t   [--log-destination=(stderr|syslog|none)]\n+\t   [<directory>...]\n \n DESCRIPTION\n -----------\n@@ -46,26 +46,26 @@ An `upload-archive` also exists to serve 'git archive'.\n \n OPTIONS\n -------\n---strict-paths::\n+`--strict-paths`::\n \tMatch paths exactly (i.e. don't allow \"/foo/repo\" when the real path is\n \t\"/foo/repo.git\" or \"/foo/repo/.git\") and don't do user-relative paths.\n \t'git daemon' will refuse to start when this option is enabled and no\n \tdirectory arguments are provided.\n \n---base-path=<path>::\n+`--base-path=<path>`::\n \tRemap all the path requests as relative to the given path.\n \tThis is sort of \"Git root\" - if you run 'git daemon' with\n \t'--base-path=/srv/git' on example.com, then if you later try to pull\n \t'git://example.com/hello.git', 'git daemon' will interpret the path\n \tas `/srv/git/hello.git`.\n \n---base-path-relaxed::\n-\tIf --base-path is enabled and repo lookup fails, with this option\n+`--base-path-relaxed`::\n+\tIf `--base-path` is enabled and repo lookup fails, with this option\n \t'git daemon' will attempt to lookup without prefixing the base path.\n-\tThis is useful for switching to --base-path usage, while still\n+\tThis is useful for switching to `--base-path` usage, while still\n \tallowing the old paths.\n \n---interpolated-path=<pathtemplate>::\n+`--interpolated-path=<pathtemplate>`::\n \tTo support virtual hosting, an interpolated path template can be\n \tused to dynamically construct alternate paths.  The template\n \tsupports %H for the target hostname as supplied by the client but\n@@ -75,48 +75,48 @@ OPTIONS\n \tAfter interpolation, the path is validated against the directory\n \tlist.\n \n---export-all::\n+`--export-all`::\n \tAllow pulling from all directories that look like Git repositories\n \t(have the 'objects' and 'refs' subdirectories), even if they\n \tdo not have the 'git-daemon-export-ok' file.\n \n---inetd::\n-\tHave the server run as an inetd service. Implies --syslog (may be\n-\toverridden with `--log-destination=`).\n-\tIncompatible with --detach, --port, --listen, --user and --group\n-\toptions.\n+`--inetd`::\n+\tHave the server run as an inetd service. Implies `--syslog` (may\n+\tbe overridden with `--log-destination=`).\n+\tIncompatible with `--detach`, `--port`, `--listen`, `--user` and\n+\t`--group` options.\n \n---listen=<host-or-ipaddr>::\n+`--listen=<host-or-ipaddr>`::\n \tListen on a specific IP address or hostname.  IP addresses can\n \tbe either an IPv4 address or an IPv6 address if supported.  If IPv6\n-\tis not supported, then --listen=<hostname> is also not supported and\n-\t--listen must be given an IPv4 address.\n+\tis not supported, then `--listen=<hostname>` is also not supported\n+\tand `--listen` must be given an IPv4 address.\n \tCan be given more than once.\n \tIncompatible with `--inetd` option.\n \n---port=<n>::\n+`--port=<n>`::\n \tListen on an alternative port.  Incompatible with `--inetd` option.\n \n---init-timeout=<n>::\n+`--init-timeout=<n>`::\n \tTimeout (in seconds) between the moment the connection is established\n \tand the client request is received (typically a rather low value, since\n \tthat should be basically immediate).\n \n---timeout=<n>::\n+`--timeout=<n>`::\n \tTimeout (in seconds) for specific client sub-requests. This includes\n \tthe time it takes for the server to process the sub-request and the\n \ttime spent waiting for the next client's request.\n \n---max-connections=<n>::\n+`--max-connections=<n>`::\n \tMaximum number of concurrent clients, defaults to 32.  Set it to\n \tzero for no limit.\n \n---syslog::\n+`--syslog`::\n \tShort for `--log-destination=syslog`.\n \n---log-destination=<destination>::\n+`--log-destination=<destination>`::\n \tSend log messages to the specified destination.\n-\tNote that this option does not imply --verbose,\n+\tNote that this option does not imply `--verbose`,\n \tthus by default only error conditions will be logged.\n \tThe <destination> must be one of:\n +\n@@ -135,8 +135,8 @@ none::\n The default destination is `syslog` if `--inetd` or `--detach` is specified,\n otherwise `stderr`.\n \n---user-path::\n---user-path=<path>::\n+`--user-path`::\n+`--user-path=<path>`::\n \tAllow {tilde}user notation to be used in requests.  When\n \tspecified with no parameter, a request to\n \tgit://host/{tilde}alice/foo is taken as a request to access\n@@ -145,23 +145,23 @@ otherwise `stderr`.\n \ttaken as a request to access `<path>/foo` repository in\n \tthe home directory of user `alice`.\n \n---verbose::\n+`--verbose`::\n \tLog details about the incoming connections and requested files.\n \n---reuseaddr::\n+`--reuseaddr`::\n \tUse SO_REUSEADDR when binding the listening socket.\n \tThis allows the server to restart without waiting for\n \told connections to time out.\n \n---detach::\n-\tDetach from the shell. Implies --syslog.\n+`--detach`::\n+\tDetach from the shell. Implies `--syslog`.\n \n---pid-file=<file>::\n+`--pid-file=<file>`::\n \tSave the process id in 'file'.  Ignored when the daemon\n \tis run under `--inetd`.\n \n---user=<user>::\n---group=<group>::\n+`--user=<user>`::\n+`--group=<group>`::\n \tChange daemon's uid and gid before entering the service loop.\n \tWhen only `--user` is given without `--group`, the\n \tprimary group ID for the user is used.  The values of\n@@ -179,30 +179,31 @@ may also want to set and export `HOME` to point at the home\n directory of `<user>` before starting the daemon, and make sure any\n Git configuration files in that directory are readable by `<user>`.\n \n---enable=<service>::\n---disable=<service>::\n+`--enable=<service>`::\n+`--disable=<service>`::\n \tEnable/disable the service site-wide per default.  Note\n \tthat a service disabled site-wide can still be enabled\n \tper repository if it is marked overridable and the\n \trepository enables the service with a configuration\n \titem.\n \n---allow-override=<service>::\n---forbid-override=<service>::\n+`--allow-override=<service>`::\n+`--forbid-override=<service>`::\n \tAllow/forbid overriding the site-wide default with per\n \trepository configuration.  By default, all the services\n \tmay be overridden.\n \n---[no-]informative-errors::\n+`--informative-errors`::\n+`--no-informative-errors`::\n \tWhen informative errors are turned on, git-daemon will report\n \tmore verbose errors to the client, differentiating conditions\n \tlike \"no such repository\" from \"repository not exported\". This\n \tis more convenient for clients, but may leak information about\n \tthe existence of unexported repositories.  When informative\n \terrors are not enabled, all errors report \"access denied\" to the\n-\tclient. The default is --no-informative-errors.\n+\tclient. The default is `--no-informative-errors`.\n \n---access-hook=<path>::\n+`--access-hook=<path>`::\n \tEvery time a client connects, first run an external command\n \tspecified by the <path> with service name (e.g. \"upload-pack\"),\n \tpath to the repository, hostname (%H), canonical hostname\n-- \n2.49.0-599-g90c2cffacf\n\n"},{"id":"517064","messageId":"20250501213414.370514-5-gitster@pobox.com","threadId":"63380","inReplyTo":"20250501213414.370514-1-gitster@pobox.com","subject":"[WIP PATCH 4/4] git-worktree doc: update mark-up of synopsis option descriptions","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-01T21:34:14Z","receivedAt":"2025-05-01T21:34:23Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"To unify mark-up used in our documentation to a newer convention,\nstarted by 22293895 (doc: apply synopsis simplification on git-clone\nand git-init, 2024-09-24), update the documentation of 'git worktree'\nto\n\n * use [synopsis], not [verse] in the SYNOPSIS section\n * enclose `--option=<value>` in backquotes\n\nAlso, split '--[no-]option' into '--option' and '--no-option'\nto make it easier to grep for them.\n\nSigned-off-by: Junio C Hamano <gitster@pobox.com>\n---\n Documentation/git-worktree.adoc | 71 ++++++++++++++++++---------------\n 1 file changed, 38 insertions(+), 33 deletions(-)\n\ndiff --git a/Documentation/git-worktree.adoc b/Documentation/git-worktree.adoc\nindex 8340b7f028..46715cbef7 100644\n--- a/Documentation/git-worktree.adoc\n+++ b/Documentation/git-worktree.adoc\n@@ -8,16 +8,16 @@ git-worktree - Manage multiple working trees\n \n SYNOPSIS\n --------\n-[verse]\n-'git worktree add' [-f] [--detach] [--checkout] [--lock [--reason <string>]]\n-\t\t   [--orphan] [(-b | -B) <new-branch>] <path> [<commit-ish>]\n-'git worktree list' [-v | --porcelain [-z]]\n-'git worktree lock' [--reason <string>] <worktree>\n-'git worktree move' <worktree> <new-path>\n-'git worktree prune' [-n] [-v] [--expire <expire>]\n-'git worktree remove' [-f] <worktree>\n-'git worktree repair' [<path>...]\n-'git worktree unlock' <worktree>\n+[synopsis]\n+git worktree add [-f] [--detach] [--checkout] [--lock [--reason <string>]]\n+\t\t [--orphan] [(-b | -B) <new-branch>] <path> [<commit-ish>]\n+git worktree list [-v | --porcelain [-z]]\n+git worktree lock [--reason <string>] <worktree>\n+git worktree move <worktree> <new-path>\n+git worktree prune [-n] [-v] [--expire <expire>]\n+git worktree remove [-f] <worktree>\n+git worktree repair [<path>...]\n+git worktree unlock <worktree>\n \n DESCRIPTION\n -----------\n@@ -169,8 +169,8 @@ Unlock a worktree, allowing it to be pruned, moved or deleted.\n OPTIONS\n -------\n \n--f::\n---force::\n+`-f`::\n+`--force`::\n \tBy default, `add` refuses to create a new worktree when\n \t`<commit-ish>` is a branch name and is already checked out by\n \tanother worktree, or if `<path>` is already assigned to some\n@@ -186,8 +186,8 @@ allows the move to proceed; use `--force` twice if the destination is locked.\n `remove` refuses to remove an unclean worktree unless `--force` is used.\n To remove a locked worktree, specify `--force` twice.\n \n--b <new-branch>::\n--B <new-branch>::\n+`-b <new-branch>`::\n+`-B <new-branch>`::\n \tWith `add`, create a new branch named `<new-branch>` starting at\n \t`<commit-ish>`, and check out `<new-branch>` into the new worktree.\n \tIf `<commit-ish>` is omitted, it defaults to `HEAD`.\n@@ -195,18 +195,20 @@ To remove a locked worktree, specify `--force` twice.\n \texists. `-B` overrides this safeguard, resetting `<new-branch>` to\n \t`<commit-ish>`.\n \n--d::\n---detach::\n+`-d`::\n+`--detach`::\n \tWith `add`, detach `HEAD` in the new worktree. See \"DETACHED HEAD\"\n \tin linkgit:git-checkout[1].\n \n---[no-]checkout::\n+`--checkout`::\n+`--no-checkout`::\n \tBy default, `add` checks out `<commit-ish>`, however, `--no-checkout` can\n \tbe used to suppress checkout in order to make customizations,\n \tsuch as configuring sparse-checkout. See \"Sparse checkout\"\n \tin linkgit:git-read-tree[1].\n \n---[no-]guess-remote::\n+`--guess-remote`::\n+`--no-guess-remote`::\n \tWith `worktree add <path>`, without `<commit-ish>`, instead\n \tof creating a new branch from `HEAD`, if there exists a tracking\n \tbranch in exactly one remote matching the basename of `<path>`,\n@@ -216,7 +218,8 @@ To remove a locked worktree, specify `--force` twice.\n This can also be set up as the default behaviour by using the\n `worktree.guessRemote` config option.\n \n---[no-]relative-paths::\n+`--relative-paths`\n+`--no-relative-paths`::\n \tLink worktrees using relative paths or absolute paths (default).\n \tOverrides the `worktree.useRelativePaths` config option, see\n \tlinkgit:git-config[1].\n@@ -224,55 +227,57 @@ This can also be set up as the default behaviour by using the\n With `repair`, the linking files will be updated if there's an absolute/relative\n mismatch, even if the links are correct.\n \n---[no-]track::\n-\tWhen creating a new branch, if `<commit-ish>` is a branch,\n+`--track`::\n+`--no-track`::\n+\tWith `--track`, when creating a new branch,\n+\tif `<commit-ish>` is a branch,\n \tmark it as \"upstream\" from the new branch.  This is the\n \tdefault if `<commit-ish>` is a remote-tracking branch.  See\n \t`--track` in linkgit:git-branch[1] for details.\n \n---lock::\n+`--lock`::\n \tKeep the worktree locked after creation. This is the\n \tequivalent of `git worktree lock` after `git worktree add`,\n \tbut without a race condition.\n \n--n::\n---dry-run::\n+`-n`::\n+`--dry-run`::\n \tWith `prune`, do not remove anything; just report what it would\n \tremove.\n \n---orphan::\n+`--orphan`::\n \tWith `add`, make the new worktree and index empty, associating\n \tthe worktree with a new unborn branch named `<new-branch>`.\n \n---porcelain::\n+`--porcelain`::\n \tWith `list`, output in an easy-to-parse format for scripts.\n \tThis format will remain stable across Git versions and regardless of user\n \tconfiguration.  It is recommended to combine this with `-z`.\n \tSee below for details.\n \n--z::\n+`-z`::\n \tTerminate each line with a NUL rather than a newline when\n \t`--porcelain` is specified with `list`. This makes it possible\n \tto parse the output when a worktree path contains a newline\n \tcharacter.\n \n--q::\n---quiet::\n+`-q`::\n+`--quiet`::\n \tWith `add`, suppress feedback messages.\n \n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tWith `prune`, report all removals.\n +\n With `list`, output additional information about worktrees (see below).\n \n---expire <time>::\n+`--expire <time>`::\n \tWith `prune`, only expire unused worktrees older than `<time>`.\n +\n With `list`, annotate missing worktrees as prunable if they are older than\n `<time>`.\n \n---reason <string>::\n+`--reason <string>`::\n \tWith `lock` or with `add --lock`, an explanation why the worktree\n \tis locked.\n \n-- \n2.49.0-599-g90c2cffacf\n\n"},{"id":"517074","messageId":"CAPig+cR-mbtwvUZBdhVCKsimVCETKdWHNG14hXDO77qMWMwVkg@mail.gmail.com","threadId":"63380","inReplyTo":"20250501213414.370514-2-gitster@pobox.com","subject":"Re: [PATCH 1/4] git-verify-* doc: update mark-up of synopsis option descriptions","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2025-05-01T22:43:46Z","receivedAt":"2025-05-01T22:43:58Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Thu, May 1, 2025 at 5:34 PM Junio C Hamano <gitster@pobox.com> wrote:\n> To unify mark-up used in our documentation to a newer convention,\n> started by 22293895 (doc: apply synopsis simplification on git-clone\n> and git-init, 2024-09-24), update the documentation pages for 'git\n> verify-commit', 'git verify-tag', and 'git verify-pack' to\n>\n>  * use [synopsis], not [verse] in the SYNOPSIS section\n>  * enclose `--option=<value>` in backquotes\n>  * do not describe non-option arguments in the OPTIONS section\n>\n> Signed-off-by: Junio C Hamano <gitster@pobox.com>\n> ---\n> diff --git a/Documentation/git-verify-commit.adoc b/Documentation/git-verify-commit.adoc\n> @@ -7,26 +7,24 @@ git-verify-commit - Check the GPG signature of commits\n> -Validates the GPG signature created by 'git commit -S'.\n> +Validates the GPG signature created by `git commit -S`\n> +on the commit objects given on the command line.\n\nTaking note of the casing of GPG (all uppercase)...\n\n> diff --git a/Documentation/git-verify-pack.adoc b/Documentation/git-verify-pack.adoc\n> @@ -8,43 +8,39 @@ git-verify-pack - Validate packed Git archive files\n> -Reads given idx file for packed Git archive created with the\n> -'git pack-objects' command and verifies the idx file and the\n> -corresponding pack file.\n> +Read each idx file for packed Git archive given on the command line,\n> +and verify the idx file and the corresponding pack file.\n\nOkay, rewrite seems reasonable. Do we want to backtick \"idx\" and \"pack\"?\n\n>  OUTPUT FORMAT\n>  -------------\n> -When specifying the -v option the format used is:\n> +When specifying the `-v` option the format used is:\n>\n> -       SHA-1 type size size-in-packfile offset-in-packfile\n> +       object-name type size size-in-packfile offset-in-packfile\n\nDo we not typically call this object-ID (OID) rather than object-name?\n\n> diff --git a/Documentation/git-verify-tag.adoc b/Documentation/git-verify-tag.adoc\n> @@ -7,26 +7,24 @@ git-verify-tag - Check the GPG signature of tags\n\n...all uppercase GPG...\n\n> -Validates the gpg signature created by 'git tag'.\n> +Validates the gpg signature created by 'git tag' in the tag\n> +objects listed on the command line.\n\n...since this is being rewritten anyhow, it probably would make sense\nto employ consistent casing of GPG.\n"},{"id":"517075","messageId":"CAPig+cQ1CC2SXN6bViusJXy93jZ6k8UvxRXa6mE0At6FgvS2-Q@mail.gmail.com","threadId":"63380","inReplyTo":"20250501213414.370514-4-gitster@pobox.com","subject":"Re: [PATCH 3/4] git-daemon doc: update mark-up of synopsis option descriptions","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2025-05-01T22:52:09Z","receivedAt":"2025-05-01T22:52:21Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Thu, May 1, 2025 at 5:34 PM Junio C Hamano <gitster@pobox.com> wrote:\n> To unify mark-up used in our documentation to a newer convention,\n> started by 22293895 (doc: apply synopsis simplification on git-clone\n> and git-init, 2024-09-24), update the documentation of 'git daemon'\n> to\n>\n>  * use [synopsis], not [verse] in the SYNOPSIS section\n>  * enclose `--option=<value>` in backquotes\n>\n> Also, split '--[no-]option' into '--option' and '--no-option'\n> to make it easier to grep for them.\n>\n> Signed-off-by: Junio C Hamano <gitster@pobox.com>\n> ---\n> diff --git a/Documentation/git-daemon.adoc b/Documentation/git-daemon.adoc\n> @@ -46,26 +46,26 @@ An `upload-archive` also exists to serve 'git archive'.\n> ---strict-paths::\n> +`--strict-paths`::\n>         Match paths exactly (i.e. don't allow \"/foo/repo\" when the real path is\n>         \"/foo/repo.git\" or \"/foo/repo/.git\") and don't do user-relative paths.\n>         'git daemon' will refuse to start when this option is enabled and no\n>         directory arguments are provided.\n\nShould 'git daemon' be wrapped in backticks instead?\n\n> ---base-path=<path>::\n> +`--base-path=<path>`::\n>         Remap all the path requests as relative to the given path.\n>         This is sort of \"Git root\" - if you run 'git daemon' with\n>         '--base-path=/srv/git' on example.com, then if you later try to pull\n\nShould the '--base-path=/srv/git' example be wrapped in backticks instead?\n\n>         'git://example.com/hello.git', 'git daemon' will interpret the path\n>         as `/srv/git/hello.git`.\n\nThese are inconsistent, as well: the first two use apostrophes, and\nthe latter backticks.\n\n> @@ -135,8 +135,8 @@ none::\n> +`--user-path`::\n> +`--user-path=<path>`::\n>         Allow {tilde}user notation to be used in requests.  When\n>         specified with no parameter, a request to\n>         git://host/{tilde}alice/foo is taken as a request to access\n\nAnd this URL has no quoting.\n"},{"id":"517079","messageId":"xmqqecx8vsf8.fsf@gitster.g","threadId":"63380","inReplyTo":"CAPig+cR-mbtwvUZBdhVCKsimVCETKdWHNG14hXDO77qMWMwVkg@mail.gmail.com","subject":"Re: [PATCH 1/4] git-verify-* doc: update mark-up of synopsis option descriptions","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-01T23:10:19Z","receivedAt":"2025-05-01T23:10:21Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Eric Sunshine <sunshine@sunshineco.com> writes:\n\n>> -'git pack-objects' command and verifies the idx file and the\n>> -corresponding pack file.\n>> +Read each idx file for packed Git archive given on the command line,\n>> +and verify the idx file and the corresponding pack file.\n>\n> Okay, rewrite seems reasonable. Do we want to backtick \"idx\" and \"pack\"?\n\nNo.  I would understand if it is spelled '.idx', to refer to a\nconcrete file suffix that people would type verbatim.  In this\nsentence, however, I think \"idx file\" and \"pack file\" are used as a\ngeneral noun.\n\n>>  OUTPUT FORMAT\n>>  -------------\n>> -When specifying the -v option the format used is:\n>> +When specifying the `-v` option the format used is:\n>>\n>> -       SHA-1 type size size-in-packfile offset-in-packfile\n>> +       object-name type size size-in-packfile offset-in-packfile\n>\n> Do we not typically call this object-ID (OID) rather than object-name?\n\nGiven these entries in Documentation/glossary-content.adoc\n\n        [[def_hash]]hash::\n                In Git's context, synonym for <<def_object_name,object name>>.\n        [[def_object_identifier]]object identifier (oid)::\n                Synonym for <<def_object_name,object name>>.\n\nI do not think so, and if we find somebody doing so, we should\ncorrect them.\n\n>> diff --git a/Documentation/git-verify-tag.adoc b/Documentation/git-verify-tag.adoc\n>> @@ -7,26 +7,24 @@ git-verify-tag - Check the GPG signature of tags\n>\n> ...all uppercase GPG...\n>\n>> -Validates the gpg signature created by 'git tag'.\n>> +Validates the gpg signature created by 'git tag' in the tag\n>> +objects listed on the command line.\n>\n> ...since this is being rewritten anyhow, it probably would make sense\n> to employ consistent casing of GPG.\n\nOnce the dust settles from this series, yes, but not in this series\nthat is about mark-up.\n\nThanks.\n"},{"id":"517080","messageId":"xmqqa57wvsbb.fsf@gitster.g","threadId":"63380","inReplyTo":"CAPig+cQ1CC2SXN6bViusJXy93jZ6k8UvxRXa6mE0At6FgvS2-Q@mail.gmail.com","subject":"Re: [PATCH 3/4] git-daemon doc: update mark-up of synopsis option descriptions","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-01T23:12:40Z","receivedAt":"2025-05-01T23:12:43Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Eric Sunshine <sunshine@sunshineco.com> writes:\n\n>> diff --git a/Documentation/git-daemon.adoc b/Documentation/git-daemon.adoc\n>> @@ -46,26 +46,26 @@ An `upload-archive` also exists to serve 'git archive'.\n>> ---strict-paths::\n>> +`--strict-paths`::\n>>         Match paths exactly (i.e. don't allow \"/foo/repo\" when the real path is\n>>         \"/foo/repo.git\" or \"/foo/repo/.git\") and don't do user-relative paths.\n>>         'git daemon' will refuse to start when this option is enabled and no\n>>         directory arguments are provided.\n>\n> Should 'git daemon' be wrapped in backticks instead?\n\nYup, good eyes.\n\n>> ---base-path=<path>::\n>> +`--base-path=<path>`::\n>>         Remap all the path requests as relative to the given path.\n>>         This is sort of \"Git root\" - if you run 'git daemon' with\n>>         '--base-path=/srv/git' on example.com, then if you later try to pull\n>\n> Should the '--base-path=/srv/git' example be wrapped in backticks instead?\n\nProbably, so should `git daemon` one line before it.\n\n>>         'git://example.com/hello.git', 'git daemon' will interpret the path\n>>         as `/srv/git/hello.git`.\n>\n> These are inconsistent, as well: the first two use apostrophes, and\n> the latter backticks.\n\nI am not sure what the best mark-up for the sample strings.  They\nare not what the end-users are expected to type verbatim, so I've\npunted and left them out as in the original ;-)\n\n>> @@ -135,8 +135,8 @@ none::\n>> +`--user-path`::\n>> +`--user-path=<path>`::\n>>         Allow {tilde}user notation to be used in requests.  When\n>>         specified with no parameter, a request to\n>>         git://host/{tilde}alice/foo is taken as a request to access\n>\n> And this URL has no quoting.\n\nLikewise.\n\n"},{"id":"517081","messageId":"xmqq34dnx6f3.fsf@gitster.g","threadId":"63380","inReplyTo":"xmqqa57wvsbb.fsf@gitster.g","subject":"Re: [PATCH 3/4] git-daemon doc: update mark-up of synopsis option descriptions","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-01T23:22:40Z","receivedAt":"2025-05-01T23:22:43Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Here are incremental changes relative to the previous round, taking\ninspiration from your suggestions.\n\nI think the sample option, sitename, and pathname must be typed\nverbatim by the readers if the behaviour described in the text\nis to be reproduced, so changed them in the base-path description\nall to be marked up as `literal string`.\n\n\ndiff --git c/Documentation/git-daemon.adoc w/Documentation/git-daemon.adoc\nindex 3eb9332e55..bc3f77405e 100644\n--- c/Documentation/git-daemon.adoc\n+++ w/Documentation/git-daemon.adoc\n@@ -32,7 +32,7 @@ that service if it is enabled.\n It verifies that the directory has the magic file \"git-daemon-export-ok\", and\n it will refuse to export any Git directory that hasn't explicitly been marked\n for export this way (unless the `--export-all` parameter is specified). If you\n-pass some directory paths as 'git daemon' arguments, the offers are limited to\n+pass some directory paths as `git daemon` arguments, the offers are limited to\n repositories within those directories.\n \n By default, only `upload-pack` service is enabled, which serves\n@@ -49,15 +49,15 @@ OPTIONS\n `--strict-paths`::\n \tMatch paths exactly (i.e. don't allow \"/foo/repo\" when the real path is\n \t\"/foo/repo.git\" or \"/foo/repo/.git\") and don't do user-relative paths.\n-\t'git daemon' will refuse to start when this option is enabled and no\n+\t`git daemon` will refuse to start when this option is enabled and no\n \tdirectory arguments are provided.\n \n `--base-path=<path>`::\n \tRemap all the path requests as relative to the given path.\n-\tThis is sort of \"Git root\" - if you run 'git daemon' with\n-\t'--base-path=/srv/git' on example.com, then if you later try to pull\n-\t'git://example.com/hello.git', 'git daemon' will interpret the path\n-\tas `/srv/git/hello.git`.\n+\tThis is sort of \"Git root\" - if you run `git daemon` with\n+\t`--base-path=/srv/git` on `example.com`, then if you later try\n+\tto pull from `git://example.com/hello.git`, `git daemon` will\n+\tinterpret the path as `/srv/git/hello.git`.\n \n `--base-path-relaxed`::\n \tIf `--base-path` is enabled and repo lookup fails, with this option\n\n\n"},{"id":"517157","messageId":"20250503011537.3035416-1-gitster@pobox.com","threadId":"63380","inReplyTo":"20250501213414.370514-1-gitster@pobox.com","subject":"[PATCH v2 0/3] A handful of doc synopsis/options update","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-03T01:15:34Z","receivedAt":"2025-05-03T01:15:39Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Continuing what Jean-Noël started with 22293895 (doc: apply synopsis\nsimplification on git-clone and git-init, 2024-09-24), use more\n[synopsis] (rather than [verse]) mark-up and also make sure\n\n - dashed options in the text, including the heading for enumerated\n   dashed options in the OPTIONS section, are `backquoted` to be\n   typeset verbatim.\n\n - both positive and negative variants are spelled out when the\n   option is negatable, i.e. a heading \"--[no-]opt::\" is separated\n   into \"--opt::\" and \"--no-opt::\", to help grep hit with simpler\n   patterns.\n\n - non-options are not described in the OPTIONS section.\n\nThe changes in the first two patches are unchanged.\n\nThe update to \"git daemon\" documentation has acquired a bit more\n`literal` mark-ups, prompted by a comment by Eric Sunshine on the\nprevious iteration.\n\nThe initial iteration contained a WIP on worktree documentation,\nwhich has been dropped in this iteration.\n\n\n1:  65a5556d4b = 1:  5e8ae75a6b git-verify-* doc: update mark-up of synopsis option descriptions\n2:  a9c5bd63ee = 2:  c6cc44c72b git-{var,write-tree} docs: update mark-up of synopsis option descriptions\n3:  eb0e783e21 ! 3:  d424d8c846 git-daemon doc: update mark-up of synopsis option descriptions\n    @@ Documentation/git-daemon.adoc: git-daemon - A really simple server for Git repos\n      \n      DESCRIPTION\n      -----------\n    +@@ Documentation/git-daemon.adoc: that service if it is enabled.\n    + It verifies that the directory has the magic file \"git-daemon-export-ok\", and\n    + it will refuse to export any Git directory that hasn't explicitly been marked\n    + for export this way (unless the `--export-all` parameter is specified). If you\n    +-pass some directory paths as 'git daemon' arguments, the offers are limited to\n    ++pass some directory paths as `git daemon` arguments, the offers are limited to\n    + repositories within those directories.\n    + \n    + By default, only `upload-pack` service is enabled, which serves\n     @@ Documentation/git-daemon.adoc: An `upload-archive` also exists to serve 'git archive'.\n      \n      OPTIONS\n    @@ Documentation/git-daemon.adoc: An `upload-archive` also exists to serve 'git arc\n     +`--strict-paths`::\n      \tMatch paths exactly (i.e. don't allow \"/foo/repo\" when the real path is\n      \t\"/foo/repo.git\" or \"/foo/repo/.git\") and don't do user-relative paths.\n    - \t'git daemon' will refuse to start when this option is enabled and no\n    +-\t'git daemon' will refuse to start when this option is enabled and no\n    ++\t`git daemon` will refuse to start when this option is enabled and no\n      \tdirectory arguments are provided.\n      \n     ---base-path=<path>::\n     +`--base-path=<path>`::\n      \tRemap all the path requests as relative to the given path.\n    - \tThis is sort of \"Git root\" - if you run 'git daemon' with\n    - \t'--base-path=/srv/git' on example.com, then if you later try to pull\n    - \t'git://example.com/hello.git', 'git daemon' will interpret the path\n    - \tas `/srv/git/hello.git`.\n    +-\tThis is sort of \"Git root\" - if you run 'git daemon' with\n    +-\t'--base-path=/srv/git' on example.com, then if you later try to pull\n    +-\t'git://example.com/hello.git', 'git daemon' will interpret the path\n    +-\tas `/srv/git/hello.git`.\n    ++\tThis is sort of \"Git root\" - if you run `git daemon` with\n    ++\t`--base-path=/srv/git` on `example.com`, then if you later try\n    ++\tto pull from `git://example.com/hello.git`, `git daemon` will\n    ++\tinterpret the path as `/srv/git/hello.git`.\n      \n     ---base-path-relaxed::\n     -\tIf --base-path is enabled and repo lookup fails, with this option\n\n\n\nJunio C Hamano (3):\n  git-verify-* doc: update mark-up of synopsis option descriptions\n  git-{var,write-tree} docs: update mark-up of synopsis option\n    descriptions\n  git-daemon doc: update mark-up of synopsis option descriptions\n\n Documentation/git-daemon.adoc        | 119 ++++++++++++++-------------\n Documentation/git-var.adoc           |   6 +-\n Documentation/git-verify-commit.adoc |  16 ++--\n Documentation/git-verify-pack.adoc   |  28 +++----\n Documentation/git-verify-tag.adoc    |  16 ++--\n Documentation/git-write-tree.adoc    |  16 ++--\n 6 files changed, 97 insertions(+), 104 deletions(-)\n\n-- \n2.49.0-601-ga5925c3955\n\n"},{"id":"517158","messageId":"20250503011537.3035416-2-gitster@pobox.com","threadId":"63380","inReplyTo":"20250503011537.3035416-1-gitster@pobox.com","subject":"[PATCH v2 1/3] git-verify-* doc: update mark-up of synopsis option descriptions","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-03T01:15:35Z","receivedAt":"2025-05-03T01:15:41Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"To unify mark-up used in our documentation to a newer convention,\nstarted by 22293895 (doc: apply synopsis simplification on git-clone\nand git-init, 2024-09-24), update the documentation pages for 'git\nverify-commit', 'git verify-tag', and 'git verify-pack' to\n\n * use [synopsis], not [verse] in the SYNOPSIS section\n * enclose `--option=<value>` in backquotes\n * do not describe non-option arguments in the OPTIONS section\n\nSigned-off-by: Junio C Hamano <gitster@pobox.com>\n---\n Documentation/git-verify-commit.adoc | 16 +++++++---------\n Documentation/git-verify-pack.adoc   | 28 ++++++++++++----------------\n Documentation/git-verify-tag.adoc    | 16 +++++++---------\n 3 files changed, 26 insertions(+), 34 deletions(-)\n\ndiff --git a/Documentation/git-verify-commit.adoc b/Documentation/git-verify-commit.adoc\nindex aee4c40eac..ff5b8b97ef 100644\n--- a/Documentation/git-verify-commit.adoc\n+++ b/Documentation/git-verify-commit.adoc\n@@ -7,26 +7,24 @@ git-verify-commit - Check the GPG signature of commits\n \n SYNOPSIS\n --------\n-[verse]\n-'git verify-commit' [-v | --verbose] [--raw] <commit>...\n+[synopsis]\n+git verify-commit [-v | --verbose] [--raw] <commit>...\n \n DESCRIPTION\n -----------\n-Validates the GPG signature created by 'git commit -S'.\n+Validates the GPG signature created by `git commit -S`\n+on the commit objects given on the command line.\n \n OPTIONS\n -------\n---raw::\n+`--raw`::\n \tPrint the raw gpg status output to standard error instead of the normal\n \thuman-readable output.\n \n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tPrint the contents of the commit object before validating it.\n \n-<commit>...::\n-\tSHA-1 identifiers of Git commit objects.\n-\n GIT\n ---\n Part of the linkgit:git[1] suite\ndiff --git a/Documentation/git-verify-pack.adoc b/Documentation/git-verify-pack.adoc\nindex d7e886918a..b0462d8db3 100644\n--- a/Documentation/git-verify-pack.adoc\n+++ b/Documentation/git-verify-pack.adoc\n@@ -8,43 +8,39 @@ git-verify-pack - Validate packed Git archive files\n \n SYNOPSIS\n --------\n-[verse]\n-'git verify-pack' [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...\n+[synopsis]\n+git verify-pack [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...\n \n \n DESCRIPTION\n -----------\n-Reads given idx file for packed Git archive created with the\n-'git pack-objects' command and verifies the idx file and the\n-corresponding pack file.\n+Read each idx file for packed Git archive given on the command line,\n+and verify the idx file and the corresponding pack file.\n \n OPTIONS\n -------\n-<pack>.idx ...::\n-\tThe idx files to verify.\n-\n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tAfter verifying the pack, show the list of objects contained\n \tin the pack and a histogram of delta chain length.\n \n--s::\n---stat-only::\n+`-s`::\n+`--stat-only`::\n \tDo not verify the pack contents; only show the histogram of delta\n \tchain length.  With `--verbose`, the list of objects is also shown.\n \n-\\--::\n+`--`::\n \tDo not interpret any more arguments as options.\n \n OUTPUT FORMAT\n -------------\n-When specifying the -v option the format used is:\n+When specifying the `-v` option the format used is:\n \n-\tSHA-1 type size size-in-packfile offset-in-packfile\n+\tobject-name type size size-in-packfile offset-in-packfile\n \n for objects that are not deltified in the pack, and\n \n-\tSHA-1 type size size-in-packfile offset-in-packfile depth base-SHA-1\n+\tobject-name type size size-in-packfile offset-in-packfile depth base-object-name\n \n for objects that are deltified.\n \ndiff --git a/Documentation/git-verify-tag.adoc b/Documentation/git-verify-tag.adoc\nindex 81d50ecc4c..ec995323f6 100644\n--- a/Documentation/git-verify-tag.adoc\n+++ b/Documentation/git-verify-tag.adoc\n@@ -7,26 +7,24 @@ git-verify-tag - Check the GPG signature of tags\n \n SYNOPSIS\n --------\n-[verse]\n-'git verify-tag' [-v | --verbose] [--format=<format>] [--raw] <tag>...\n+[synopsis]\n+git verify-tag [-v | --verbose] [--format=<format>] [--raw] <tag>...\n \n DESCRIPTION\n -----------\n-Validates the gpg signature created by 'git tag'.\n+Validates the gpg signature created by 'git tag' in the tag\n+objects listed on the command line.\n \n OPTIONS\n -------\n---raw::\n+`--raw`::\n \tPrint the raw gpg status output to standard error instead of the normal\n \thuman-readable output.\n \n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tPrint the contents of the tag object before validating it.\n \n-<tag>...::\n-\tSHA-1 identifiers of Git tag objects.\n-\n GIT\n ---\n Part of the linkgit:git[1] suite\n-- \n2.49.0-601-ga5925c3955\n\n"},{"id":"517159","messageId":"20250503011537.3035416-3-gitster@pobox.com","threadId":"63380","inReplyTo":"20250503011537.3035416-1-gitster@pobox.com","subject":"[PATCH v2 2/3] git-{var,write-tree} docs: update mark-up of synopsis option descriptions","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-03T01:15:36Z","receivedAt":"2025-05-03T01:15:43Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"To unify mark-up used in our documentation to a newer convention,\nstarted by 22293895 (doc: apply synopsis simplification on git-clone\nand git-init, 2024-09-24), update the documentation for 'git var' and\n'git write-tree' to\n\n * use [synopsis], not [verse] in the SYNOPSIS section\n * enclose `--option=<value>` in backquotes\n\nSigned-off-by: Junio C Hamano <gitster@pobox.com>\n---\n Documentation/git-var.adoc        |  6 +++---\n Documentation/git-write-tree.adoc | 16 ++++++++--------\n 2 files changed, 11 insertions(+), 11 deletions(-)\n\ndiff --git a/Documentation/git-var.adoc b/Documentation/git-var.adoc\nindex 0680568dfd..909963b1c2 100644\n--- a/Documentation/git-var.adoc\n+++ b/Documentation/git-var.adoc\n@@ -8,8 +8,8 @@ git-var - Show a Git logical variable\n \n SYNOPSIS\n --------\n-[verse]\n-'git var' (-l | <variable>)\n+[synopsis]\n+git var (-l | <variable>)\n \n DESCRIPTION\n -----------\n@@ -18,7 +18,7 @@ no value.\n \n OPTIONS\n -------\n--l::\n+`-l`::\n \tDisplay the logical variables. In addition, all the\n \tvariables of the Git configuration file .git/config are listed\n \tas well. (However, the configuration variables listing functionality\ndiff --git a/Documentation/git-write-tree.adoc b/Documentation/git-write-tree.adoc\nindex f22041a9dc..4e1c3b9c0c 100644\n--- a/Documentation/git-write-tree.adoc\n+++ b/Documentation/git-write-tree.adoc\n@@ -8,8 +8,8 @@ git-write-tree - Create a tree object from the current index\n \n SYNOPSIS\n --------\n-[verse]\n-'git write-tree' [--missing-ok] [--prefix=<prefix>/]\n+[synopsis]\n+git write-tree [--missing-ok] [--prefix=<prefix>/]\n \n DESCRIPTION\n -----------\n@@ -18,21 +18,21 @@ tree object is printed to standard output.\n \n The index must be in a fully merged state.\n \n-Conceptually, 'git write-tree' sync()s the current index contents\n+Conceptually, `git write-tree` sync()s the current index contents\n into a set of tree files.\n In order to have that match what is actually in your directory right\n-now, you need to have done a 'git update-index' phase before you did the\n-'git write-tree'.\n+now, you need to have done a `git update-index` phase before you did the\n+`git write-tree`.\n \n \n OPTIONS\n -------\n---missing-ok::\n-\tNormally 'git write-tree' ensures that the objects referenced by the\n+`--missing-ok`::\n+\tNormally `git write-tree` ensures that the objects referenced by the\n \tdirectory exist in the object database.  This option disables this\n \tcheck.\n \n---prefix=<prefix>/::\n+`--prefix=<prefix>/`::\n \tWrites a tree object that represents a subdirectory\n \t`<prefix>`.  This can be used to write the tree object\n \tfor a subproject that is in the named subdirectory.\n-- \n2.49.0-601-ga5925c3955\n\n"},{"id":"517160","messageId":"20250503011537.3035416-4-gitster@pobox.com","threadId":"63380","inReplyTo":"20250503011537.3035416-1-gitster@pobox.com","subject":"[PATCH v2 3/3] git-daemon doc: update mark-up of synopsis option descriptions","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-03T01:15:37Z","receivedAt":"2025-05-03T01:15:44Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"To unify mark-up used in our documentation to a newer convention,\nstarted by 22293895 (doc: apply synopsis simplification on git-clone\nand git-init, 2024-09-24), update the documentation of 'git daemon'\nto\n\n * use [synopsis], not [verse] in the SYNOPSIS section\n * enclose `--option=<value>` in backquotes\n\nAlso, split '--[no-]option' into '--option' and '--no-option'\nto make it easier to grep for them.\n\nSigned-off-by: Junio C Hamano <gitster@pobox.com>\n---\n Documentation/git-daemon.adoc | 119 +++++++++++++++++-----------------\n 1 file changed, 60 insertions(+), 59 deletions(-)\n\ndiff --git a/Documentation/git-daemon.adoc b/Documentation/git-daemon.adoc\nindex ede7b935d6..bc3f77405e 100644\n--- a/Documentation/git-daemon.adoc\n+++ b/Documentation/git-daemon.adoc\n@@ -7,21 +7,21 @@ git-daemon - A really simple server for Git repositories\n \n SYNOPSIS\n --------\n-[verse]\n-'git daemon' [--verbose] [--syslog] [--export-all]\n-\t     [--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]\n-\t     [--strict-paths] [--base-path=<path>] [--base-path-relaxed]\n-\t     [--user-path | --user-path=<path>]\n-\t     [--interpolated-path=<pathtemplate>]\n-\t     [--reuseaddr] [--detach] [--pid-file=<file>]\n-\t     [--enable=<service>] [--disable=<service>]\n-\t     [--allow-override=<service>] [--forbid-override=<service>]\n-\t     [--access-hook=<path>] [--[no-]informative-errors]\n-\t     [--inetd |\n-\t      [--listen=<host-or-ipaddr>] [--port=<n>]\n-\t      [--user=<user> [--group=<group>]]]\n-\t     [--log-destination=(stderr|syslog|none)]\n-\t     [<directory>...]\n+[synopsis]\n+git daemon [--verbose] [--syslog] [--export-all]\n+\t   [--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]\n+\t   [--strict-paths] [--base-path=<path>] [--base-path-relaxed]\n+\t   [--user-path | --user-path=<path>]\n+\t   [--interpolated-path=<pathtemplate>]\n+\t   [--reuseaddr] [--detach] [--pid-file=<file>]\n+\t   [--enable=<service>] [--disable=<service>]\n+\t   [--allow-override=<service>] [--forbid-override=<service>]\n+\t   [--access-hook=<path>] [--[no-]informative-errors]\n+\t   [--inetd |\n+\t     [--listen=<host-or-ipaddr>] [--port=<n>]\n+\t     [--user=<user> [--group=<group>]]]\n+\t   [--log-destination=(stderr|syslog|none)]\n+\t   [<directory>...]\n \n DESCRIPTION\n -----------\n@@ -32,7 +32,7 @@ that service if it is enabled.\n It verifies that the directory has the magic file \"git-daemon-export-ok\", and\n it will refuse to export any Git directory that hasn't explicitly been marked\n for export this way (unless the `--export-all` parameter is specified). If you\n-pass some directory paths as 'git daemon' arguments, the offers are limited to\n+pass some directory paths as `git daemon` arguments, the offers are limited to\n repositories within those directories.\n \n By default, only `upload-pack` service is enabled, which serves\n@@ -46,26 +46,26 @@ An `upload-archive` also exists to serve 'git archive'.\n \n OPTIONS\n -------\n---strict-paths::\n+`--strict-paths`::\n \tMatch paths exactly (i.e. don't allow \"/foo/repo\" when the real path is\n \t\"/foo/repo.git\" or \"/foo/repo/.git\") and don't do user-relative paths.\n-\t'git daemon' will refuse to start when this option is enabled and no\n+\t`git daemon` will refuse to start when this option is enabled and no\n \tdirectory arguments are provided.\n \n---base-path=<path>::\n+`--base-path=<path>`::\n \tRemap all the path requests as relative to the given path.\n-\tThis is sort of \"Git root\" - if you run 'git daemon' with\n-\t'--base-path=/srv/git' on example.com, then if you later try to pull\n-\t'git://example.com/hello.git', 'git daemon' will interpret the path\n-\tas `/srv/git/hello.git`.\n+\tThis is sort of \"Git root\" - if you run `git daemon` with\n+\t`--base-path=/srv/git` on `example.com`, then if you later try\n+\tto pull from `git://example.com/hello.git`, `git daemon` will\n+\tinterpret the path as `/srv/git/hello.git`.\n \n---base-path-relaxed::\n-\tIf --base-path is enabled and repo lookup fails, with this option\n+`--base-path-relaxed`::\n+\tIf `--base-path` is enabled and repo lookup fails, with this option\n \t'git daemon' will attempt to lookup without prefixing the base path.\n-\tThis is useful for switching to --base-path usage, while still\n+\tThis is useful for switching to `--base-path` usage, while still\n \tallowing the old paths.\n \n---interpolated-path=<pathtemplate>::\n+`--interpolated-path=<pathtemplate>`::\n \tTo support virtual hosting, an interpolated path template can be\n \tused to dynamically construct alternate paths.  The template\n \tsupports %H for the target hostname as supplied by the client but\n@@ -75,48 +75,48 @@ OPTIONS\n \tAfter interpolation, the path is validated against the directory\n \tlist.\n \n---export-all::\n+`--export-all`::\n \tAllow pulling from all directories that look like Git repositories\n \t(have the 'objects' and 'refs' subdirectories), even if they\n \tdo not have the 'git-daemon-export-ok' file.\n \n---inetd::\n-\tHave the server run as an inetd service. Implies --syslog (may be\n-\toverridden with `--log-destination=`).\n-\tIncompatible with --detach, --port, --listen, --user and --group\n-\toptions.\n+`--inetd`::\n+\tHave the server run as an inetd service. Implies `--syslog` (may\n+\tbe overridden with `--log-destination=`).\n+\tIncompatible with `--detach`, `--port`, `--listen`, `--user` and\n+\t`--group` options.\n \n---listen=<host-or-ipaddr>::\n+`--listen=<host-or-ipaddr>`::\n \tListen on a specific IP address or hostname.  IP addresses can\n \tbe either an IPv4 address or an IPv6 address if supported.  If IPv6\n-\tis not supported, then --listen=<hostname> is also not supported and\n-\t--listen must be given an IPv4 address.\n+\tis not supported, then `--listen=<hostname>` is also not supported\n+\tand `--listen` must be given an IPv4 address.\n \tCan be given more than once.\n \tIncompatible with `--inetd` option.\n \n---port=<n>::\n+`--port=<n>`::\n \tListen on an alternative port.  Incompatible with `--inetd` option.\n \n---init-timeout=<n>::\n+`--init-timeout=<n>`::\n \tTimeout (in seconds) between the moment the connection is established\n \tand the client request is received (typically a rather low value, since\n \tthat should be basically immediate).\n \n---timeout=<n>::\n+`--timeout=<n>`::\n \tTimeout (in seconds) for specific client sub-requests. This includes\n \tthe time it takes for the server to process the sub-request and the\n \ttime spent waiting for the next client's request.\n \n---max-connections=<n>::\n+`--max-connections=<n>`::\n \tMaximum number of concurrent clients, defaults to 32.  Set it to\n \tzero for no limit.\n \n---syslog::\n+`--syslog`::\n \tShort for `--log-destination=syslog`.\n \n---log-destination=<destination>::\n+`--log-destination=<destination>`::\n \tSend log messages to the specified destination.\n-\tNote that this option does not imply --verbose,\n+\tNote that this option does not imply `--verbose`,\n \tthus by default only error conditions will be logged.\n \tThe <destination> must be one of:\n +\n@@ -135,8 +135,8 @@ none::\n The default destination is `syslog` if `--inetd` or `--detach` is specified,\n otherwise `stderr`.\n \n---user-path::\n---user-path=<path>::\n+`--user-path`::\n+`--user-path=<path>`::\n \tAllow {tilde}user notation to be used in requests.  When\n \tspecified with no parameter, a request to\n \tgit://host/{tilde}alice/foo is taken as a request to access\n@@ -145,23 +145,23 @@ otherwise `stderr`.\n \ttaken as a request to access `<path>/foo` repository in\n \tthe home directory of user `alice`.\n \n---verbose::\n+`--verbose`::\n \tLog details about the incoming connections and requested files.\n \n---reuseaddr::\n+`--reuseaddr`::\n \tUse SO_REUSEADDR when binding the listening socket.\n \tThis allows the server to restart without waiting for\n \told connections to time out.\n \n---detach::\n-\tDetach from the shell. Implies --syslog.\n+`--detach`::\n+\tDetach from the shell. Implies `--syslog`.\n \n---pid-file=<file>::\n+`--pid-file=<file>`::\n \tSave the process id in 'file'.  Ignored when the daemon\n \tis run under `--inetd`.\n \n---user=<user>::\n---group=<group>::\n+`--user=<user>`::\n+`--group=<group>`::\n \tChange daemon's uid and gid before entering the service loop.\n \tWhen only `--user` is given without `--group`, the\n \tprimary group ID for the user is used.  The values of\n@@ -179,30 +179,31 @@ may also want to set and export `HOME` to point at the home\n directory of `<user>` before starting the daemon, and make sure any\n Git configuration files in that directory are readable by `<user>`.\n \n---enable=<service>::\n---disable=<service>::\n+`--enable=<service>`::\n+`--disable=<service>`::\n \tEnable/disable the service site-wide per default.  Note\n \tthat a service disabled site-wide can still be enabled\n \tper repository if it is marked overridable and the\n \trepository enables the service with a configuration\n \titem.\n \n---allow-override=<service>::\n---forbid-override=<service>::\n+`--allow-override=<service>`::\n+`--forbid-override=<service>`::\n \tAllow/forbid overriding the site-wide default with per\n \trepository configuration.  By default, all the services\n \tmay be overridden.\n \n---[no-]informative-errors::\n+`--informative-errors`::\n+`--no-informative-errors`::\n \tWhen informative errors are turned on, git-daemon will report\n \tmore verbose errors to the client, differentiating conditions\n \tlike \"no such repository\" from \"repository not exported\". This\n \tis more convenient for clients, but may leak information about\n \tthe existence of unexported repositories.  When informative\n \terrors are not enabled, all errors report \"access denied\" to the\n-\tclient. The default is --no-informative-errors.\n+\tclient. The default is `--no-informative-errors`.\n \n---access-hook=<path>::\n+`--access-hook=<path>`::\n \tEvery time a client connects, first run an external command\n \tspecified by the <path> with service name (e.g. \"upload-pack\"),\n \tpath to the repository, hostname (%H), canonical hostname\n-- \n2.49.0-601-ga5925c3955\n\n"},{"id":"517520","messageId":"20250507210104.26709-1-jn.avila@free.fr","threadId":"63380","inReplyTo":"20250503011537.3035416-1-gitster@pobox.com","subject":"Additional changes","fromName":"Jean-Noël Avila","fromEmail":"jn.avila@free.fr","sentAt":"2025-05-07T20:58:15Z","receivedAt":"2025-05-07T21:01:44Z","isPatch":false,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"Thank you for helping out with this dull task.\n\nHere are a few additional changes after reviewing the manpages.\n\nThanks\n\nJean-Noël\n\n"},{"id":"517521","messageId":"20250507210104.26709-2-jn.avila@free.fr","threadId":"63380","inReplyTo":"20250507210104.26709-1-jn.avila@free.fr","subject":"[PATCH] Additional changes","fromName":"Jean-Noël Avila","fromEmail":"jn.avila@free.fr","sentAt":"2025-05-07T20:58:16Z","receivedAt":"2025-05-07T21:01:49Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"---\n Documentation/git-daemon.adoc     | 60 +++++++++++++++----------------\n Documentation/git-var.adoc        | 40 ++++++++++-----------\n Documentation/git-verify-tag.adoc |  2 +-\n Documentation/git-write-tree.adoc |  2 +-\n 4 files changed, 51 insertions(+), 53 deletions(-)\n\ndiff --git a/Documentation/git-daemon.adoc b/Documentation/git-daemon.adoc\nindex bc3f77405e..99389f0388 100644\n--- a/Documentation/git-daemon.adoc\n+++ b/Documentation/git-daemon.adoc\n@@ -36,13 +36,13 @@ pass some directory paths as `git daemon` arguments, the offers are limited to\n repositories within those directories.\n \n By default, only `upload-pack` service is enabled, which serves\n-'git fetch-pack' and 'git ls-remote' clients, which are invoked\n-from 'git fetch', 'git pull', and 'git clone'.\n+`git fetch-pack` and `git ls-remote` clients, which are invoked\n+from `git fetch`, `git pull`, and `git clone`.\n \n This is ideally suited for read-only updates, i.e., pulling from\n Git repositories.\n \n-An `upload-archive` also exists to serve 'git archive'.\n+An `upload-archive` also exists to serve `git archive`.\n \n OPTIONS\n -------\n@@ -61,24 +61,24 @@ OPTIONS\n \n `--base-path-relaxed`::\n \tIf `--base-path` is enabled and repo lookup fails, with this option\n-\t'git daemon' will attempt to lookup without prefixing the base path.\n+\t`git daemon` will attempt to lookup without prefixing the base path.\n \tThis is useful for switching to `--base-path` usage, while still\n \tallowing the old paths.\n \n `--interpolated-path=<pathtemplate>`::\n \tTo support virtual hosting, an interpolated path template can be\n \tused to dynamically construct alternate paths.  The template\n-\tsupports %H for the target hostname as supplied by the client but\n-\tconverted to all lowercase, %CH for the canonical hostname,\n-\t%IP for the server's IP address, %P for the port number,\n-\tand %D for the absolute path of the named repository.\n+\tsupports `%H` for the target hostname as supplied by the client but\n+\tconverted to all lowercase, `%CH` for the canonical hostname,\n+\t`%IP` for the server's IP address, `%P` for the port number,\n+\tand `%D` for the absolute path of the named repository.\n \tAfter interpolation, the path is validated against the directory\n \tlist.\n \n `--export-all`::\n \tAllow pulling from all directories that look like Git repositories\n \t(have the 'objects' and 'refs' subdirectories), even if they\n-\tdo not have the 'git-daemon-export-ok' file.\n+\tdo not have the `git-daemon-export-ok` file.\n \n `--inetd`::\n \tHave the server run as an inetd service. Implies `--syslog` (may\n@@ -118,17 +118,17 @@ OPTIONS\n \tSend log messages to the specified destination.\n \tNote that this option does not imply `--verbose`,\n \tthus by default only error conditions will be logged.\n-\tThe <destination> must be one of:\n+\tThe _<destination>_ must be one of:\n +\n --\n-stderr::\n+`stderr`::\n \tWrite to standard error.\n \tNote that if `--detach` is specified,\n \tthe process disconnects from the real standard error,\n \tmaking this destination effectively equivalent to `none`.\n-syslog::\n+`syslog`::\n \tWrite to syslog, using the `git-daemon` identifier.\n-none::\n+`none`::\n \tDisable all logging.\n --\n +\n@@ -149,7 +149,7 @@ otherwise `stderr`.\n \tLog details about the incoming connections and requested files.\n \n `--reuseaddr`::\n-\tUse SO_REUSEADDR when binding the listening socket.\n+\tUse `SO_REUSEADDR` when binding the listening socket.\n \tThis allows the server to restart without waiting for\n \told connections to time out.\n \n@@ -157,7 +157,7 @@ otherwise `stderr`.\n \tDetach from the shell. Implies `--syslog`.\n \n `--pid-file=<file>`::\n-\tSave the process id in 'file'.  Ignored when the daemon\n+\tSave the process id in _<file>_.  Ignored when the daemon\n \tis run under `--inetd`.\n \n `--user=<user>`::\n@@ -170,14 +170,14 @@ otherwise `stderr`.\n +\n Giving these options is an error when used with `--inetd`; use\n the facility of inet daemon to achieve the same before spawning\n-'git daemon' if needed.\n+`git daemon` if needed.\n +\n Like many programs that switch user id, the daemon does not reset\n-environment variables such as `$HOME` when it runs git programs,\n+environment variables such as `HOME` when it runs git programs,\n e.g. `upload-pack` and `receive-pack`. When using this option, you\n may also want to set and export `HOME` to point at the home\n-directory of `<user>` before starting the daemon, and make sure any\n-Git configuration files in that directory are readable by `<user>`.\n+directory of _<user>_ before starting the daemon, and make sure any\n+Git configuration files in that directory are readable by _<user>_.\n \n `--enable=<service>`::\n `--disable=<service>`::\n@@ -206,8 +206,8 @@ Git configuration files in that directory are readable by `<user>`.\n `--access-hook=<path>`::\n \tEvery time a client connects, first run an external command\n \tspecified by the <path> with service name (e.g. \"upload-pack\"),\n-\tpath to the repository, hostname (%H), canonical hostname\n-\t(%CH), IP address (%IP), and TCP port (%P) as its command-line\n+\tpath to the repository, hostname (`%H`), canonical hostname\n+\t(`%CH`), IP address (`%IP`), and TCP port (`%P`) as its command-line\n \targuments. The external command can decide to decline the\n \tservice by exiting with a non-zero status (or to allow it by\n \texiting with a zero status).  It can also look at the $REMOTE_ADDR\n@@ -218,7 +218,7 @@ The external command can optionally write a single line to its\n standard output to be sent to the requestor as an error message when\n it declines the service.\n \n-<directory>::\n+_<directory>_::\n \tThe remaining arguments provide a list of directories. If any\n \tdirectories are specified, then the `git-daemon` process will\n \tserve a requested directory only if it is contained in one of\n@@ -230,24 +230,24 @@ SERVICES\n \n These services can be globally enabled/disabled using the\n command-line options of this command.  If finer-grained\n-control is desired (e.g. to allow 'git archive' to be run\n+control is desired (e.g. to allow `git archive` to be run\n against only in a few selected repositories the daemon serves),\n the per-repository configuration file can be used to enable or\n disable them.\n \n upload-pack::\n-\tThis serves 'git fetch-pack' and 'git ls-remote'\n+\tThis serves `git fetch-pack` and `git ls-remote`\n \tclients.  It is enabled by default, but a repository can\n \tdisable it by setting `daemon.uploadpack` configuration\n \titem to `false`.\n \n upload-archive::\n-\tThis serves 'git archive --remote'.  It is disabled by\n+\tThis serves `git archive --remote`.  It is disabled by\n \tdefault, but a repository can enable it by setting\n \t`daemon.uploadarch` configuration item to `true`.\n \n receive-pack::\n-\tThis serves 'git send-pack' clients, allowing anonymous\n+\tThis serves `git send-pack` clients, allowing anonymous\n \tpush.  It is disabled by default, as there is _no_\n \tauthentication in the protocol (in other words, anybody\n \tcan push anything into the repository, including removal\n@@ -301,7 +301,7 @@ default repository could be made as well.\n \n \n 'git daemon' as regular daemon for virtual hosts::\n-\tTo set up 'git daemon' as a regular, non-inetd service that\n+\tTo set up `git daemon` as a regular, non-inetd service that\n \thandles repositories for multiple virtual hosts based on\n \ttheir IP addresses, start the daemon like this:\n +\n@@ -318,7 +318,7 @@ Repositories can still be accessed by hostname though, assuming\n they correspond to these IP addresses.\n \n selectively enable/disable services per repository::\n-\tTo enable 'git archive --remote' and disable 'git fetch' against\n+\tTo enable `git archive --remote` and disable `git fetch` against\n \ta repository, have the following in the configuration file in the\n \trepository (that is the file 'config' next to `HEAD`, 'refs' and\n \t'objects').\n@@ -332,8 +332,8 @@ selectively enable/disable services per repository::\n \n ENVIRONMENT\n -----------\n-'git daemon' will set REMOTE_ADDR to the IP address of the client\n-that connected to it, if the IP address is available. REMOTE_ADDR will\n+`git daemon` will set `REMOTE_ADDR` to the IP address of the client\n+that connected to it, if the IP address is available. `REMOTE_ADDR` will\n be available in the environment of hooks called when\n services are performed.\n \ndiff --git a/Documentation/git-var.adoc b/Documentation/git-var.adoc\nindex 909963b1c2..b606c2d649 100644\n--- a/Documentation/git-var.adoc\n+++ b/Documentation/git-var.adoc\n@@ -32,58 +32,56 @@ EXAMPLES\n \n VARIABLES\n ---------\n-GIT_AUTHOR_IDENT::\n+`GIT_AUTHOR_IDENT`::\n     The author of a piece of code.\n \n-GIT_COMMITTER_IDENT::\n+`GIT_COMMITTER_IDENT`::\n     The person who put a piece of code into Git.\n \n-GIT_EDITOR::\n+`GIT_EDITOR`::\n     Text editor for use by Git commands.  The value is meant to be\n     interpreted by the shell when it is used.  Examples: `~/bin/vi`,\n     `$SOME_ENVIRONMENT_VARIABLE`, `\"C:\\Program Files\\Vim\\gvim.exe\"\n-    --nofork`.  The order of preference is the `$GIT_EDITOR`\n-    environment variable, then `core.editor` configuration, then\n-    `$VISUAL`, then `$EDITOR`, and then the default chosen at compile\n+    --nofork`.  The order of preference is `$GIT_EDITOR`, then\n+    `core.editor` configuration value, then `$VISUAL`, then\n+    `$EDITOR`, and then the default chosen at compile\n     time, which is usually 'vi'.\n ifdef::git-default-editor[]\n     The build you are using chose '{git-default-editor}' as the default.\n endif::git-default-editor[]\n \n-GIT_SEQUENCE_EDITOR::\n+`GIT_SEQUENCE_EDITOR`::\n     Text editor used to edit the 'todo' file while running `git rebase\n     -i`. Like `GIT_EDITOR`, the value is meant to be interpreted by\n-    the shell when it is used. The order of preference is the\n-    `$GIT_SEQUENCE_EDITOR` environment variable, then\n-    `sequence.editor` configuration, and then the value of `git var\n-    GIT_EDITOR`.\n+    the shell when it is used. The order of preference is\n+    `$GIT_SEQUENCE_EDITOR`, then `sequence.editor` configuration value,\n+    and then the value of `git var GIT_EDITOR`.\n \n-GIT_PAGER::\n+`GIT_PAGER`::\n     Text viewer for use by Git commands (e.g., 'less').  The value\n     is meant to be interpreted by the shell.  The order of preference\n-    is the `$GIT_PAGER` environment variable, then `core.pager`\n-    configuration, then `$PAGER`, and then the default chosen at\n-    compile time (usually 'less').\n+    is `$GIT_PAGER`, then the value of `core.pager` configuration, then\n+    `$PAGER`, and then the default chosen at compile time (usually `less`).\n ifdef::git-default-pager[]\n     The build you are using chose '{git-default-pager}' as the default.\n endif::git-default-pager[]\n \n-GIT_DEFAULT_BRANCH::\n+`GIT_DEFAULT_BRANCH`::\n     The name of the first branch created in newly initialized repositories.\n \n-GIT_SHELL_PATH::\n+`GIT_SHELL_PATH`::\n     The path of the binary providing the POSIX shell for commands which use the shell.\n \n-GIT_ATTR_SYSTEM::\n+`GIT_ATTR_SYSTEM`::\n     The path to the system linkgit:gitattributes[5] file, if one is enabled.\n \n-GIT_ATTR_GLOBAL::\n+`GIT_ATTR_GLOBAL`::\n     The path to the global (per-user) linkgit:gitattributes[5] file.\n \n-GIT_CONFIG_SYSTEM::\n+`GIT_CONFIG_SYSTEM`::\n     The path to the system configuration file, if one is enabled.\n \n-GIT_CONFIG_GLOBAL::\n+`GIT_CONFIG_GLOBAL`::\n     The path to the global (per-user) configuration files, if any.\n \n Most path values contain only one value. However, some can contain multiple\ndiff --git a/Documentation/git-verify-tag.adoc b/Documentation/git-verify-tag.adoc\nindex ec995323f6..b3721a86f4 100644\n--- a/Documentation/git-verify-tag.adoc\n+++ b/Documentation/git-verify-tag.adoc\n@@ -12,7 +12,7 @@ git verify-tag [-v | --verbose] [--format=<format>] [--raw] <tag>...\n \n DESCRIPTION\n -----------\n-Validates the gpg signature created by 'git tag' in the tag\n+Validates the gpg signature created by `git tag` in the tag\n objects listed on the command line.\n \n OPTIONS\ndiff --git a/Documentation/git-write-tree.adoc b/Documentation/git-write-tree.adoc\nindex 4e1c3b9c0c..4c7100ea1e 100644\n--- a/Documentation/git-write-tree.adoc\n+++ b/Documentation/git-write-tree.adoc\n@@ -34,7 +34,7 @@ OPTIONS\n \n `--prefix=<prefix>/`::\n \tWrites a tree object that represents a subdirectory\n-\t`<prefix>`.  This can be used to write the tree object\n+\t_<prefix>_.  This can be used to write the tree object\n \tfor a subproject that is in the named subdirectory.\n \n GIT\n-- \n2.48.0\n\n"},{"id":"517562","messageId":"xmqq1psz878f.fsf@gitster.g","threadId":"63380","inReplyTo":"20250507210104.26709-2-jn.avila@free.fr","subject":"Re: [PATCH] Additional changes","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-08T15:14:40Z","receivedAt":"2025-05-08T15:14:43Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jean-Noël Avila <jn.avila@free.fr> writes:\n\n> ---\n>  Documentation/git-daemon.adoc     | 60 +++++++++++++++----------------\n>  Documentation/git-var.adoc        | 40 ++++++++++-----------\n>  Documentation/git-verify-tag.adoc |  2 +-\n>  Documentation/git-write-tree.adoc |  2 +-\n>  4 files changed, 51 insertions(+), 53 deletions(-)\n\nI was somewhat confused where this patch is designed to apply, but I\nthink I figured it out.  These are to further update on top of my\nsynopsis related mark-up updates.\n\nDo you mean this as a set of review comment, i.e. I am expected to\nspilt them into parts and fold them into those three commits to\nproduce an updated version of those three patches with \"Helped-by:\"\nattributing you?\n\nOr do you want this to sit on top of the 3-patch series separately\nas the 4th patch?  If the latter we'd need a log message plus\nsign-off.\n\nI'd assume it is the former (as the three-patch series hasn't hit\n'next' yet) and start updating htese three patches.\n\nThanks.\n"},{"id":"517661","messageId":"5040970.31r3eYUQgx@cayenne","threadId":"63380","inReplyTo":"xmqq1psz878f.fsf@gitster.g","subject":"Re: [PATCH] Additional changes","fromName":"Jean-Noël AVILA","fromEmail":"jn.avila@free.fr","sentAt":"2025-05-09T12:12:53Z","receivedAt":"2025-05-09T12:13:02Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"On Thursday, 8 May 2025 17:14:40 CEST Junio C Hamano wrote:\n> Jean-Noël Avila <jn.avila@free.fr> writes:\n> > ---\n> > \n> >  Documentation/git-daemon.adoc     | 60 +++++++++++++++----------------\n> >  Documentation/git-var.adoc        | 40 ++++++++++-----------\n> >  Documentation/git-verify-tag.adoc |  2 +-\n> >  Documentation/git-write-tree.adoc |  2 +-\n> >  4 files changed, 51 insertions(+), 53 deletions(-)\n> \n> I was somewhat confused where this patch is designed to apply, but I\n> think I figured it out.  These are to further update on top of my\n> synopsis related mark-up updates.\n> \n> Do you mean this as a set of review comment, i.e. I am expected to\n> spilt them into parts and fold them into those three commits to\n> produce an updated version of those three patches with \"Helped-by:\"\n> attributing you?\n> \n> Or do you want this to sit on top of the 3-patch series separately\n> as the 4th patch?  If the latter we'd need a log message plus\n> sign-off.\n> \n> I'd assume it is the former (as the three-patch series hasn't hit\n> 'next' yet) and start updating htese three patches.\n> \n> Thanks.\n\nSorry for not being clear. I was wary of what the provided patches did not \naddress, so I reviewed after applying your series and bundled it in another \npatch, which was not signed off on purpose.\n\nOf course, the proposed changes can be discussed. If you prefer, I can \ndispatch them and propose a v3.\n\n\nThanks,\n\nJN\n\n\n\n\n\n\n"},{"id":"517684","messageId":"xmqqr00x3l8h.fsf@gitster.g","threadId":"63380","inReplyTo":"5040970.31r3eYUQgx@cayenne","subject":"Re: [PATCH] Additional changes","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-09T14:35:42Z","receivedAt":"2025-05-09T14:35:45Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jean-Noël AVILA <jn.avila@free.fr> writes:\n\n>> I'd assume it is the former (as the three-patch series hasn't hit\n>> 'next' yet) and start updating htese three patches.\n>> \n>> Thanks.\n>\n> Sorry for not being clear. I was wary of what the provided patches did not \n> address, so I reviewed after applying your series and bundled it in another \n> patch, which was not signed off on purpose.\n\nI see.  In the original, I deliberately ignored what the patches did\nnot address ;-) as I wanted to limit the scope of the changes to\nreduce the number of things the reviewers need to look for.\n\nIn any case, i assumed the former and squashed your changes (which\nlooked all sensible) and the result is what is in my tree right now\n(but it can be further modified as the series is not yet in 'next').\n\n> Of course, the proposed changes can be discussed. If you prefer, I can \n> dispatch them and propose a v3.\n\nSurely.  Are there particular things that you were either unsure\nabout (which may lead to possible partial retraction) or want to\nstress on (which would help other developers and reviewers recall\nwhat they need to watch out for when touching the documentation)?\n\nThanks.\n"},{"id":"517700","messageId":"13790247.uLZWGnKmhe@cayenne","threadId":"63380","inReplyTo":"xmqqr00x3l8h.fsf@gitster.g","subject":"Re: [PATCH] Additional changes","fromName":"Jean-Noël AVILA","fromEmail":"jn.avila@free.fr","sentAt":"2025-05-09T17:08:37Z","receivedAt":"2025-05-09T17:08:40Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"On Friday, 9 May 2025 16:35:42 CEST Junio C Hamano wrote:\n> Surely.  Are there particular things that you were either unsure\n> about (which may lead to possible partial retraction) or want to\n> stress on (which would help other developers and reviewers recall\n> what they need to watch out for when touching the documentation)?\n> \n\nNow that you're asking, the heavy additional changes to git-var's manpage are \nmainly targeted at clearing out some misuses of $ENV_VAR vs ENV_VAR as I see \nthem. Others can disagree. \n\nMaybe these changes should go into a separated patch because they do not \nreally fit with the \"new style\" changes.\n\nThanks\n\n\n"},{"id":"517704","messageId":"xmqqmsbl1w3f.fsf@gitster.g","threadId":"63380","inReplyTo":"13790247.uLZWGnKmhe@cayenne","subject":"Re: [PATCH] Additional changes","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-05-09T18:24:04Z","receivedAt":"2025-05-09T18:24:07Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jean-Noël AVILA <jn.avila@free.fr> writes:\n\n> On Friday, 9 May 2025 16:35:42 CEST Junio C Hamano wrote:\n>> Surely.  Are there particular things that you were either unsure\n>> about (which may lead to possible partial retraction) or want to\n>> stress on (which would help other developers and reviewers recall\n>> what they need to watch out for when touching the documentation)?\n>> \n>\n> Now that you're asking, the heavy additional changes to git-var's manpage are \n> mainly targeted at clearing out some misuses of $ENV_VAR vs ENV_VAR as I see \n> them. Others can disagree. \n>\n> Maybe these changes should go into a separated patch because they do not \n> really fit with the \"new style\" changes.\n\nOK, then I'll revert the changes from these three patches I squashed\nyour additional changes in, so that we can have a separate series to\nclean up \"$ENV_VAR vs ENV_VAR\" (Documentation/CodingGuidelines tells\nus when to use and not to use \"$\", which is quite useful), perhaps?\n\nThanks.\n"},{"id":"517728","messageId":"20250510123346.20927-1-jn.avila@free.fr","threadId":"63380","inReplyTo":"20250501213414.370514-1-gitster@pobox.com","subject":"[PATCH v3 0/4] Additional changes","fromName":"Jean-Noël Avila","fromEmail":"jn.avila@free.fr","sentAt":"2025-05-10T12:33:13Z","receivedAt":"2025-05-10T12:34:33Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"This series is just applying additional 'new style' changes on top of the\nprevious versions. Another patch is added to fix $ENV_VAR vs ENV_VAR misuse.\n\nJean-Noël Avila (1):\n  git-var doc: fix usage of $ENV_VAR vs ENV_VAR\n\nJunio C Hamano (3):\n  git-daemon doc: update mark-up of synopsis option descriptions\n  git-{var,write-tree} docs: update mark-up of synopsis option\n    descriptions\n  git-verify-* doc: update mark-up of synopsis option descriptions\n\n Documentation/git-daemon.adoc        | 181 ++++++++++++++-------------\n Documentation/git-var.adoc           |  46 ++++---\n Documentation/git-verify-commit.adoc |  16 ++-\n Documentation/git-verify-pack.adoc   |  28 ++---\n Documentation/git-verify-tag.adoc    |  16 ++-\n Documentation/git-write-tree.adoc    |  18 +--\n 6 files changed, 148 insertions(+), 157 deletions(-)\n\n-- \n2.48.0\n\n"},{"id":"517729","messageId":"20250510123346.20927-2-jn.avila@free.fr","threadId":"63380","inReplyTo":"20250510123346.20927-1-jn.avila@free.fr","subject":"[PATCH v3 1/4] git-daemon doc: update mark-up of synopsis option descriptions","fromName":"Jean-Noël Avila","fromEmail":"jn.avila@free.fr","sentAt":"2025-05-10T12:33:14Z","receivedAt":"2025-05-10T12:34:44Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: Junio C Hamano <gitster@pobox.com>\n\nTo unify mark-up used in our documentation to a newer convention,\nstarted by 22293895 (doc: apply synopsis simplification on git-clone\nand git-init, 2024-09-24), update the documentation of 'git daemon'\nto\n\n * use [synopsis], not [verse] in the SYNOPSIS section\n * enclose `--option=<value>` in backquotes\n\nAlso, split '--[no-]option' into '--option' and '--no-option'\nto make it easier to grep for them.\n\nSigned-off-by: Junio C Hamano <gitster@pobox.com>\nHelped-by: Jean-Noël Avila <jn.avila@free.fr>\n---\n Documentation/git-daemon.adoc | 181 +++++++++++++++++-----------------\n 1 file changed, 91 insertions(+), 90 deletions(-)\n\ndiff --git a/Documentation/git-daemon.adoc b/Documentation/git-daemon.adoc\nindex ede7b935d6..99389f0388 100644\n--- a/Documentation/git-daemon.adoc\n+++ b/Documentation/git-daemon.adoc\n@@ -7,21 +7,21 @@ git-daemon - A really simple server for Git repositories\n \n SYNOPSIS\n --------\n-[verse]\n-'git daemon' [--verbose] [--syslog] [--export-all]\n-\t     [--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]\n-\t     [--strict-paths] [--base-path=<path>] [--base-path-relaxed]\n-\t     [--user-path | --user-path=<path>]\n-\t     [--interpolated-path=<pathtemplate>]\n-\t     [--reuseaddr] [--detach] [--pid-file=<file>]\n-\t     [--enable=<service>] [--disable=<service>]\n-\t     [--allow-override=<service>] [--forbid-override=<service>]\n-\t     [--access-hook=<path>] [--[no-]informative-errors]\n-\t     [--inetd |\n-\t      [--listen=<host-or-ipaddr>] [--port=<n>]\n-\t      [--user=<user> [--group=<group>]]]\n-\t     [--log-destination=(stderr|syslog|none)]\n-\t     [<directory>...]\n+[synopsis]\n+git daemon [--verbose] [--syslog] [--export-all]\n+\t   [--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]\n+\t   [--strict-paths] [--base-path=<path>] [--base-path-relaxed]\n+\t   [--user-path | --user-path=<path>]\n+\t   [--interpolated-path=<pathtemplate>]\n+\t   [--reuseaddr] [--detach] [--pid-file=<file>]\n+\t   [--enable=<service>] [--disable=<service>]\n+\t   [--allow-override=<service>] [--forbid-override=<service>]\n+\t   [--access-hook=<path>] [--[no-]informative-errors]\n+\t   [--inetd |\n+\t     [--listen=<host-or-ipaddr>] [--port=<n>]\n+\t     [--user=<user> [--group=<group>]]]\n+\t   [--log-destination=(stderr|syslog|none)]\n+\t   [<directory>...]\n \n DESCRIPTION\n -----------\n@@ -32,111 +32,111 @@ that service if it is enabled.\n It verifies that the directory has the magic file \"git-daemon-export-ok\", and\n it will refuse to export any Git directory that hasn't explicitly been marked\n for export this way (unless the `--export-all` parameter is specified). If you\n-pass some directory paths as 'git daemon' arguments, the offers are limited to\n+pass some directory paths as `git daemon` arguments, the offers are limited to\n repositories within those directories.\n \n By default, only `upload-pack` service is enabled, which serves\n-'git fetch-pack' and 'git ls-remote' clients, which are invoked\n-from 'git fetch', 'git pull', and 'git clone'.\n+`git fetch-pack` and `git ls-remote` clients, which are invoked\n+from `git fetch`, `git pull`, and `git clone`.\n \n This is ideally suited for read-only updates, i.e., pulling from\n Git repositories.\n \n-An `upload-archive` also exists to serve 'git archive'.\n+An `upload-archive` also exists to serve `git archive`.\n \n OPTIONS\n -------\n---strict-paths::\n+`--strict-paths`::\n \tMatch paths exactly (i.e. don't allow \"/foo/repo\" when the real path is\n \t\"/foo/repo.git\" or \"/foo/repo/.git\") and don't do user-relative paths.\n-\t'git daemon' will refuse to start when this option is enabled and no\n+\t`git daemon` will refuse to start when this option is enabled and no\n \tdirectory arguments are provided.\n \n---base-path=<path>::\n+`--base-path=<path>`::\n \tRemap all the path requests as relative to the given path.\n-\tThis is sort of \"Git root\" - if you run 'git daemon' with\n-\t'--base-path=/srv/git' on example.com, then if you later try to pull\n-\t'git://example.com/hello.git', 'git daemon' will interpret the path\n-\tas `/srv/git/hello.git`.\n-\n---base-path-relaxed::\n-\tIf --base-path is enabled and repo lookup fails, with this option\n-\t'git daemon' will attempt to lookup without prefixing the base path.\n-\tThis is useful for switching to --base-path usage, while still\n+\tThis is sort of \"Git root\" - if you run `git daemon` with\n+\t`--base-path=/srv/git` on `example.com`, then if you later try\n+\tto pull from `git://example.com/hello.git`, `git daemon` will\n+\tinterpret the path as `/srv/git/hello.git`.\n+\n+`--base-path-relaxed`::\n+\tIf `--base-path` is enabled and repo lookup fails, with this option\n+\t`git daemon` will attempt to lookup without prefixing the base path.\n+\tThis is useful for switching to `--base-path` usage, while still\n \tallowing the old paths.\n \n---interpolated-path=<pathtemplate>::\n+`--interpolated-path=<pathtemplate>`::\n \tTo support virtual hosting, an interpolated path template can be\n \tused to dynamically construct alternate paths.  The template\n-\tsupports %H for the target hostname as supplied by the client but\n-\tconverted to all lowercase, %CH for the canonical hostname,\n-\t%IP for the server's IP address, %P for the port number,\n-\tand %D for the absolute path of the named repository.\n+\tsupports `%H` for the target hostname as supplied by the client but\n+\tconverted to all lowercase, `%CH` for the canonical hostname,\n+\t`%IP` for the server's IP address, `%P` for the port number,\n+\tand `%D` for the absolute path of the named repository.\n \tAfter interpolation, the path is validated against the directory\n \tlist.\n \n---export-all::\n+`--export-all`::\n \tAllow pulling from all directories that look like Git repositories\n \t(have the 'objects' and 'refs' subdirectories), even if they\n-\tdo not have the 'git-daemon-export-ok' file.\n+\tdo not have the `git-daemon-export-ok` file.\n \n---inetd::\n-\tHave the server run as an inetd service. Implies --syslog (may be\n-\toverridden with `--log-destination=`).\n-\tIncompatible with --detach, --port, --listen, --user and --group\n-\toptions.\n+`--inetd`::\n+\tHave the server run as an inetd service. Implies `--syslog` (may\n+\tbe overridden with `--log-destination=`).\n+\tIncompatible with `--detach`, `--port`, `--listen`, `--user` and\n+\t`--group` options.\n \n---listen=<host-or-ipaddr>::\n+`--listen=<host-or-ipaddr>`::\n \tListen on a specific IP address or hostname.  IP addresses can\n \tbe either an IPv4 address or an IPv6 address if supported.  If IPv6\n-\tis not supported, then --listen=<hostname> is also not supported and\n-\t--listen must be given an IPv4 address.\n+\tis not supported, then `--listen=<hostname>` is also not supported\n+\tand `--listen` must be given an IPv4 address.\n \tCan be given more than once.\n \tIncompatible with `--inetd` option.\n \n---port=<n>::\n+`--port=<n>`::\n \tListen on an alternative port.  Incompatible with `--inetd` option.\n \n---init-timeout=<n>::\n+`--init-timeout=<n>`::\n \tTimeout (in seconds) between the moment the connection is established\n \tand the client request is received (typically a rather low value, since\n \tthat should be basically immediate).\n \n---timeout=<n>::\n+`--timeout=<n>`::\n \tTimeout (in seconds) for specific client sub-requests. This includes\n \tthe time it takes for the server to process the sub-request and the\n \ttime spent waiting for the next client's request.\n \n---max-connections=<n>::\n+`--max-connections=<n>`::\n \tMaximum number of concurrent clients, defaults to 32.  Set it to\n \tzero for no limit.\n \n---syslog::\n+`--syslog`::\n \tShort for `--log-destination=syslog`.\n \n---log-destination=<destination>::\n+`--log-destination=<destination>`::\n \tSend log messages to the specified destination.\n-\tNote that this option does not imply --verbose,\n+\tNote that this option does not imply `--verbose`,\n \tthus by default only error conditions will be logged.\n-\tThe <destination> must be one of:\n+\tThe _<destination>_ must be one of:\n +\n --\n-stderr::\n+`stderr`::\n \tWrite to standard error.\n \tNote that if `--detach` is specified,\n \tthe process disconnects from the real standard error,\n \tmaking this destination effectively equivalent to `none`.\n-syslog::\n+`syslog`::\n \tWrite to syslog, using the `git-daemon` identifier.\n-none::\n+`none`::\n \tDisable all logging.\n --\n +\n The default destination is `syslog` if `--inetd` or `--detach` is specified,\n otherwise `stderr`.\n \n---user-path::\n---user-path=<path>::\n+`--user-path`::\n+`--user-path=<path>`::\n \tAllow {tilde}user notation to be used in requests.  When\n \tspecified with no parameter, a request to\n \tgit://host/{tilde}alice/foo is taken as a request to access\n@@ -145,23 +145,23 @@ otherwise `stderr`.\n \ttaken as a request to access `<path>/foo` repository in\n \tthe home directory of user `alice`.\n \n---verbose::\n+`--verbose`::\n \tLog details about the incoming connections and requested files.\n \n---reuseaddr::\n-\tUse SO_REUSEADDR when binding the listening socket.\n+`--reuseaddr`::\n+\tUse `SO_REUSEADDR` when binding the listening socket.\n \tThis allows the server to restart without waiting for\n \told connections to time out.\n \n---detach::\n-\tDetach from the shell. Implies --syslog.\n+`--detach`::\n+\tDetach from the shell. Implies `--syslog`.\n \n---pid-file=<file>::\n-\tSave the process id in 'file'.  Ignored when the daemon\n+`--pid-file=<file>`::\n+\tSave the process id in _<file>_.  Ignored when the daemon\n \tis run under `--inetd`.\n \n---user=<user>::\n---group=<group>::\n+`--user=<user>`::\n+`--group=<group>`::\n \tChange daemon's uid and gid before entering the service loop.\n \tWhen only `--user` is given without `--group`, the\n \tprimary group ID for the user is used.  The values of\n@@ -170,43 +170,44 @@ otherwise `stderr`.\n +\n Giving these options is an error when used with `--inetd`; use\n the facility of inet daemon to achieve the same before spawning\n-'git daemon' if needed.\n+`git daemon` if needed.\n +\n Like many programs that switch user id, the daemon does not reset\n-environment variables such as `$HOME` when it runs git programs,\n+environment variables such as `HOME` when it runs git programs,\n e.g. `upload-pack` and `receive-pack`. When using this option, you\n may also want to set and export `HOME` to point at the home\n-directory of `<user>` before starting the daemon, and make sure any\n-Git configuration files in that directory are readable by `<user>`.\n+directory of _<user>_ before starting the daemon, and make sure any\n+Git configuration files in that directory are readable by _<user>_.\n \n---enable=<service>::\n---disable=<service>::\n+`--enable=<service>`::\n+`--disable=<service>`::\n \tEnable/disable the service site-wide per default.  Note\n \tthat a service disabled site-wide can still be enabled\n \tper repository if it is marked overridable and the\n \trepository enables the service with a configuration\n \titem.\n \n---allow-override=<service>::\n---forbid-override=<service>::\n+`--allow-override=<service>`::\n+`--forbid-override=<service>`::\n \tAllow/forbid overriding the site-wide default with per\n \trepository configuration.  By default, all the services\n \tmay be overridden.\n \n---[no-]informative-errors::\n+`--informative-errors`::\n+`--no-informative-errors`::\n \tWhen informative errors are turned on, git-daemon will report\n \tmore verbose errors to the client, differentiating conditions\n \tlike \"no such repository\" from \"repository not exported\". This\n \tis more convenient for clients, but may leak information about\n \tthe existence of unexported repositories.  When informative\n \terrors are not enabled, all errors report \"access denied\" to the\n-\tclient. The default is --no-informative-errors.\n+\tclient. The default is `--no-informative-errors`.\n \n---access-hook=<path>::\n+`--access-hook=<path>`::\n \tEvery time a client connects, first run an external command\n \tspecified by the <path> with service name (e.g. \"upload-pack\"),\n-\tpath to the repository, hostname (%H), canonical hostname\n-\t(%CH), IP address (%IP), and TCP port (%P) as its command-line\n+\tpath to the repository, hostname (`%H`), canonical hostname\n+\t(`%CH`), IP address (`%IP`), and TCP port (`%P`) as its command-line\n \targuments. The external command can decide to decline the\n \tservice by exiting with a non-zero status (or to allow it by\n \texiting with a zero status).  It can also look at the $REMOTE_ADDR\n@@ -217,7 +218,7 @@ The external command can optionally write a single line to its\n standard output to be sent to the requestor as an error message when\n it declines the service.\n \n-<directory>::\n+_<directory>_::\n \tThe remaining arguments provide a list of directories. If any\n \tdirectories are specified, then the `git-daemon` process will\n \tserve a requested directory only if it is contained in one of\n@@ -229,24 +230,24 @@ SERVICES\n \n These services can be globally enabled/disabled using the\n command-line options of this command.  If finer-grained\n-control is desired (e.g. to allow 'git archive' to be run\n+control is desired (e.g. to allow `git archive` to be run\n against only in a few selected repositories the daemon serves),\n the per-repository configuration file can be used to enable or\n disable them.\n \n upload-pack::\n-\tThis serves 'git fetch-pack' and 'git ls-remote'\n+\tThis serves `git fetch-pack` and `git ls-remote`\n \tclients.  It is enabled by default, but a repository can\n \tdisable it by setting `daemon.uploadpack` configuration\n \titem to `false`.\n \n upload-archive::\n-\tThis serves 'git archive --remote'.  It is disabled by\n+\tThis serves `git archive --remote`.  It is disabled by\n \tdefault, but a repository can enable it by setting\n \t`daemon.uploadarch` configuration item to `true`.\n \n receive-pack::\n-\tThis serves 'git send-pack' clients, allowing anonymous\n+\tThis serves `git send-pack` clients, allowing anonymous\n \tpush.  It is disabled by default, as there is _no_\n \tauthentication in the protocol (in other words, anybody\n \tcan push anything into the repository, including removal\n@@ -300,7 +301,7 @@ default repository could be made as well.\n \n \n 'git daemon' as regular daemon for virtual hosts::\n-\tTo set up 'git daemon' as a regular, non-inetd service that\n+\tTo set up `git daemon` as a regular, non-inetd service that\n \thandles repositories for multiple virtual hosts based on\n \ttheir IP addresses, start the daemon like this:\n +\n@@ -317,7 +318,7 @@ Repositories can still be accessed by hostname though, assuming\n they correspond to these IP addresses.\n \n selectively enable/disable services per repository::\n-\tTo enable 'git archive --remote' and disable 'git fetch' against\n+\tTo enable `git archive --remote` and disable `git fetch` against\n \ta repository, have the following in the configuration file in the\n \trepository (that is the file 'config' next to `HEAD`, 'refs' and\n \t'objects').\n@@ -331,8 +332,8 @@ selectively enable/disable services per repository::\n \n ENVIRONMENT\n -----------\n-'git daemon' will set REMOTE_ADDR to the IP address of the client\n-that connected to it, if the IP address is available. REMOTE_ADDR will\n+`git daemon` will set `REMOTE_ADDR` to the IP address of the client\n+that connected to it, if the IP address is available. `REMOTE_ADDR` will\n be available in the environment of hooks called when\n services are performed.\n \n-- \n2.48.0\n\n"},{"id":"517730","messageId":"20250510123346.20927-3-jn.avila@free.fr","threadId":"63380","inReplyTo":"20250510123346.20927-1-jn.avila@free.fr","subject":"[PATCH v3 2/4] git-{var,write-tree} docs: update mark-up of synopsis option descriptions","fromName":"Jean-Noël Avila","fromEmail":"jn.avila@free.fr","sentAt":"2025-05-10T12:33:15Z","receivedAt":"2025-05-10T12:34:47Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: Junio C Hamano <gitster@pobox.com>\n\nTo unify mark-up used in our documentation to a newer convention,\nstarted by 22293895 (doc: apply synopsis simplification on git-clone\nand git-init, 2024-09-24), update the documentation for 'git var' and\n'git write-tree' to\n\n * use [synopsis], not [verse] in the SYNOPSIS section\n * enclose `--option=<value>` in backquotes\n\nSigned-off-by: Junio C Hamano <gitster@pobox.com>\nHelped-by: Jean-Noël Avila <jn.avila@free.fr>\n---\n Documentation/git-var.adoc        |  6 +++---\n Documentation/git-write-tree.adoc | 18 +++++++++---------\n 2 files changed, 12 insertions(+), 12 deletions(-)\n\ndiff --git a/Documentation/git-var.adoc b/Documentation/git-var.adoc\nindex 0680568dfd..909963b1c2 100644\n--- a/Documentation/git-var.adoc\n+++ b/Documentation/git-var.adoc\n@@ -8,8 +8,8 @@ git-var - Show a Git logical variable\n \n SYNOPSIS\n --------\n-[verse]\n-'git var' (-l | <variable>)\n+[synopsis]\n+git var (-l | <variable>)\n \n DESCRIPTION\n -----------\n@@ -18,7 +18,7 @@ no value.\n \n OPTIONS\n -------\n--l::\n+`-l`::\n \tDisplay the logical variables. In addition, all the\n \tvariables of the Git configuration file .git/config are listed\n \tas well. (However, the configuration variables listing functionality\ndiff --git a/Documentation/git-write-tree.adoc b/Documentation/git-write-tree.adoc\nindex f22041a9dc..4c7100ea1e 100644\n--- a/Documentation/git-write-tree.adoc\n+++ b/Documentation/git-write-tree.adoc\n@@ -8,8 +8,8 @@ git-write-tree - Create a tree object from the current index\n \n SYNOPSIS\n --------\n-[verse]\n-'git write-tree' [--missing-ok] [--prefix=<prefix>/]\n+[synopsis]\n+git write-tree [--missing-ok] [--prefix=<prefix>/]\n \n DESCRIPTION\n -----------\n@@ -18,23 +18,23 @@ tree object is printed to standard output.\n \n The index must be in a fully merged state.\n \n-Conceptually, 'git write-tree' sync()s the current index contents\n+Conceptually, `git write-tree` sync()s the current index contents\n into a set of tree files.\n In order to have that match what is actually in your directory right\n-now, you need to have done a 'git update-index' phase before you did the\n-'git write-tree'.\n+now, you need to have done a `git update-index` phase before you did the\n+`git write-tree`.\n \n \n OPTIONS\n -------\n---missing-ok::\n-\tNormally 'git write-tree' ensures that the objects referenced by the\n+`--missing-ok`::\n+\tNormally `git write-tree` ensures that the objects referenced by the\n \tdirectory exist in the object database.  This option disables this\n \tcheck.\n \n---prefix=<prefix>/::\n+`--prefix=<prefix>/`::\n \tWrites a tree object that represents a subdirectory\n-\t`<prefix>`.  This can be used to write the tree object\n+\t_<prefix>_.  This can be used to write the tree object\n \tfor a subproject that is in the named subdirectory.\n \n GIT\n-- \n2.48.0\n\n"},{"id":"517731","messageId":"20250510123346.20927-4-jn.avila@free.fr","threadId":"63380","inReplyTo":"20250510123346.20927-1-jn.avila@free.fr","subject":"[PATCH v3 3/4] git-verify-* doc: update mark-up of synopsis option descriptions","fromName":"Jean-Noël Avila","fromEmail":"jn.avila@free.fr","sentAt":"2025-05-10T12:33:16Z","receivedAt":"2025-05-10T12:34:50Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: Junio C Hamano <gitster@pobox.com>\n\nTo unify mark-up used in our documentation to a newer convention,\nstarted by 22293895 (doc: apply synopsis simplification on git-clone\nand git-init, 2024-09-24), update the documentation pages for 'git\nverify-commit', 'git verify-tag', and 'git verify-pack' to\n\n * use [synopsis], not [verse] in the SYNOPSIS section\n * enclose `--option=<value>` in backquotes\n * do not describe non-option arguments in the OPTIONS section\n\nSigned-off-by: Junio C Hamano <gitster@pobox.com>\nHelped-by: Jean-Noël Avila <jn.avila@free.fr>\n---\n Documentation/git-verify-commit.adoc | 16 +++++++---------\n Documentation/git-verify-pack.adoc   | 28 ++++++++++++----------------\n Documentation/git-verify-tag.adoc    | 16 +++++++---------\n 3 files changed, 26 insertions(+), 34 deletions(-)\n\ndiff --git a/Documentation/git-verify-commit.adoc b/Documentation/git-verify-commit.adoc\nindex aee4c40eac..ff5b8b97ef 100644\n--- a/Documentation/git-verify-commit.adoc\n+++ b/Documentation/git-verify-commit.adoc\n@@ -7,26 +7,24 @@ git-verify-commit - Check the GPG signature of commits\n \n SYNOPSIS\n --------\n-[verse]\n-'git verify-commit' [-v | --verbose] [--raw] <commit>...\n+[synopsis]\n+git verify-commit [-v | --verbose] [--raw] <commit>...\n \n DESCRIPTION\n -----------\n-Validates the GPG signature created by 'git commit -S'.\n+Validates the GPG signature created by `git commit -S`\n+on the commit objects given on the command line.\n \n OPTIONS\n -------\n---raw::\n+`--raw`::\n \tPrint the raw gpg status output to standard error instead of the normal\n \thuman-readable output.\n \n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tPrint the contents of the commit object before validating it.\n \n-<commit>...::\n-\tSHA-1 identifiers of Git commit objects.\n-\n GIT\n ---\n Part of the linkgit:git[1] suite\ndiff --git a/Documentation/git-verify-pack.adoc b/Documentation/git-verify-pack.adoc\nindex d7e886918a..b0462d8db3 100644\n--- a/Documentation/git-verify-pack.adoc\n+++ b/Documentation/git-verify-pack.adoc\n@@ -8,43 +8,39 @@ git-verify-pack - Validate packed Git archive files\n \n SYNOPSIS\n --------\n-[verse]\n-'git verify-pack' [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...\n+[synopsis]\n+git verify-pack [-v | --verbose] [-s | --stat-only] [--] <pack>.idx...\n \n \n DESCRIPTION\n -----------\n-Reads given idx file for packed Git archive created with the\n-'git pack-objects' command and verifies the idx file and the\n-corresponding pack file.\n+Read each idx file for packed Git archive given on the command line,\n+and verify the idx file and the corresponding pack file.\n \n OPTIONS\n -------\n-<pack>.idx ...::\n-\tThe idx files to verify.\n-\n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tAfter verifying the pack, show the list of objects contained\n \tin the pack and a histogram of delta chain length.\n \n--s::\n---stat-only::\n+`-s`::\n+`--stat-only`::\n \tDo not verify the pack contents; only show the histogram of delta\n \tchain length.  With `--verbose`, the list of objects is also shown.\n \n-\\--::\n+`--`::\n \tDo not interpret any more arguments as options.\n \n OUTPUT FORMAT\n -------------\n-When specifying the -v option the format used is:\n+When specifying the `-v` option the format used is:\n \n-\tSHA-1 type size size-in-packfile offset-in-packfile\n+\tobject-name type size size-in-packfile offset-in-packfile\n \n for objects that are not deltified in the pack, and\n \n-\tSHA-1 type size size-in-packfile offset-in-packfile depth base-SHA-1\n+\tobject-name type size size-in-packfile offset-in-packfile depth base-object-name\n \n for objects that are deltified.\n \ndiff --git a/Documentation/git-verify-tag.adoc b/Documentation/git-verify-tag.adoc\nindex 81d50ecc4c..b3721a86f4 100644\n--- a/Documentation/git-verify-tag.adoc\n+++ b/Documentation/git-verify-tag.adoc\n@@ -7,26 +7,24 @@ git-verify-tag - Check the GPG signature of tags\n \n SYNOPSIS\n --------\n-[verse]\n-'git verify-tag' [-v | --verbose] [--format=<format>] [--raw] <tag>...\n+[synopsis]\n+git verify-tag [-v | --verbose] [--format=<format>] [--raw] <tag>...\n \n DESCRIPTION\n -----------\n-Validates the gpg signature created by 'git tag'.\n+Validates the gpg signature created by `git tag` in the tag\n+objects listed on the command line.\n \n OPTIONS\n -------\n---raw::\n+`--raw`::\n \tPrint the raw gpg status output to standard error instead of the normal\n \thuman-readable output.\n \n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tPrint the contents of the tag object before validating it.\n \n-<tag>...::\n-\tSHA-1 identifiers of Git tag objects.\n-\n GIT\n ---\n Part of the linkgit:git[1] suite\n-- \n2.48.0\n\n"},{"id":"517732","messageId":"20250510123346.20927-5-jn.avila@free.fr","threadId":"63380","inReplyTo":"20250510123346.20927-1-jn.avila@free.fr","subject":"[PATCH v3 4/4] git-var doc: fix usage of $ENV_VAR vs ENV_VAR","fromName":"Jean-Noël Avila","fromEmail":"jn.avila@free.fr","sentAt":"2025-05-10T12:33:17Z","receivedAt":"2025-05-10T12:34:53Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"When refering to environment variables in the documentation, use the\nENV_VARIABLE format instead of $ENV_VARIABLE. The latter is used in the\ndocumentation to refer to the actual value of the variable, not the name\nof the variable.\n\nSigned-off-by: Jean-Noël Avila <jn.avila@free.fr>\n---\n Documentation/git-var.adoc | 40 ++++++++++++++++++--------------------\n 1 file changed, 19 insertions(+), 21 deletions(-)\n\ndiff --git a/Documentation/git-var.adoc b/Documentation/git-var.adoc\nindex 909963b1c2..b606c2d649 100644\n--- a/Documentation/git-var.adoc\n+++ b/Documentation/git-var.adoc\n@@ -32,58 +32,56 @@ EXAMPLES\n \n VARIABLES\n ---------\n-GIT_AUTHOR_IDENT::\n+`GIT_AUTHOR_IDENT`::\n     The author of a piece of code.\n \n-GIT_COMMITTER_IDENT::\n+`GIT_COMMITTER_IDENT`::\n     The person who put a piece of code into Git.\n \n-GIT_EDITOR::\n+`GIT_EDITOR`::\n     Text editor for use by Git commands.  The value is meant to be\n     interpreted by the shell when it is used.  Examples: `~/bin/vi`,\n     `$SOME_ENVIRONMENT_VARIABLE`, `\"C:\\Program Files\\Vim\\gvim.exe\"\n-    --nofork`.  The order of preference is the `$GIT_EDITOR`\n-    environment variable, then `core.editor` configuration, then\n-    `$VISUAL`, then `$EDITOR`, and then the default chosen at compile\n+    --nofork`.  The order of preference is `$GIT_EDITOR`, then\n+    `core.editor` configuration value, then `$VISUAL`, then\n+    `$EDITOR`, and then the default chosen at compile\n     time, which is usually 'vi'.\n ifdef::git-default-editor[]\n     The build you are using chose '{git-default-editor}' as the default.\n endif::git-default-editor[]\n \n-GIT_SEQUENCE_EDITOR::\n+`GIT_SEQUENCE_EDITOR`::\n     Text editor used to edit the 'todo' file while running `git rebase\n     -i`. Like `GIT_EDITOR`, the value is meant to be interpreted by\n-    the shell when it is used. The order of preference is the\n-    `$GIT_SEQUENCE_EDITOR` environment variable, then\n-    `sequence.editor` configuration, and then the value of `git var\n-    GIT_EDITOR`.\n+    the shell when it is used. The order of preference is\n+    `$GIT_SEQUENCE_EDITOR`, then `sequence.editor` configuration value,\n+    and then the value of `git var GIT_EDITOR`.\n \n-GIT_PAGER::\n+`GIT_PAGER`::\n     Text viewer for use by Git commands (e.g., 'less').  The value\n     is meant to be interpreted by the shell.  The order of preference\n-    is the `$GIT_PAGER` environment variable, then `core.pager`\n-    configuration, then `$PAGER`, and then the default chosen at\n-    compile time (usually 'less').\n+    is `$GIT_PAGER`, then the value of `core.pager` configuration, then\n+    `$PAGER`, and then the default chosen at compile time (usually `less`).\n ifdef::git-default-pager[]\n     The build you are using chose '{git-default-pager}' as the default.\n endif::git-default-pager[]\n \n-GIT_DEFAULT_BRANCH::\n+`GIT_DEFAULT_BRANCH`::\n     The name of the first branch created in newly initialized repositories.\n \n-GIT_SHELL_PATH::\n+`GIT_SHELL_PATH`::\n     The path of the binary providing the POSIX shell for commands which use the shell.\n \n-GIT_ATTR_SYSTEM::\n+`GIT_ATTR_SYSTEM`::\n     The path to the system linkgit:gitattributes[5] file, if one is enabled.\n \n-GIT_ATTR_GLOBAL::\n+`GIT_ATTR_GLOBAL`::\n     The path to the global (per-user) linkgit:gitattributes[5] file.\n \n-GIT_CONFIG_SYSTEM::\n+`GIT_CONFIG_SYSTEM`::\n     The path to the system configuration file, if one is enabled.\n \n-GIT_CONFIG_GLOBAL::\n+`GIT_CONFIG_GLOBAL`::\n     The path to the global (per-user) configuration files, if any.\n \n Most path values contain only one value. However, some can contain multiple\n-- \n2.48.0\n\n"}]}