{"thread":{"id":"61133","subject":"[PATCH 0/2] Doc fixes","startedAt":"2024-03-16T15:21:45Z","lastAt":"2024-03-16T15:50:26Z","messageCount":4,"participants":["Jean-Noël Avila via GitGitGadget","Taylor Blau"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"490778","messageId":"pull.1697.git.1710602501.gitgitgadget@gmail.com","threadId":"61133","inReplyTo":null,"subject":"[PATCH 0/2] Doc fixes","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-16T15:21:39Z","receivedAt":"2024-03-16T15:21:45Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"While translating this session, some translators and I found inconsistencies\nin the manpages text. The fixes were grouped together in this series.\n\nJean-Noël Avila (2):\n doc: format alternatives in synopsis\n doc: fix some placeholders formating\n\n Documentation/fetch-options.txt | 2 +-\n Documentation/git-interpret-trailers.txt | 6 +++---\n Documentation/git-pull.txt | 4 ++--\n Documentation/git-rebase.txt | 2 +-\n Documentation/git-send-email.txt | 8 +++++---\n Documentation/git.txt | 2 +-\n Documentation/rev-list-options.txt | 6 +++---\n builtin/interpret-trailers.c | 2 +-\n 8 files changed, 17 insertions(+), 15 deletions(-)\n\n\nbase-commit: 4f9b731bdeccffa1b13e5edf4bc0428b8d49704e\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-1697%2Fjnavila%2Fdoc_fixes-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1697/jnavila/doc_fixes-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/1697\n-- \ngitgitgadget\n"},{"id":"490779","messageId":"2b016b82ab797e95e4acb3dc1ba7010296ac84ca.1710602501.git.gitgitgadget@gmail.com","threadId":"61133","inReplyTo":"pull.1697.git.1710602501.gitgitgadget@gmail.com","subject":"[PATCH 1/2] doc: format alternatives in synopsis","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-16T15:21:40Z","receivedAt":"2024-03-16T15:21:46Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= \n\nThis is a list of various fixes on malformed alternative in commands\nand option syntax.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/fetch-options.txt | 2 +-\n Documentation/git-pull.txt | 4 ++--\n Documentation/git-rebase.txt | 2 +-\n Documentation/git-send-email.txt | 8 +++++---\n 4 files changed, 9 insertions(+), 7 deletions(-)\n\ndiff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt\nindex 54ebb4452e9..e22b217fba9 100644\n--- a/Documentation/fetch-options.txt\n+++ b/Documentation/fetch-options.txt\n@@ -202,7 +202,7 @@ endif::git-pull[]\n \tdestination of an explicit refspec; see `--prune`).\n \n ifndef::git-pull[]\n---recurse-submodules[=yes|on-demand|no]::\n+--recurse-submodules[=(yes|on-demand|no)]::\n \tThis option controls if and under what conditions new commits of\n \tsubmodules should be fetched too. When recursing through submodules,\n \t`git fetch` always attempts to fetch \"changed\" submodules, that is, a\ndiff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt\nindex 0e14f8b5b25..b2ae496e488 100644\n--- a/Documentation/git-pull.txt\n+++ b/Documentation/git-pull.txt\n@@ -87,7 +87,7 @@ OPTIONS\n --verbose::\n \tPass --verbose to git-fetch and git-merge.\n \n---[no-]recurse-submodules[=yes|on-demand|no]::\n+--[no-]recurse-submodules[=(yes|on-demand|no)]::\n \tThis option controls if new commits of populated submodules should\n \tbe fetched, and if the working trees of active submodules should be\n \tupdated, too (see linkgit:git-fetch[1], linkgit:git-config[1] and\n@@ -105,7 +105,7 @@ Options related to merging\n include::merge-options.txt[]\n \n -r::\n---rebase[=false|true|merges|interactive]::\n+--rebase[=(false|true|merges|interactive)]::\n \tWhen true, rebase the current branch on top of the upstream\n \tbranch after fetching. If there is a remote-tracking branch\n \tcorresponding to the upstream branch and the upstream branch\ndiff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt\nindex e7e725044db..03d5e9936a0 100644\n--- a/Documentation/git-rebase.txt\n+++ b/Documentation/git-rebase.txt\n@@ -12,7 +12,7 @@ SYNOPSIS\n \t[--onto | --keep-base] [ []]\n 'git rebase' [-i | --interactive] [] [--exec ] [--onto ]\n \t--root []\n-'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)\n+'git rebase' (--continue|--skip|--abort|--quit|--edit-todo|--show-current-patch)\n \n DESCRIPTION\n -----------\ndiff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt\nindex 8264f873809..c5d664f4519 100644\n--- a/Documentation/git-send-email.txt\n+++ b/Documentation/git-send-email.txt\n@@ -9,7 +9,7 @@ git-send-email - Send a collection of patches as emails\n SYNOPSIS\n --------\n [verse]\n-'git send-email' [] ...\n+'git send-email' [] (|)...\n 'git send-email' [] \n 'git send-email' --dump-aliases\n \n@@ -278,7 +278,7 @@ must be used for each option.\n \tif a username is not specified (with `--smtp-user` or `sendemail.smtpUser`),\n \tthen authentication is not attempted.\n \n---smtp-debug=0|1::\n+--smtp-debug=(0|1)::\n \tEnable (1) or disable (0) debug output. If enabled, SMTP\n \tcommands and replies will be printed. Useful to debug TLS\n \tconnection and authentication problems.\n@@ -301,7 +301,9 @@ must be used for each option.\n Automating\n ~~~~~~~~~~\n \n---no-[to|cc|bcc]::\n+--no-to::\n+--no-cc::\n+--no-bcc::\n \tClears any list of \"To:\", \"Cc:\", \"Bcc:\" addresses previously\n \tset via config.\n \n-- \ngitgitgadget\n\n"},{"id":"490780","messageId":"6f4e68170391cc123f77a2994f13cfb6e1c3dce3.1710602501.git.gitgitgadget@gmail.com","threadId":"61133","inReplyTo":"pull.1697.git.1710602501.gitgitgadget@gmail.com","subject":"[PATCH 2/2] doc: fix some placeholders formating","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-16T15:21:41Z","receivedAt":"2024-03-16T15:21:47Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= \n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/git-interpret-trailers.txt | 6 +++---\n Documentation/git.txt | 2 +-\n Documentation/rev-list-options.txt | 6 +++---\n builtin/interpret-trailers.c | 2 +-\n 4 files changed, 8 insertions(+), 8 deletions(-)\n\ndiff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt\nindex 418265f044d..d9dfb75fef5 100644\n--- a/Documentation/git-interpret-trailers.txt\n+++ b/Documentation/git-interpret-trailers.txt\n@@ -9,7 +9,7 @@ SYNOPSIS\n --------\n [verse]\n 'git interpret-trailers' [--in-place] [--trim-empty]\n-\t\t\t[(--trailer (|)[(=|:)])...]\n+\t\t\t[(--trailer (|)[(=|:)])...]\n \t\t\t[--parse] [...]\n \n DESCRIPTION\n@@ -67,9 +67,9 @@ key: value\n This means that the trimmed and will be separated by\n `': '` (one colon followed by one space).\n \n-For convenience, a can be configured to make using `--trailer`\n+For convenience, a can be configured to make using `--trailer`\n shorter to type on the command line. This can be configured using the\n-'trailer..key' configuration variable. The must be a prefix\n+'trailer..key' configuration variable. The must be a prefix\n of the full string, although case sensitivity does not matter. For\n example, if you have\n \ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex e6b766d5c3a..7a1b112a3e7 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -960,7 +960,7 @@ will never be returned from the commit-graph at the cost of performance.\n `GIT_PROTOCOL`::\n \tFor internal use only. Used in handshaking the wire protocol.\n \tContains a colon ':' separated list of keys with optional values\n-\t'key[=value]'. Presence of unknown keys and values must be\n+\t'[=]'. Presence of unknown keys and values must be\n \tignored.\n +\n Note that servers may need to be configured to allow this variable to\ndiff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt\nindex 408d9314d08..00ccf687441 100644\n--- a/Documentation/rev-list-options.txt\n+++ b/Documentation/rev-list-options.txt\n@@ -316,12 +316,12 @@ list.\n With `--pretty` format other than `oneline` and `reference` (for obvious reasons),\n this causes the output to have two extra lines of information\n taken from the reflog. The reflog designator in the output may be shown\n-as `ref@{Nth}` (where `Nth` is the reverse-chronological index in the\n-reflog) or as `ref@{timestamp}` (with the timestamp for that entry),\n+as `ref@{}` (where __ is the reverse-chronological index in the\n+reflog) or as `ref@{}` (with the __ for that entry),\n depending on a few rules:\n +\n --\n-1. If the starting point is specified as `ref@{Nth}`, show the index\n+1. If the starting point is specified as `ref@{}`, show the index\n format.\n +\n 2. If the starting point was specified as `ref@{now}`, show the\ndiff --git a/builtin/interpret-trailers.c b/builtin/interpret-trailers.c\nindex 11f4ce9e4a2..8768bfea3c4 100644\n--- a/builtin/interpret-trailers.c\n+++ b/builtin/interpret-trailers.c\n@@ -15,7 +15,7 @@\n \n static const char * const git_interpret_trailers_usage[] = {\n \tN_(\"git interpret-trailers [--in-place] [--trim-empty]\\n\"\n-\t \" [(--trailer (|)[(=|:)])...]\\n\"\n+\t \" [(--trailer (|)[(=|:)])...]\\n\"\n \t \" [--parse] [...]\"),\n \tNULL\n };\n-- \ngitgitgadget\n"},{"id":"490782","messageId":"ZfW/wOm/nqoz8emO@nand.local","threadId":"61133","inReplyTo":"pull.1697.git.1710602501.gitgitgadget@gmail.com","subject":"Re: [PATCH 0/2] Doc fixes","fromName":"Taylor Blau","fromEmail":"me@ttaylorr.com","sentAt":"2024-03-16T15:50:24Z","receivedAt":"2024-03-16T15:50:26Z","isPatch":true,"sender":{"key":"me@ttaylorr.com","avatar":"https://avatars.githubusercontent.com/u/301000140?v=4"},"body":"On Sat, Mar 16, 2024 at 03:21:39PM +0000, Jean-Noël Avila via GitGitGadget wrote:\n> While translating this session, some translators and I found inconsistencies\n> in the manpages text. The fixes were grouped together in this series.\n>\n> Jean-Noël Avila (2):\n> doc: format alternatives in synopsis\n> doc: fix some placeholders formating\n\nBoth look great, thanks.\n\n Acked-by: Taylor Blau \n\nThanks,\nTaylor\n"}]}