From: Jonathan Nieder <jrnieder@gmail.com>
To: git@vger.kernel.org
Cc: "Ramkumar Ramachandra" <artagnon@gmail.com>,
"Frédéric Brière" <fbriere@fbriere.net>,
"Christian Couder" <chriscool@tuxfamily.org>,
"Thomas Rast" <trast@student.ethz.ch>
Subject: [PATCH 09/17] Documentation/technical: avoid stray backslash in parse-options API docs
Date: Fri, 20 Aug 2010 05:32:36 -0500 [thread overview]
Message-ID: <20100820103236.GI10407@burratino> (raw)
In-Reply-To: <20100820101902.GA10356@burratino>
Due to some unpleasant interaction between the `quote', 'italics',
and `monospace` rules, a certain paragraph ends up rendered like so:
‘short` is a character for the short option
(e.g. <tt>'e\’</tt> for <tt>-e</tt>, use <tt>0</tt> to omit),
Use the {apostrophe} to avoid this.
While at it, escape "->" strings: they are meant as a literal
two-character C operator, not a right-pointing arrow.
Reported-by: Frédéric Brière <fbriere@fbriere.net>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Documentation/technical/api-parse-options.txt | 8 ++++----
1 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt
index 312e3b2..c5d141c 100644
--- a/Documentation/technical/api-parse-options.txt
+++ b/Documentation/technical/api-parse-options.txt
@@ -201,7 +201,7 @@ The last element of the array must be `OPT_END()`.
If not stated otherwise, interpret the arguments as follows:
* `short` is a character for the short option
- (e.g. `\'e\'` for `-e`, use `0` to omit),
+ (e.g. `{apostrophe}e{apostrophe}` for `-e`, use `0` to omit),
* `long` is a string for the long option
(e.g. `"example"` for `\--example`, use `NULL` to omit),
@@ -228,10 +228,10 @@ The function must be defined in this form:
The callback mechanism is as follows:
* Inside `func`, the only interesting member of the structure
- given by `opt` is the void pointer `opt->value`.
- `\*opt->value` will be the value that is saved into `var`, if you
+ given by `opt` is the void pointer `opt\->value`.
+ `\*opt\->value` will be the value that is saved into `var`, if you
use `OPT_CALLBACK()`.
- For example, do `*(unsigned long *)opt->value = 42;` to get 42
+ For example, do `*(unsigned long *)opt\->value = 42;` to get 42
into an `unsigned long` variable.
* Return value `0` indicates success and non-zero return
--
1.7.2.2.536.g42dab.dirty
next prev parent reply other threads:[~2010-08-20 10:34 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-08-20 10:19 [RFC/PATCH 00/17] unexpected backslashes in man pages Jonathan Nieder
2010-08-20 10:20 ` [PATCH 01/17] Documentation: tweak description of log.date Jonathan Nieder
2010-08-20 10:21 ` [PATCH 02/17] Documentation: quoting trouble in "git rm" discussion Jonathan Nieder
2010-08-20 10:23 ` [PATCH 03/17] Documentation: unbreak regex in show-ref manual Jonathan Nieder
2010-08-20 10:26 ` [PATCH 04/17] Documentation: clarify quoting in "git add" example Jonathan Nieder
2010-08-20 10:28 ` [PATCH 05/17] Documentation: add missing quotes to "git grep" examples Jonathan Nieder
2010-08-20 10:30 ` [PATCH 06/17] Documentation: clarify quoting in "git rm" example Jonathan Nieder
2010-08-20 10:30 ` [PATCH 07/17] Documentation: clarify quoting in gitignore docs Jonathan Nieder
2010-08-20 10:31 ` [PATCH 08/17] Documentation: remove backslashes in manpage synopses Jonathan Nieder
2010-08-20 10:32 ` Jonathan Nieder [this message]
2010-08-20 10:33 ` [PATCH 10/17] Documentation: remove stray backslash from "git bundle" manual Jonathan Nieder
2010-08-20 10:34 ` [PATCH 11/17] Documentation: remove backslash before ~ in fast-import manual Jonathan Nieder
2010-08-20 10:35 ` [PATCH 12/17] Documentation: remove stray backslashes in rev-parse manual Jonathan Nieder
2010-08-20 10:37 ` [PATCH 13/17] Documentation: remove stray backslash in show-branch discussion Jonathan Nieder
2010-08-23 11:18 ` Thomas Rast
2010-08-23 11:36 ` Ramkumar Ramachandra
2010-08-23 22:49 ` Jonathan Nieder
2010-08-20 10:37 ` [PATCH 14/17] Documentation: avoid stray backslashes in core tutorial Jonathan Nieder
2010-08-20 10:38 ` [PATCH 15/17] Documentation: avoid stray backslash in user manual Jonathan Nieder
2010-08-20 10:39 ` [PATCH 16/17] Documentation: do not convert ... operator to ellipses Jonathan Nieder
2010-08-20 10:40 ` [PATCH 17/17] Documentation: remove stray backslashes from "Fighting regressions" article Jonathan Nieder
2010-08-23 11:51 ` [RFC/PATCH 00/17] unexpected backslashes in man pages Thomas Rast
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=20100820103236.GI10407@burratino \
--to=jrnieder@gmail.com \
--cc=artagnon@gmail.com \
--cc=chriscool@tuxfamily.org \
--cc=fbriere@fbriere.net \
--cc=git@vger.kernel.org \
--cc=trast@student.ethz.ch \
/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).