[prev in list] [next in list] [prev in thread] [next in thread] 

List:       git
Subject:    Re: [PATCH v3 14/36] doc txt & -h consistency: correct padding around "[]()"
From:       Junio C Hamano <gitster () pobox ! com>
Date:       2022-09-30 21:40:25
Message-ID: xmqqo7uw8rsm.fsf () gitster ! g
[Download RAW message or body]

Ævar Arnfjörð Bjarmason  <avarab@gmail.com> writes:

> The whitespace padding of alternatives should be of the form "[-f |
> --force]" not "[-f|--force]". Likewise we should not have padding
> before the first option, so "(--all | <pack-filename>...)" is correct,
> not "( --all | <pack-filename>... )".
>
> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
> ---
>  Documentation/git-diff-files.txt     | 2 +-
>  Documentation/git-hash-object.txt    | 2 +-
>  Documentation/git-merge-base.txt     | 4 ++--
>  Documentation/git-pack-redundant.txt | 2 +-
>  Documentation/git-prune-packed.txt   | 2 +-
>  Documentation/git-rerere.txt         | 2 +-
>  Documentation/git-send-pack.txt      | 2 +-
>  Documentation/git-show-branch.txt    | 4 ++--
>  Documentation/git-show-ref.txt       | 4 ++--
>  Documentation/git-var.txt            | 2 +-
>  Documentation/git-verify-pack.txt    | 2 +-
>  builtin/bugreport.c                  | 2 +-
>  builtin/commit-graph.c               | 2 +-
>  builtin/diagnose.c                   | 2 +-
>  builtin/sparse-checkout.c            | 2 +-
>  15 files changed, 18 insertions(+), 18 deletions(-)

Consistency is good.

And ...

>  [verse]
> -'git pack-redundant' [ --verbose ] [ --alt-odb ] ( --all | <pack-filename>... )
> +'git pack-redundant' [--verbose] [--alt-odb] (--all | <pack-filename>...)
>  
>  DESCRIPTION
>  -----------
> diff --git a/Documentation/git-prune-packed.txt b/Documentation/git-prune-packed.txt
> index 9fed59a3172..844d6f808a0 100644
> --- a/Documentation/git-prune-packed.txt
> +++ b/Documentation/git-prune-packed.txt
> @@ -9,7 +9,7 @@ git-prune-packed - Remove extra objects that are already in pack files
>  SYNOPSIS
>  --------
>  [verse]
> -'git prune-packed' [-n|--dry-run] [-q|--quiet]
> +'git prune-packed' [-n | --dry-run] [-q | --quiet]

... these show that they are easier to read with the proposed spacing.
[prev in list] [next in list] [prev in thread] [next in thread]