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

From: Jeff King <peff@peff.net>
Date: May 8, 2014, 04:04 UTC
Message-ID: <20140508040438.GB26630@sigill.intra.peff.net>
In-Reply-To: <20140507234401.GY9218@google.com>

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