diff options
author | Junio C Hamano <gitster@pobox.com> | 2010-09-03 09:43:42 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2010-09-03 09:43:42 -0700 |
commit | c0808fe70870f513a4fc020ec23500b88f8b1018 (patch) | |
tree | 6a5eb5d86124b2ec7d756a25c267978aedb7abc0 /Documentation/technical | |
parent | 2b916ffa18cb163a9d8f0060a9127e9b0a84b955 (diff) | |
parent | a5218458009620ba5142438b01a0032ee00ea395 (diff) | |
download | git-c0808fe70870f513a4fc020ec23500b88f8b1018.tar.gz git-c0808fe70870f513a4fc020ec23500b88f8b1018.tar.xz |
Merge branch 'jn/doc-backslash'
* jn/doc-backslash:
Documentation: remove stray backslash in show-branch discussion
Documentation: remove stray backslashes from "Fighting regressions" article
Documentation: do not convert ... operator to ellipses
Documentation: avoid stray backslash in user manual
Documentation: avoid stray backslashes in core tutorial
Documentation: remove stray backslashes in rev-parse manual
Documentation: remove backslash before ~ in fast-import manual
Documentation: remove stray backslash from "git bundle" manual
Documentation/technical: avoid stray backslash in parse-options API docs
Documentation: remove backslashes in manpage synopses
Documentation: clarify quoting in gitignore docs
Documentation: clarify quoting in "git rm" example
Documentation: add missing quotes to "git grep" examples
Documentation: clarify quoting in "git add" example
Documentation: unbreak regex in show-ref manual
Documentation: quoting trouble in "git rm" discussion
Documentation: tweak description of log.date
Diffstat (limited to 'Documentation/technical')
-rw-r--r-- | 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 312e3b2e2..c5d141cd6 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 |