From patchwork Sat Nov 6 18:48:49 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Jean-No=C3=ABl_Avila?= X-Patchwork-Id: 12606493 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C7573C433EF for ; Sat, 6 Nov 2021 18:49:34 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id A5974611C0 for ; Sat, 6 Nov 2021 18:49:34 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234080AbhKFSwO (ORCPT ); Sat, 6 Nov 2021 14:52:14 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:32972 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234266AbhKFSwN (ORCPT ); Sat, 6 Nov 2021 14:52:13 -0400 Received: from smtp4-g21.free.fr (smtp4-g21.free.fr [IPv6:2a01:e0c:1:1599::13]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 969A5C061205 for ; Sat, 6 Nov 2021 11:49:31 -0700 (PDT) Received: from localhost.localdomain (unknown [IPv6:2a01:e0a:d1:f360:9225:6fd8:b89b:1501]) by smtp4-g21.free.fr (Postfix) with ESMTP id 1EF0919F4F3; Sat, 6 Nov 2021 19:49:27 +0100 (CET) From: =?utf-8?q?Jean-No=C3=ABl_Avila?= To: git@vger.kernel.org Cc: =?utf-8?q?Jean-No=C3=ABl_Avila?= , Junio C Hamano Subject: [PATCH v3 01/10] doc: fix git credential synopsis Date: Sat, 6 Nov 2021 19:48:49 +0100 Message-Id: <20211106184858.11500-2-jn.avila@free.fr> X-Mailer: git-send-email 2.33.1 In-Reply-To: <20211106184858.11500-1-jn.avila@free.fr> References: <20211106184858.11500-1-jn.avila@free.fr> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The subcommand of git credential is not optional. Signed-off-by: Jean-Noël Avila Signed-off-by: Junio C Hamano --- Documentation/git-credential.txt | 2 +- builtin/credential.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/git-credential.txt b/Documentation/git-credential.txt index 206e3c5f40..f18673017f 100644 --- a/Documentation/git-credential.txt +++ b/Documentation/git-credential.txt @@ -8,7 +8,7 @@ git-credential - Retrieve and store user credentials SYNOPSIS -------- ------------------ -git credential +'git credential' (fill|approve|reject) ------------------ DESCRIPTION diff --git a/builtin/credential.c b/builtin/credential.c index d75dcdc64a..d7b304fa08 100644 --- a/builtin/credential.c +++ b/builtin/credential.c @@ -4,7 +4,7 @@ #include "config.h" static const char usage_msg[] = - "git credential [fill|approve|reject]"; + "git credential (fill|approve|reject)"; int cmd_credential(int argc, const char **argv, const char *prefix) { From patchwork Sat Nov 6 18:48:50 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Jean-No=C3=ABl_Avila?= X-Patchwork-Id: 12606495 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id F1BABC433EF for ; Sat, 6 Nov 2021 18:49:36 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id CDC56611C0 for ; Sat, 6 Nov 2021 18:49:36 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234558AbhKFSwQ (ORCPT ); Sat, 6 Nov 2021 14:52:16 -0400 Received: from smtp4-g21.free.fr ([212.27.42.4]:63708 "EHLO smtp4-g21.free.fr" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234266AbhKFSwQ (ORCPT ); Sat, 6 Nov 2021 14:52:16 -0400 Received: from localhost.localdomain (unknown [IPv6:2a01:e0a:d1:f360:9225:6fd8:b89b:1501]) by smtp4-g21.free.fr (Postfix) with ESMTP id 5E94C19F57E; Sat, 6 Nov 2021 19:49:30 +0100 (CET) From: =?utf-8?q?Jean-No=C3=ABl_Avila?= To: git@vger.kernel.org Cc: =?utf-8?q?Jean-No=C3=ABl_Avila?= , Junio C Hamano Subject: [PATCH v3 02/10] doc: split placeholders as individual tokens Date: Sat, 6 Nov 2021 19:48:50 +0100 Message-Id: <20211106184858.11500-3-jn.avila@free.fr> X-Mailer: git-send-email 2.33.1 In-Reply-To: <20211106184858.11500-1-jn.avila@free.fr> References: <20211106184858.11500-1-jn.avila@free.fr> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The placeholders represent atoms of tokens and must not be aggregates. Signed-off-by: Jean-Noël Avila Signed-off-by: Junio C Hamano --- Documentation/git-archimport.txt | 14 +++++++------- Documentation/git-p4.txt | 2 +- Documentation/git-web--browse.txt | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt index a595a0ffee..847777fd17 100644 --- a/Documentation/git-archimport.txt +++ b/Documentation/git-archimport.txt @@ -9,14 +9,14 @@ git-archimport - Import a GNU Arch repository into Git SYNOPSIS -------- [verse] -'git archimport' [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir] - [:] ... +'git archimport' [-h] [-v] [-o] [-a] [-f] [-T] [-D ] [-t ] + /[:]... DESCRIPTION ----------- Imports a project from one or more GNU Arch repositories. It will follow branches -and repositories within the namespaces defined by the +and repositories within the namespaces defined by the / parameters supplied. If it cannot find the remote branch a merge comes from it will just import it as a regular commit. If it can find it, it will mark it as a merge whenever possible (see discussion below). @@ -27,7 +27,7 @@ import new branches within the provided roots. It expects to be dealing with one project only. If it sees branches that have different roots, it will refuse to run. In that case, -edit your parameters to define clearly the scope of the +edit your / parameters to define clearly the scope of the import. 'git archimport' uses `tla` extensively in the background to access the @@ -42,7 +42,7 @@ incremental imports. While 'git archimport' will try to create sensible branch names for the archives that it imports, it is also possible to specify Git branch names -manually. To do so, write a Git branch name after each +manually. To do so, write a Git branch name after each / parameter, separated by a colon. This way, you can shorten the Arch branch names and convert Arch jargon to Git jargon, for example mapping a "PROJECT{litdd}devo{litdd}VERSION" branch to "master". @@ -104,8 +104,8 @@ OPTIONS Override the default tempdir. -:: - Archive/branch identifier in a format that `tla log` understands. +/:: + / identifier in a format that `tla log` understands. GIT diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt index 38e5257b2a..8a6addcf72 100644 --- a/Documentation/git-p4.txt +++ b/Documentation/git-p4.txt @@ -361,7 +361,7 @@ These options can be used to modify 'git p4 submit' behavior. p4/master. See the "Sync options" section above for more information. ---commit |:: +--commit (|..):: Submit only the specified commit or range of commits, instead of the full list of changes that are in the current Git branch. diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt index 8d162b56c5..f2f996cbe1 100644 --- a/Documentation/git-web--browse.txt +++ b/Documentation/git-web--browse.txt @@ -8,7 +8,7 @@ git-web--browse - Git helper script to launch a web browser SYNOPSIS -------- [verse] -'git web{litdd}browse' [] ... +'git web{litdd}browse' [] (|)... DESCRIPTION ----------- From patchwork Sat Nov 6 18:48:51 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Jean-No=C3=ABl_Avila?= X-Patchwork-Id: 12606497 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id D38E6C433EF for ; Sat, 6 Nov 2021 18:49:40 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id BA6B1611EE for ; Sat, 6 Nov 2021 18:49:40 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234737AbhKFSwU (ORCPT ); Sat, 6 Nov 2021 14:52:20 -0400 Received: from smtp4-g21.free.fr ([212.27.42.4]:64126 "EHLO smtp4-g21.free.fr" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234059AbhKFSwT (ORCPT ); Sat, 6 Nov 2021 14:52:19 -0400 Received: from localhost.localdomain (unknown [IPv6:2a01:e0a:d1:f360:9225:6fd8:b89b:1501]) by smtp4-g21.free.fr (Postfix) with ESMTP id 928DA19F4B5; Sat, 6 Nov 2021 19:49:33 +0100 (CET) From: =?utf-8?q?Jean-No=C3=ABl_Avila?= To: git@vger.kernel.org Cc: =?utf-8?q?Jean-No=C3=ABl_Avila?= , Junio C Hamano Subject: [PATCH v3 03/10] doc: express grammar placeholders between angle brackets Date: Sat, 6 Nov 2021 19:48:51 +0100 Message-Id: <20211106184858.11500-4-jn.avila@free.fr> X-Mailer: git-send-email 2.33.1 In-Reply-To: <20211106184858.11500-1-jn.avila@free.fr> References: <20211106184858.11500-1-jn.avila@free.fr> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org This discerns user inputs from verbatim options in the synopsis. Signed-off-by: Jean-Noël Avila Signed-off-by: Junio C Hamano --- Documentation/git-cherry-pick.txt | 6 ++-- Documentation/git-config.txt | 46 +++++++++++++-------------- Documentation/git-cvsexportcommit.txt | 4 +-- Documentation/git-gui.txt | 2 +- Documentation/git-help.txt | 6 ++-- Documentation/git-http-fetch.txt | 2 +- Documentation/git-init.txt | 2 +- Documentation/git-pack-objects.txt | 4 +-- Documentation/git-pack-redundant.txt | 2 +- Documentation/git-reflog.txt | 4 +-- Documentation/git-sparse-checkout.txt | 2 +- Documentation/git-stage.txt | 2 +- 12 files changed, 41 insertions(+), 41 deletions(-) diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt index 5d750314b2..78dcc9171f 100644 --- a/Documentation/git-cherry-pick.txt +++ b/Documentation/git-cherry-pick.txt @@ -8,7 +8,7 @@ git-cherry-pick - Apply the changes introduced by some existing commits SYNOPSIS -------- [verse] -'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff] +'git cherry-pick' [--edit] [-n] [-m ] [-s] [-x] [--ff] [-S[]] ... 'git cherry-pick' (--continue | --skip | --abort | --quit) @@ -81,8 +81,8 @@ OPTIONS described above, and `-r` was to disable it. Now the default is not to do `-x` so this option is a no-op. --m parent-number:: ---mainline parent-number:: +-m :: +--mainline :: Usually you cannot cherry-pick a merge because you do not know which side of the merge should be considered the mainline. This option specifies the parent number (starting from 1) of diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index 992225f612..2285effb36 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -9,20 +9,20 @@ git-config - Get and set repository or global options SYNOPSIS -------- [verse] -'git config' [] [--type=] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] name [value [value-pattern]] -'git config' [] [--type=] --add name value -'git config' [] [--type=] [--fixed-value] --replace-all name value [value-pattern] -'git config' [] [--type=] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get name [value-pattern] -'git config' [] [--type=] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all name [value-pattern] -'git config' [] [--type=] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp name_regex [value-pattern] -'git config' [] [--type=] [-z|--null] --get-urlmatch name URL -'git config' [] [--fixed-value] --unset name [value-pattern] -'git config' [] [--fixed-value] --unset-all name [value-pattern] -'git config' [] --rename-section old_name new_name -'git config' [] --remove-section name +'git config' [] [--type=] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] [ []] +'git config' [] [--type=] --add +'git config' [] [--type=] [--fixed-value] --replace-all [] +'git config' [] [--type=] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get [] +'git config' [] [--type=] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all [] +'git config' [] [--type=] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp [] +'git config' [] [--type=] [-z|--null] --get-urlmatch +'git config' [] [--fixed-value] --unset [] +'git config' [] [--fixed-value] --unset-all [] +'git config' [] --rename-section +'git config' [] --remove-section 'git config' [] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list -'git config' [] --get-color name [default] -'git config' [] --get-colorbool name [stdout-is-tty] +'git config' [] --get-color [] +'git config' [] --get-colorbool [] 'git config' [] -e | --edit DESCRIPTION @@ -102,9 +102,9 @@ OPTIONS in which section and variable names are lowercased, but subsection names are not. ---get-urlmatch name URL:: +--get-urlmatch :: When given a two-part name section.key, the value for - section..key whose part matches the best to the + section..key whose part matches the best to the given URL is returned (if no such key exists, the value for section.key is used as a fallback). When given just the section as name, do so for all the keys in the section and @@ -145,8 +145,8 @@ See also <>. read from or written to if `extensions.worktreeConfig` is present. If not it's the same as `--local`. --f config-file:: ---file config-file:: +-f :: +--file :: For writing options: write to the specified file rather than the repository `.git/config`. + @@ -155,7 +155,7 @@ available files. + See also <>. ---blob blob:: +--blob :: Similar to `--file` but use the given blob instead of a file. E.g. you can use 'master:.gitmodules' to read values from the file '.gitmodules' in the master branch. See "SPECIFYING REVISIONS" @@ -246,18 +246,18 @@ Valid ``'s include: all queried config options with the scope of that value (local, global, system, command). ---get-colorbool name [stdout-is-tty]:: +--get-colorbool []:: - Find the color setting for `name` (e.g. `color.diff`) and output - "true" or "false". `stdout-is-tty` should be either "true" or + Find the color setting for `` (e.g. `color.diff`) and output + "true" or "false". `` should be either "true" or "false", and is taken into account when configuration says - "auto". If `stdout-is-tty` is missing, then checks the standard + "auto". If `` is missing, then checks the standard output of the command itself, and exits with status 0 if color is to be used, or exits with status 1 otherwise. When the color setting for `name` is undefined, the command uses `color.ui` as fallback. ---get-color name [default]:: +--get-color []:: Find the color configured for `name` (e.g. `color.diff.new`) and output it as the ANSI color escape sequence to the standard diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt index 00154b6c85..41c8a8a05c 100644 --- a/Documentation/git-cvsexportcommit.txt +++ b/Documentation/git-cvsexportcommit.txt @@ -9,8 +9,8 @@ git-cvsexportcommit - Export a single commit to a CVS checkout SYNOPSIS -------- [verse] -'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot] - [-w cvsworkdir] [-W] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID +'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d ] + [-w ] [-W] [-f] [-m ] [] DESCRIPTION diff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt index c9d7e96214..e8f3ccb433 100644 --- a/Documentation/git-gui.txt +++ b/Documentation/git-gui.txt @@ -8,7 +8,7 @@ git-gui - A portable graphical interface to Git SYNOPSIS -------- [verse] -'git gui' [] [arguments] +'git gui' [] [] DESCRIPTION ----------- diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 96d5f598b4..44ea63cc6d 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -9,14 +9,14 @@ SYNOPSIS -------- [verse] 'git help' [-a|--all [--[no-]verbose]] - [[-i|--info] [-m|--man] [-w|--web]] [COMMAND|GUIDE] + [[-i|--info] [-m|--man] [-w|--web]] [|] 'git help' [-g|--guides] 'git help' [-c|--config] DESCRIPTION ----------- -With no options and no COMMAND or GUIDE given, the synopsis of the 'git' +With no options and no '' or '' given, the synopsis of the 'git' command and a list of the most commonly used Git commands are printed on the standard output. @@ -33,7 +33,7 @@ variables. If an alias is given, git shows the definition of the alias on standard output. To get the manual page for the aliased command, use -`git COMMAND --help`. +`git --help`. Note that `git --help ...` is identical to `git help ...` because the former is internally converted into the latter. diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt index 9fa17b60e4..fa4bb6cbc3 100644 --- a/Documentation/git-http-fetch.txt +++ b/Documentation/git-http-fetch.txt @@ -9,7 +9,7 @@ git-http-fetch - Download from a remote Git repository via HTTP SYNOPSIS -------- [verse] -'git http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] [--stdin | --packfile= | ] +'git http-fetch' [-c] [-t] [-a] [-d] [-v] [-w ] [--recover] [--stdin | --packfile= | ] DESCRIPTION ----------- diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index b611d80697..7781d0b354 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -12,7 +12,7 @@ SYNOPSIS 'git init' [-q | --quiet] [--bare] [--template=] [--separate-git-dir ] [--object-format=] [-b | --initial-branch=] - [--shared[=]] [directory] + [--shared[=]] [] DESCRIPTION diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt index dbfd1f9017..f8344e1e5b 100644 --- a/Documentation/git-pack-objects.txt +++ b/Documentation/git-pack-objects.txt @@ -13,8 +13,8 @@ SYNOPSIS [--no-reuse-delta] [--delta-base-offset] [--non-empty] [--local] [--incremental] [--window=] [--depth=] [--revs [--unpacked | --all]] [--keep-pack=] - [--stdout [--filter=] | base-name] - [--shallow] [--keep-true-parents] [--[no-]sparse] < object-list + [--stdout [--filter=] | ] + [--shallow] [--keep-true-parents] [--[no-]sparse] < DESCRIPTION diff --git a/Documentation/git-pack-redundant.txt b/Documentation/git-pack-redundant.txt index f2869da572..ee7034b5e5 100644 --- a/Documentation/git-pack-redundant.txt +++ b/Documentation/git-pack-redundant.txt @@ -9,7 +9,7 @@ git-pack-redundant - Find redundant pack files SYNOPSIS -------- [verse] -'git pack-redundant' [ --verbose ] [ --alt-odb ] < --all | .pack filename ... > +'git pack-redundant' [ --verbose ] [ --alt-odb ] ( --all | ... ) DESCRIPTION ----------- diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt index ff487ff77d..5ced7ad4f8 100644 --- a/Documentation/git-reflog.txt +++ b/Documentation/git-reflog.txt @@ -17,12 +17,12 @@ The command takes various subcommands, and different options depending on the subcommand: [verse] -'git reflog' ['show'] [log-options] [] +'git reflog' ['show'] [] [] 'git reflog expire' [--expire=