diff mbox series

[06/34] doc SYNOPSIS: consistently use ' for commands

Message ID	patch-06.34-0b946d60fcc-20220902T092734Z-avarab@gmail.com (mailing list archive)
State	Superseded
Headers	show Return-Path: <git-owner@kernel.org> From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= <avarab@gmail.com> To: git@vger.kernel.org Cc: Junio C Hamano <gitster@pobox.com>, Victoria Dye <vdye@github.com>, Taylor Blau <me@ttaylorr.com>, Emily Shaffer <emilyshaffer@google.com>, Jonathan Nieder <jrnieder@gmail.com>, John Cai <johncai86@gmail.com>, =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= <avarab@gmail.com> Subject: [PATCH 06/34] doc SYNOPSIS: consistently use ' for commands Date: Mon, 5 Sep 2022 10:26:17 +0200 Message-Id: <patch-06.34-0b946d60fcc-20220902T092734Z-avarab@gmail.com> In-Reply-To: <cover-00.34-00000000000-20220902T092734Z-avarab@gmail.com> References: <cover-00.34-00000000000-20220902T092734Z-avarab@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Precedence: bulk
Series	doc/UX: make txt & -h output more consistent \| expand [00/34] doc/UX: make txt & -h output more consistent [01/34] CodingGuidelines: update and clarify command-line conventions [02/34] builtin/bundle.c: use \t, not fix indentation 2-SP indentation [03/34] bundle: define subcommand -h in terms of command -h [04/34] blame: use a more detailed usage_msg_optf() error on bad -L [05/34] doc SYNOPSIS: don't use ' for subcommands [06/34] doc SYNOPSIS: consistently use ' for commands [07/34] doc SYNOPSIS & -h: fix incorrect alternates syntax [08/34] built-ins: consistently add "\n" between "usage" and options [09/34] doc txt & -h consistency: word-wrap [10/34] doc txt & -h consistency: fix incorrect alternates syntax [11/34] doc txt & -h consistency: add "-z" to cat-file "-h" [12/34] doc txt & -h consistency: add missing "]" to bugreport "-h" [13/34] doc txt & -h consistency: correct padding around "[]()" [14/34] stash doc SYNOPSIS & -h: correct padding around "[]()" [15/34] doc txt & -h consistency: use "<options>", not "<options>..." [16/34] t/helper/test-proc-receive.c: use "<options>", not "<options>..." [17/34] doc txt & -h consistency: fix mismatching labels [18/34] doc txt & -h consistency: add or fix optional "--" syntax [19/34] doc txt & -h consistency: make output order consistent [20/34] doc txt & -h consistency: add missing options and labels [21/34] doc txt & -h consistency: make "rerere" consistent [22/34] doc txt & -h consistency: make "read-tree" consistent [23/34] doc txt & -h consistency: make "bundle" consistent [24/34] doc txt & -h consistency: use "git foo" form, not "git-foo" [25/34] doc txt & -h consistency: add missing options [26/34] doc txt & -h consistency: make "stash" consistent [27/34] doc txt & -h consistency: make "annotate" consistent [28/34] doc txt & -h consistency: use "[<label>...]" for "zero or more" [29/34] doc txt & -h consistency: make "diff-tree" consistent [30/34] doc txt & -h consistency: make "commit" consistent [31/34] reflog doc: list real subcommands up-front [32/34] worktree: define subcommand -h in terms of command -h [33/34] doc txt & -h consistency: make "worktree" consistent [34/34] tests: start asserting that *.txt SYNOPSIS matches -h output

Commit Message

Ævar Arnfjörð Bjarmason Sept. 5, 2022, 8:26 a.m. UTC

Most of our commands use ''-quotation only for the name of the command
itself, and not its (optional) arguments. Let's do the same for these.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 Documentation/git-fast-export.txt     | 2 +-
 Documentation/git-sparse-checkout.txt | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff mbox series

Patch

diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt
index 1978dbdc6ad..4643ddbe68f 100644
--- a/Documentation/git-fast-export.txt
+++ b/Documentation/git-fast-export.txt
@@ -9,7 +9,7 @@  git-fast-export - Git data exporter
 SYNOPSIS
 --------
 [verse]
-'git fast-export [<options>]' | 'git fast-import'
+'git fast-export' [<options>] | 'git fast-import'
 
 DESCRIPTION
 -----------
diff --git a/Documentation/git-sparse-checkout.txt b/Documentation/git-sparse-checkout.txt
index 3776705bf53..872436d7426 100644
--- a/Documentation/git-sparse-checkout.txt
+++ b/Documentation/git-sparse-checkout.txt
@@ -9,7 +9,7 @@  git-sparse-checkout - Reduce your working tree to a subset of tracked files
 SYNOPSIS
 --------
 [verse]
-'git sparse-checkout <subcommand> [<options>]'
+'git sparse-checkout' <subcommand> [<options>]
 
 
 DESCRIPTION