Re: A tiny documentation patch

From: Thomas Rast <trast@student.ethz.ch>
Date: Aug 10, 2009, 14:59 UTC
Message-ID: <200908101659.28291.trast@student.ethz.ch>
In-Reply-To: <20090810144419.GB24183@headley>

Štěpán Němec wrote:

> here's the patch.

Please read Documentation/SubmittingPatches. In particular, you should send your patch inline (git-send-email can help) and add a Signed-off-by.

> I noticed a few typos in the git-remote manpage

[...]

> diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt

[...]

> -In mirror mode, enabled with `\--mirror`, the refs will not be stored
> +In mirror mode, enabled with `--mirror`, the refs will not be stored

[...]

> -mode, furthermore, `git push` will always behave as if `\--mirror`
> +mode, furthermore, `git push` will always behave as if `--mirror`

While I'm not sure how far back you'd have to go to find an asciidoc that does need this escaping, it's definitely *not* a typo. In some instances, -- turns into em dashes.

If you are seeing stray backslashes in the output (I don't), I suspect you are either running asciidoc 8.x but forgot to set ASCIIDOC8, or 8.4.1+ and are missing the patch 71c020c (Disable asciidoc 8.4.1+ semantics for `{plus}` and friends, 2009-07-25).

> -With `--dry-run` option, report what branches will be pruned, but do no
> +With `--dry-run` option, report what branches will be pruned, but do not
>  actually prune them.

Ok.

>  remotes.<group>.  If a named group is not specified on the command line,
> -the configuration parameter remotes.default will get used; if
> +the configuration parameter remotes.default will be used; if

Ok.

-- 
Thomas Rast
trast@{inf,student}.ethz.ch