All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jakub Narebski <jnareb@gmail.com>
To: Jari Aalto <jari.aalto@cante.net>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Documentation/git-stash.txt: Adjust SYNOPSIS command syntaxes
Date: Fri, 01 Feb 2008 03:19:03 -0800 (PST)	[thread overview]
Message-ID: <m37iho9b70.fsf@localhost.localdomain> (raw)
In-Reply-To: <7ihp802o.fsf@blue.sea.net>

Jari Aalto <jari.aalto@cante.net> writes:

> Change (list|...) to <list|...> to denote required command. Adjust
> the 'save' command syntax to better reflect the call parameters:
> [save] [message...] => [save [message...]].

While I agree with the second change, i.e. the "[save [message...]]"
part, I think that the first part is a mistake.  Parentheses does not
imply the optional part: brackets do; parentheses are meant to
delimit the alternatives.  Angle brackets if I understand correctly
are meant to denote part which you have to enter, the user supplied
info (the reast ou have to enter literally).

So IMVHO the SYNOPSIS for git-stash(1) should read:

SYNOPSIS
--------
[verse]
'git-stash' (list | show [<stash>] | apply [<stash>] | clear)
'git-stash' [save [<message>...]]

or

'git-stash' [save [<message...>]]

> -- 
> Welcome to FOSS revolution: we fix and modify until it shines
> 

Nice one. Can I add it to http://git.or.cz/gitwiki/FortuneCookies ?

-- 
Jakub Narebski
Poland
ShadeHawk on #git

  reply	other threads:[~2008-02-01 11:19 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-02-01 10:04 [PATCH] Documentation/git-stash.txt: Adjust SYNOPSIS command syntaxes Jari Aalto
2008-02-01 11:19 ` Jakub Narebski [this message]
2008-02-01 13:06   ` Jari Aalto
2008-02-01 13:35     ` Jakub Narebski
2008-02-01 22:37       ` Jari Aalto
2008-02-01 23:26         ` Junio C Hamano
2008-02-02  1:43           ` Jari Aalto
2008-02-02  2:17           ` Jari Aalto
2008-02-02  0:38         ` Jakub Narebski
2008-02-02  2:00           ` Jari Aalto
2008-02-02  2:30             ` Jakub Narebski
2008-02-02  9:07               ` Jari Aalto
2008-02-02  9:45                 ` Jakub Narebski
2008-02-02 14:32                   ` Jari Aalto
2008-02-02 15:25                     ` Jakub Narebski
2008-02-02  2:22 ` [PATCH] Documentation/git-stash.txt: Adjust SYNOPSIS command syntax Jari Aalto
2008-02-02  2:47   ` Junio C Hamano
2008-02-02 10:23   ` Jakub Narebski
2008-02-02 14:03     ` [PATCH] Documentation/git-stash.txt: Adjust SYNOPSIS command syntax (2) Jari Aalto

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=m37iho9b70.fsf@localhost.localdomain \
    --to=jnareb@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=jari.aalto@cante.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.