git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jacob Keller <jacob.e.keller@intel.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>,
	Jacob Keller <jacob.keller@gmail.com>
Subject: [PATCH v2 1/5] doc: add documentation for OPT_STRING_LIST
Date: Fri, 16 Dec 2016 17:24:27 -0800	[thread overview]
Message-ID: <20161217012431.29548-2-jacob.e.keller@intel.com> (raw)
In-Reply-To: <20161217012431.29548-1-jacob.e.keller@intel.com>

From: Jacob Keller <jacob.keller@gmail.com>

Commit c8ba16391655 ("parse-options: add OPT_STRING_LIST helper",
2011-06-09) added the OPT_STRING_LIST as a way to accumulate a repeated
list of strings. However, this was not documented in the
api-parse-options documentation. Add documentation now so that future
developers may learn of its existence.

Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
---
 Documentation/technical/api-parse-options.txt | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt
index 27bd701c0d68..92791740aa64 100644
--- a/Documentation/technical/api-parse-options.txt
+++ b/Documentation/technical/api-parse-options.txt
@@ -168,6 +168,11 @@ There are some macros to easily define options:
 	Introduce an option with string argument.
 	The string argument is put into `str_var`.
 
+`OPT_STRING_LIST(short long, &list, arg_str, description)`::
+	Introduce an option with a string argument. Repeated invocations
+	accumulate into a list of strings. Reset and clear the list with
+	`--no-option`.
+
 `OPT_INTEGER(short, long, &int_var, description)`::
 	Introduce an option with integer argument.
 	The integer is put into `int_var`.
-- 
2.11.0.rc2.152.g4d04e67


  reply	other threads:[~2016-12-17  1:24 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-12-17  1:24 [PATCH v2 0/5] extend describe and name-rev pattern matching Jacob Keller
2016-12-17  1:24 ` Jacob Keller [this message]
2016-12-17 11:56   ` [PATCH v2 1/5] doc: add documentation for OPT_STRING_LIST Philip Oakley
2016-12-18 12:19     ` Jacob Keller
2016-12-17  1:24 ` [PATCH v2 2/5] name-rev: extend --refs to accept multiple patterns Jacob Keller
2016-12-17  1:24 ` [PATCH v2 3/5] name-rev: add support to discard refs by pattern match Jacob Keller
2016-12-17  1:24 ` [PATCH v2 4/5] describe: teach --match to accept multiple patterns Jacob Keller
2016-12-17  1:24 ` [PATCH v2 5/5] describe: teach describe negative pattern matches Jacob Keller
  -- strict thread matches above, loose matches on Subject: below --
2017-01-18  0:03 [PATCH v2 0/5] extend git-describe pattern matching Jacob Keller
2017-01-18  0:03 ` [PATCH v2 1/5] doc: add documentation for OPT_STRING_LIST Jacob Keller

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=20161217012431.29548-2-jacob.e.keller@intel.com \
    --to=jacob.e.keller@intel.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jacob.keller@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.
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 NNTP newsgroup(s).