threads / patch / 36603

patchshell doc: remove stray "+" in example

Subject: [PATCH] shell doc: remove stray "+" in example

## tl;dr

3 messages between May 7, 2014 and May 8, 2014. Diffs are folded; open one to read it.

replies: 2people: 3as markdown or json

Jonathan Nieder· May 7, 2014, 23:44 UTC · lore

The git-shell(1) manpage says

	EXAMPLE
	       To disable interactive logins, displaying a greeting
		instead:

		   $ chsh -s /usr/bin/git-shell
		   $ mkdir $HOME/git-shell-commands
[...]

The stray "+" has been there ever since the example was added in v1.8.3-rc0~210^2 (shell: new no-interactive-login command to print a custom message, 2013-03-09). The "+" sign between paragraphs is needed in asciidoc to attach extra paragraphs to a list item but here it is not needed and ends up rendered as a literal "+". Remove it.

A quick search with "grep -e '<p>+' /usr/share/doc/git/html/*.html" doesn't find any other instances of this problem.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
 Documentation/git-shell.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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

diff --git a/Documentation/git-shell.txt b/Documentation/git-shell.txt
index c35051b..e4bdd22 100644
--- a/Documentation/git-shell.txt
+++ b/Documentation/git-shell.txt
@@ -66,7 +66,7 @@ EXAMPLE
 -------
 
 To disable interactive logins, displaying a greeting instead:
-+
+
 ----------------
 $ chsh -s /usr/bin/git-shell
 $ mkdir $HOME/git-shell-commands

-- 
1.9.1.423.g4596e3a

Jeff King· May 8, 2014, 04:04 UTC · re: Jonathan Nieder · lore

Re: [PATCH] shell doc: remove stray "+" in example

On Wed, May 07, 2014 at 04:44:01PM -0700, Jonathan Nieder wrote:

Show 22 quoted lines

> The git-shell(1) manpage says
> 
> 	EXAMPLE
> 	       To disable interactive logins, displaying a greeting
> 		instead:
> 
> 		+
> 
> 		   $ chsh -s /usr/bin/git-shell
> 		   $ mkdir $HOME/git-shell-commands
> [...]
> 
> The stray "+" has been there ever since the example was added in
> v1.8.3-rc0~210^2 (shell: new no-interactive-login command to print a
> custom message, 2013-03-09).  The "+" sign between paragraphs is
> needed in asciidoc to attach extra paragraphs to a list item but here
> it is not needed and ends up rendered as a literal "+".  Remove it.
> 
> A quick search with "grep -e '<p>+' /usr/share/doc/git/html/*.html"
> doesn't find any other instances of this problem.
> 
> Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>

Looks good to me. I suspect it was copied from another spot where the examples _were_ in a list (e.g., git-add's EXAMPLES section). Either way, your fix is the right thing to do.

-Peff

Junio C Hamano· May 8, 2014, 17:26 UTC · re: Jeff King · lore

Re: [PATCH] shell doc: remove stray "+" in example

Jeff King <peff@peff.net> writes:

Show 28 quoted lines

> On Wed, May 07, 2014 at 04:44:01PM -0700, Jonathan Nieder wrote:
>
>> The git-shell(1) manpage says
>> 
>> 	EXAMPLE
>> 	       To disable interactive logins, displaying a greeting
>> 		instead:
>> 
>> 		+
>> 
>> 		   $ chsh -s /usr/bin/git-shell
>> 		   $ mkdir $HOME/git-shell-commands
>> [...]
>> 
>> The stray "+" has been there ever since the example was added in
>> v1.8.3-rc0~210^2 (shell: new no-interactive-login command to print a
>> custom message, 2013-03-09).  The "+" sign between paragraphs is
>> needed in asciidoc to attach extra paragraphs to a list item but here
>> it is not needed and ends up rendered as a literal "+".  Remove it.
>> 
>> A quick search with "grep -e '<p>+' /usr/share/doc/git/html/*.html"
>> doesn't find any other instances of this problem.
>> 
>> Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
>
> Looks good to me. I suspect it was copied from another spot where the
> examples _were_ in a list (e.g., git-add's EXAMPLES section). Either
> way, your fix is the right thing to do.

Thanks, both.  Looks good to me, too.