A tiny documentation patch

A tiny documentation patch

[Štěpán Němec]

[-- Attachment #1: Type: text/plain, Size: 167 bytes --]

 Hello,

I noticed a few typos in the git-remote manpage, so I fixed the txt
source file and here's the patch.

 Best regards and thank you for Git!

Štěpán Němec

[-- Attachment #2: 0001-Fix-typos-in-git-remote.txt.patch --]
[-- Type: text/x-diff, Size: 1985 bytes --]

>From 65ae3e5cdb241aaaed96a7aeecffb6d305d0b07c Mon Sep 17 00:00:00 2001
From: =?utf-8?q?=C5=A0t=C4=9Bp=C3=A1n=20N=C4=9Bmec?= <stepnem@gmail.com>
Date: Mon, 10 Aug 2009 16:29:08 +0200
Subject: [PATCH] Fix typos in git-remote.txt

---
 Documentation/git-remote.txt |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index 9e2b4ea..0964cee 100644
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -56,10 +56,10 @@ multiple branches without grabbing all branches.
 With `-m <master>` option, `$GIT_DIR/remotes/<name>/HEAD` is set
 up to point at remote's `<master>` branch. See also the set-head command.
 +
-In mirror mode, enabled with `\--mirror`, the refs will not be stored
+In mirror mode, enabled with `--mirror`, the refs will not be stored
 in the 'refs/remotes/' namespace, but in 'refs/heads/'.  This option
 only makes sense in bare repositories.  If a remote uses mirror
-mode, furthermore, `git push` will always behave as if `\--mirror`
+mode, furthermore, `git push` will always behave as if `--mirror`
 was passed.
 
 'rename'::
@@ -114,14 +114,14 @@ These stale branches have already been removed from the remote repository
 referenced by <name>, but are still locally available in
 "remotes/<name>".
 +
-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.
 
 'update'::
 
 Fetch updates for a named set of remotes in the repository as defined by
 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
 remotes.default is not defined, all remotes which do not have the
 configuration parameter remote.<name>.skipDefaultUpdate set to true will
 be updated.  (See linkgit:git-config[1]).
-- 
1.6.3.3

Re: A tiny documentation patch

[Thomas Rast]

Š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

Re: A tiny documentation patch

[Michael J Gruber]

Thomas Rast venit, vidit, dixit 10.08.2009 16:59:
> Štěpán Němec wrote:
[...]
> [...]
>> -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).
[...]

In current next's Documentation/, we have 149 lines with `-- and 48
lines with `\--. How is our policy regarding old AsciiDoc? I suggest
(read: volunteer) making these things uniform one way or the other,
depending which versions we want to support.

Michael

Re: A tiny documentation patch

[Junio C Hamano]

Michael J Gruber <git@drmicha.warpmail.net> writes:

> In current next's Documentation/, we have 149 lines with `-- and 48
> lines with `\--. How is our policy regarding old AsciiDoc?

We could drop support for AsciiDoc 7 after all mainstream distros stop
shipping it.  If the need to bend backwards in order to support it gets
too much for us, we might be tempted to drop it sooner, but are we getting
to that point?  I hope not.

> (read: volunteer) making these things uniform one way or the other,
> depending which versions we want to support.

Thanks.  150 does not sound too bad to classify between ones that should
be em-dash and that should be double dashes.