Skip to content

Commit

Permalink
Documentation/technical: avoid stray backslash in parse-options API docs
Browse files Browse the repository at this point in the history
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Jonathan Nieder authored and Junio C Hamano committed Aug 20, 2010
1 parent 12378c0 commit 6dcca4d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions Documentation/technical/api-parse-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand All @@ -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
Expand Down

0 comments on commit 6dcca4d

Please sign in to comment.