git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Štěpán Němec" <stepan.nemec@gmail.com>
Cc: git@vger.kernel.org, jrnieder@gmail.com
Subject: Re: [PATCH 0/6] Unify argument and option notation in the docs
Date: Fri, 08 Oct 2010 12:43:51 -0700	[thread overview]
Message-ID: <7v1v80wjuw.fsf@alter.siamese.dyndns.org> (raw)
In-Reply-To: <1286559080-27257-1-git-send-email-stepnem@gmail.com> ("Štěpán Němec"'s message of "Fri\,  8 Oct 2010 19\:31\:14 +0200")

I had to fix up the whitespace damage in the rerolled 2/6 but otherwise
looked good.

Thanks, both.  It might make sense to outline the rules applied somewhere in
CodingGuidelines to help people who add to our documents.  Something along
the lines of...

 - A placeholder is spelled inside angle brackets, e.g. <file>, <object>.

 - Choosing one from many is written with possible choices separated with
   a vertical bar and the whole thing enclosed in parentheses, e.g.
   answer=(yes|no|true|false)

 - Repetition of zero or more times of X is spelled as [(X)...], e.g.
   [(-p <parent>)...]

  parent reply	other threads:[~2010-10-08 19:48 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-10-08  0:52 [PATCH/RFC] Unify argument and option notation in the docs Štěpán Němec
2010-10-08  7:43 ` Jonathan Nieder
2010-10-08 11:13   ` Štěpán Němec
2010-10-08 17:31     ` [PATCH 0/6] " Štěpán Němec
2010-10-08 17:44       ` Jonathan Nieder
2010-10-08 19:43       ` Junio C Hamano [this message]
2010-10-08 20:15         ` Štěpán Němec
2010-10-21 22:21           ` Jonathan Nieder
2010-10-24 15:51             ` [PATCH] CodingGuidelines: Add a section on writing documentation Štěpán Němec
2010-10-29  2:56               ` Mark Lodato
2010-10-29 11:54                 ` Štěpán Němec
2010-10-29 17:14                   ` Sverre Rabbelier
2010-11-01 17:00                     ` Štěpán Němec
2010-11-04 17:12                       ` [PATCH v2] " Štěpán Němec
2010-11-04 17:18                       ` [PATCH] diff,difftool: Don't use the {0,2} notation in usage strings Štěpán Němec
2010-11-04 17:22                         ` Sverre Rabbelier
2010-11-04 17:49                         ` Jeff King
2010-11-04 18:02                           ` Jonathan Nieder
2010-11-04 18:13                             ` Jeff King
2010-11-04 18:38                               ` Jonathan Nieder
2010-11-04 18:55                                 ` Jeff King
2010-11-04 20:26                                   ` Štěpán Němec
2010-11-04 20:43                                     ` Jeff King
2010-11-04 21:17                                       ` [PATCH] docs: clarify git diff modes of operation Jeff King
2010-11-04 21:50                                         ` Jonathan Nieder
2010-11-05  1:57                                           ` Mark Lodato
2010-11-04 21:51                                         ` Štěpán Němec
2010-11-04 21:30                                       ` [PATCH] diff,difftool: Don't use the {0,2} notation in usage strings Štěpán Němec
2010-10-08 17:31     ` [PATCH 1/6] Use angles for placeholders consistently Štěpán Němec
2010-10-08 17:31     ` [PATCH 2/6] Fix odd markup in --diff-filter documentation Štěpán Němec
2010-10-08 17:39       ` Jonathan Nieder
2010-10-08 17:57         ` Štěpán Němec
2010-10-08 18:03           ` Jonathan Nieder
2010-10-08 18:40             ` Štěpán Němec
2010-10-08 18:53               ` Jonathan Nieder
2010-10-08 17:31     ` [PATCH 3/6] Use parentheses and `...' where appropriate Štěpán Němec
2010-10-08 17:31     ` [PATCH 4/6] Remove stray quotes in --pretty and --format documentation Štěpán Němec
2010-10-08 17:31     ` [PATCH 5/6] Put a space between `<' and argument in pack-objects usage string Štěpán Němec
2010-10-08 17:31     ` [PATCH 6/6] Fix {update,checkout}-index usage strings Štěpán Němec
2010-10-08 16:45   ` [PATCH 0/2] pack-objects: use ALLOC_GROW in place of manual growth Jonathan Nieder
2010-10-08 16:46     ` [PATCH 1/2] Documentation: No argument of ALLOC_GROW should have side-effects Jonathan Nieder
2010-10-08 16:47     ` [PATCH 2/2] pack-objects: use ALLOC_GROW Jonathan Nieder
2010-10-08 17:02     ` [PATCH 3/2] Allow side-effects in second argument to ALLOC_GROW Jonathan Nieder

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

  List information: http://vger.kernel.org/majordomo-info.html

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

  git send-email \
    --in-reply-to=7v1v80wjuw.fsf@alter.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=jrnieder@gmail.com \
    --cc=stepan.nemec@gmail.com \
    /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. 
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).