threads / patch / 19003

patch, 2 partsDocumentation: git-svn: fix spurious bolding that mangles the output

Subject: [PATCH 1/2] Documentation: git-svn: fix spurious bolding that mangles the output

## tl;dr

6 messages between Apr 22, 2009 and Apr 23, 2009. Diffs are folded; open one to read it.

replies: 5people: 3as markdown or json

Wesley J. Landaker· Apr 22, 2009, 14:51 UTC · lore

Without this fix, the output looks like:

"Keep in mind that the (asterisk) wildcard of the local ref (right of the :) *must be the ..." -- with half the sentence spuriously bold.

This is probably working around an asciidoc bug, but it's better to fix this than to leave the documentation in an unreadable state.

Signed-off-by: Wesley J. Landaker <wjl@icecavern.net>
---
 Documentation/git-svn.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

Show changes to Documentation/git-svn.txt +1 −1

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 9229d45..b03c1f0 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -694,7 +694,7 @@ listed below are allowed:
 ------------------------------------------------------------------------
 
 Keep in mind that the '*' (asterisk) wildcard of the local ref
-(right of the ':') *must* be the farthest right path component;
+(right of the ':') must be the farthest right path component;
 however the remote wildcard may be anywhere as long as it's own
 independent path component (surrounded by '/' or EOL).   This
 type of configuration is not automatically created by 'init' and

-- 
1.6.2.3

Wesley J. Landaker· Apr 22, 2009, 14:51 UTC · re: Wesley J. Landaker · lore

[PATCH 2/2] Documentation: git-svn: fix a grammatical error without awkwardness

The way the sentence is currently written, there needs to be an "its", but this leads to: "however the remote wildcard may be anywhere as long as it's its own" which is awkward to read.

Instead, this patch fixes he grammar in a simpler way.

Signed-off-by: Wesley J. Landaker <wjl@icecavern.net>
---
 Documentation/git-svn.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

Show changes to Documentation/git-svn.txt +1 −1

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index b03c1f0..1b18c19 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -695,7 +695,7 @@ listed below are allowed:
 
 Keep in mind that the '*' (asterisk) wildcard of the local ref
 (right of the ':') must be the farthest right path component;
-however the remote wildcard may be anywhere as long as it's own
+however the remote wildcard may be anywhere as long as it's an
 independent path component (surrounded by '/' or EOL).   This
 type of configuration is not automatically created by 'init' and
 should be manually entered with a text-editor or using 'git-config'.

-- 
1.6.2.3

Jeff King· Apr 22, 2009, 15:15 UTC · re: Wesley J. Landaker · lore

Re: [PATCH 1/2] Documentation: git-svn: fix spurious bolding that mangles the output

On Wed, Apr 22, 2009 at 08:51:46AM -0600, Wesley J. Landaker wrote:

Show 7 quoted lines

> Without this fix, the output looks like:
> 
> "Keep in mind that the  (asterisk) wildcard of the local ref (right of
> the :) *must be the ..." -- with half the sentence spuriously bold.
> 
> This is probably working around an asciidoc bug, but it's better to fix
> this than to leave the documentation in an unreadable state.

I think it's a documentation bug; the asterisk is a special character, so it is seeing the first one as the start of bold, instead of the one on the left side of *must*.

>  Keep in mind that the '*' (asterisk) wildcard of the local ref
> -(right of the ':') *must* be the farthest right path component;
> +(right of the ':') must be the farthest right path component;

So the right fix is probably to quote the asterisk that is not part of the bolding, like:

Show changes to Documentation/git-svn.txt +1 −1

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 9229d45..3e22e40 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -693,7 +693,7 @@ listed below are allowed:
 	tags = tags/*/project-a:refs/remotes/project-a/tags/*
 ------------------------------------------------------------------------
 
-Keep in mind that the '*' (asterisk) wildcard of the local ref
+Keep in mind that the '\*' (asterisk) wildcard of the local ref
 (right of the ':') *must* be the farthest right path component;
 however the remote wildcard may be anywhere as long as it's own
 independent path component (surrounded by '/' or EOL).   This

Wesley J. Landaker· Apr 22, 2009, 15:48 UTC · re: Jeff King · lore

[PATCH v2 1/2] Documentation: git-svn: fix spurious bolding that mangles the output

Without this fix, the output looks like:

"Keep in mind that the (asterisk) wildcard of the local ref (right of the :) *must be the ..." -- with half the sentence spuriously bold.

This fixes the problem by simply escaping asciidoc syntax as suggested by Jeff King <peff@peff.net>.

Signed-off-by: Wesley J. Landaker <wjl@icecavern.net>
---
 Documentation/git-svn.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

Show changes to Documentation/git-svn.txt +1 −1

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 9229d45..3e22e40 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -693,7 +693,7 @@ listed below are allowed:
 	tags = tags/*/project-a:refs/remotes/project-a/tags/*
 ------------------------------------------------------------------------
 
-Keep in mind that the '*' (asterisk) wildcard of the local ref
+Keep in mind that the '\*' (asterisk) wildcard of the local ref
 (right of the ':') *must* be the farthest right path component;
 however the remote wildcard may be anywhere as long as it's own
 independent path component (surrounded by '/' or EOL).   This

-- 
1.6.2.3

Junio C Hamano· Apr 23, 2009, 04:21 UTC · re: Wesley J. Landaker · lore

Re: [PATCH v2 1/2] Documentation: git-svn: fix spurious bolding that mangles the output

"Wesley J. Landaker" <wjl@icecavern.net> writes:

Show 9 quoted lines

> Without this fix, the output looks like:
>
> "Keep in mind that the  (asterisk) wildcard of the local ref (right of
> the :) *must be the ..." -- with half the sentence spuriously bold.
>
> This fixes the problem by simply escaping asciidoc syntax as suggested
> by Jeff King <peff@peff.net>.
>
> Signed-off-by: Wesley J. Landaker <wjl@icecavern.net>

Thanks, both.

Wesley J. Landaker· Apr 22, 2009, 15:48 UTC · re: Jeff King · lore

[PATCH v2 2/2] Documentation: git-svn: fix a grammatical error without awkwardness

The way the sentence is currently written, there needs to be an "its", but this leads to: "however the remote wildcard may be anywhere as long as it's its own" which is awkward to read.

Instead, this patch fixes he grammar in a simpler way.

Signed-off-by: Wesley J. Landaker <wjl@icecavern.net>
---
 Documentation/git-svn.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

Show changes to Documentation/git-svn.txt +1 −1

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 3e22e40..1c40894 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -695,7 +695,7 @@ listed below are allowed:
 
 Keep in mind that the '\*' (asterisk) wildcard of the local ref
 (right of the ':') *must* be the farthest right path component;
-however the remote wildcard may be anywhere as long as it's own
+however the remote wildcard may be anywhere as long as it's an
 independent path component (surrounded by '/' or EOL).   This
 type of configuration is not automatically created by 'init' and
 should be manually entered with a text-editor or using 'git-config'.

-- 
1.6.2.3