diff mbox series

Documentation: typofix --column description

Message ID xmqqczwvbgqy.fsf@gitster.g (mailing list archive)
State Accepted
Commit d927f6482468ff97ac64219ef6056df83169b765
Headers show
Series Documentation: typofix --column description | expand

Commit Message

Junio C Hamano Feb. 20, 2021, 2:44 a.m. UTC
f4ed0af6 (Merge branch 'nd/columns', 2012-05-03) brought in three
cut-and-pasted copies of malformatted descriptions.  Let's fix them
all the same way by marking the configuration variable names up as
monospace just like the command line option `--column` is typeset.

While we are at it, correct a missing space after the full stop that
ends the sentence.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/git-branch.txt | 2 +-
 Documentation/git-status.txt | 2 +-
 Documentation/git-tag.txt    | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

Comments

Stefan Moch Feb. 20, 2021, 3:09 p.m. UTC | #1
Junio C Hamano wrote:
> f4ed0af6 (Merge branch 'nd/columns', 2012-05-03) brought in three
> cut-and-pasted copies of malformatted descriptions.  Let's fix them
> all the same way by marking the configuration variable names up as
> monospace just like the command line option `--column` is typeset.
>
> While we are at it, correct a missing space after the full stop that
> ends the sentence.
>
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  Documentation/git-branch.txt | 2 +-
>  Documentation/git-status.txt | 2 +-
>  Documentation/git-tag.txt    | 2 +-
>  3 files changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
> index adaa1782a8..5b4b2135a1 100644
> --- a/Documentation/git-branch.txt
> +++ b/Documentation/git-branch.txt
> @@ -153,7 +153,7 @@ OPTIONS
>  --column[=<options>]::
>  --no-column::
>  	Display branch listing in columns. See configuration variable
> -	column.branch for option syntax.`--column` and `--no-column`
> +	`column.branch` for option syntax. `--column` and `--no-column`
>  	without options are equivalent to 'always' and 'never' respectively.
>  +
>  This option is only applicable in non-verbose mode.
> diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
> index c0764e850a..83f38e3198 100644
> --- a/Documentation/git-status.txt
> +++ b/Documentation/git-status.txt
> @@ -130,7 +130,7 @@ ignored, then the directory is not shown, but all contents are shown.
>  --column[=<options>]::
>  --no-column::
>  	Display untracked files in columns. See configuration variable
> -	column.status for option syntax.`--column` and `--no-column`
> +	`column.status` for option syntax. `--column` and `--no-column`
>  	without options are equivalent to 'always' and 'never'
>  	respectively.
>  
> diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
> index 56656d1be6..31a97a1b6c 100644
> --- a/Documentation/git-tag.txt
> +++ b/Documentation/git-tag.txt
> @@ -134,7 +134,7 @@ options for details.
>  --column[=<options>]::
>  --no-column::
>  	Display tag listing in columns. See configuration variable
> -	column.tag for option syntax.`--column` and `--no-column`
> +	`column.tag` for option syntax. `--column` and `--no-column`
>  	without options are equivalent to 'always' and 'never' respectively.
>  +
>  This option is only applicable when listing tags without annotation lines.

Makes sense.

Reviewed-by: Stefan Moch <stefanmoch@mail.de>
diff mbox series

Patch

diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index adaa1782a8..5b4b2135a1 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -153,7 +153,7 @@  OPTIONS
 --column[=<options>]::
 --no-column::
 	Display branch listing in columns. See configuration variable
-	column.branch for option syntax.`--column` and `--no-column`
+	`column.branch` for option syntax. `--column` and `--no-column`
 	without options are equivalent to 'always' and 'never' respectively.
 +
 This option is only applicable in non-verbose mode.
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index c0764e850a..83f38e3198 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -130,7 +130,7 @@  ignored, then the directory is not shown, but all contents are shown.
 --column[=<options>]::
 --no-column::
 	Display untracked files in columns. See configuration variable
-	column.status for option syntax.`--column` and `--no-column`
+	`column.status` for option syntax. `--column` and `--no-column`
 	without options are equivalent to 'always' and 'never'
 	respectively.
 
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 56656d1be6..31a97a1b6c 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -134,7 +134,7 @@  options for details.
 --column[=<options>]::
 --no-column::
 	Display tag listing in columns. See configuration variable
-	column.tag for option syntax.`--column` and `--no-column`
+	`column.tag` for option syntax. `--column` and `--no-column`
 	without options are equivalent to 'always' and 'never' respectively.
 +
 This option is only applicable when listing tags without annotation lines.