Skip to contentSkip to conversation

shell doc: remove stray "+" in example

PATCH In review Jonathan Nieder 3 participants 3 messages Jun 15, 2016 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 shell doc: remove stray "+" in example

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.

---
 Documentation/git-shell.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-shell.txt +1 -1
index c35051b..e4bdd22 100644
@@ -66,7 +66,7 @@ EXAMPLE
 -------
 
 To disable interactive logins, displaying a greeting instead:
-+
+
 ----------------
 $ chsh -s /usr/bin/git-shell
 $ mkdir $HOME/git-shell-commands
Signature · 1 line
1.9.1.423.g4596e3a
#1 lore raw
Quoted 18 lines · Jonathan Nieder

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.

Quoted 4 lines

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

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

#2 lore raw
Quoted 20 lines · Jeff King
Quoted 18 lines · Jonathan Nieder

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.

Quoted 8 lines
Quoted 4 lines

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

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.