Re: [PATCH 1/7] Documentation: git-init: typographical fixes

From: Junio C Hamano <gitster@pobox.com>
Date: Aug 5, 2014, 22:06 UTC
Message-ID: <xmqqr40uoalz.fsf@gitster.dls.corp.google.com>
In-Reply-To: <1407002817-29221-2-git-send-email-linusarver@gmail.com>

Linus Arver <linusarver@gmail.com> writes:

Show 15 quoted lines

> Signed-off-by: Linus Arver <linusarver@gmail.com>
> ---
>  Documentation/git-init.txt | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
> index afd721e..5ed5859 100644
> --- a/Documentation/git-init.txt
> +++ b/Documentation/git-init.txt
> @@ -43,7 +43,7 @@ OPTIONS
>  -q::
>  --quiet::
>  
> -Only print error and warning messages, all other output will be suppressed.
> +Only print error and warning messages; all other output will be suppressed.

OK.

Show 10 quoted lines

>  --bare::
>  
> @@ -97,7 +97,7 @@ is given:
>     create a repo that is readable and writable to the current user and group,
>     but inaccessible to others.
>  
> -By default, the configuration flag receive.denyNonFastForwards is enabled
> +By default, the configuration flag 'receive.denyNonFastForwards' is enabled
>  in shared repositories, so that you cannot force a non fast-forwarding push
>  into it.

If you are going to quote something that the user should literally use, it is probably better to use `backticks` so that the quoted contents will be typeset in monospaced typewriter-font.

Show 8 quoted lines

> @@ -113,7 +113,7 @@ TEMPLATE DIRECTORY
>  The template directory contains files and directories that will be copied to
>  the `$GIT_DIR` after it is created.
>  
> -The template directory used will (in order):
> +The template directory used will be (in order):
>  
>   - The argument given with the `--template` option.

OK.

Thanks.