threads / patch / 20528

patchFix typos in git-remote.txt and git-symbolic-ref.txt

Subject: [PATCH] Fix typos in git-remote.txt and git-symbolic-ref.txt

## tl;dr

5 messages between Aug 11, 2009 and Aug 12, 2009. Diffs are folded; open one to read it.

replies: 4people: 4as markdown or json

Štěpán Němec· Aug 11, 2009, 00:52 UTC · lore
Signed-off-by: Štěpán Němec <stepnem@gmail.com>
---
I apologize for the previous mail.
Thank you for clarification and guidance.

I did look at some of the other documentation files (and now also grepped the whole directory for `--' and `\--' occurences), but wasn't able to see any rule or consistence in the usage. Whether it is an indication of real inconsistence or just another example of my ignorance I do not know (not now, at least).

The stray backslashes were fixed by setting ASCIIDOC8, thanks again.
Štěpán Němec
 Documentation/git-remote.txt       |    4 ++--
 Documentation/git-symbolic-ref.txt |    4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)
Show changes to 2 files +4 −5

Documentation/git-remote.txt, Documentation/git-symbolic-ref.txt

diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index 9e2b4ea..82a3d29 100644
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -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]).
diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt
index 210fde0..6392538 100644
--- a/Documentation/git-symbolic-ref.txt
+++ b/Documentation/git-symbolic-ref.txt
@@ -14,9 +14,9 @@ DESCRIPTION
 Given one argument, reads which branch head the given symbolic
 ref refers to and outputs its path, relative to the `.git/`
 directory.  Typically you would give `HEAD` as the <name>
-argument to see on which branch your working tree is on.
+argument to see which branch your working tree is on.

-Give two arguments, create or update a symbolic ref <name> to
+Given two arguments, creates or updates a symbolic ref <name> to
 point at the given branch <ref>.

 A symbolic ref is a regular file that stores a string that
--
1.6.3.3
Thomas Rast· Aug 11, 2009, 07:09 UTC · re: Štěpán Němec · lore

Re: [PATCH] Fix typos in git-remote.txt and git-symbolic-ref.txt

Thanks for the updated version!
Štěpán Němec wrote:
Show 6 quoted lines
> 
> I did look at some of the other documentation files (and now also grepped
> the whole directory for `--' and `\--' occurences), but wasn't able to see
> any rule or consistence in the usage. Whether it is an indication of
> real inconsistence or just another example of my ignorance I do not know
> (not now, at least).

Well, as I said I'm not sure what asciidoc versions, if any, needed the backslash inside backtick quoting. However, there is precedent in

commit e1ccf53a60657930ae7892387736c8b6a91ec610
Author: Yasushi SHOJI <yashi@atmark-techno.com>
Date:   Mon Sep 12 02:29:10 2005 +0900
    [PATCH] Escape asciidoc's built-in em-dash replacement
    AsciiDoc replace '--' with em-dash (&#8212) by default. em-dash
    looks a lot like a single long dash and it's very confusing when
    we are talking about command options.
    Section 21.2.8 'Replacements' of AsciiDoc's User Guide says that a
    backslash in front of double dash prevent the replacement.  This
    patch does just that.
    Signed-off-by: Yasushi SHOJI <yashi@atmark-techno.com>
    Signed-off-by: Junio C Hamano <junkio@cox.net>

So until we know for certain that they're not needed, I'd rather not actively remove them. Admittedly, there are lots of instances of `-- in the docs too, so making sure which way is "right" and then replacing _all_ of them would probably be a nice cleanup.

-- 
Thomas Rast
trast@{inf,student}.ethz.ch
Wesley J. Landaker· Aug 12, 2009, 00:26 UTC · re: Thomas Rast · lore

Re: [PATCH] Fix typos in git-remote.txt and git-symbolic-ref.txt

On Tuesday 11 August 2009 01:09:32 Thomas Rast wrote:
> So until we know for certain that they're not needed, I'd rather not
> actively remove them.  Admittedly, there are lots of instances of `--
> in the docs too, so making sure which way is "right" and then
> replacing _all_ of them would probably be a nice cleanup.

I'm not fully sure of the current situation, but if it, for instance, turns out that "--" gives an em-dash and "\--" gives two hyphens in a row, we'd only want to change the "--"'s to "\--" for things like command-line options, where an em-dash is totally inappropriate. If it's a sentence that is actually using an em-dash for another purpose, it is probably intentional and desirable to actually get an em-dash.

Obviously we want consistency, but--as this sentence shows--there is a difference between an em-dash and a command-line option like --version.

Thomas Rast· Aug 12, 2009, 13:40 UTC · re: Wesley J. Landaker · lore

Re: [PATCH] Fix typos in git-remote.txt and git-symbolic-ref.txt

Wesley J. Landaker wrote:
> On Tuesday 11 August 2009 01:09:32 Thomas Rast wrote:
> > instances of `--
[...]
> Obviously we want consistency, but--as this sentence shows--there is a 
> difference between an em-dash and a command-line option like --version.

Note the backtick. This is solely about `--options` vs. `\--options`, and I highly doubt anyone would want their em-dashes to be typeset in fixed-width font (that's what the backticks do).

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

← back to recent threads