Michael J Gruber <g...@drmicha.warpmail.net> writes:
> Here are a few typo fixes.
> There is a mix of single and back ticks already before this patch,
> i.e. ` vs. ' -- I thought we had guidelines for this but don't find them
> at the moment.
> Signed-off-by: Michael J Gruber <g...@drmicha.warpmail.net>
> Documentation/rev-list-options.txt | 12 ++++++------
> 1 file changed, 6 insertions(+), 6 deletions(-)
Thanks, will squash in.
- we want to use `exactly this` when writing an item that the user
has to exactly spell as in the text, e.g. subcommand names.
- from the older days, we use <angle bracket as placeholder> in
synopsis section and in "git subcmd -h" output, and in the body
text, we tend to write like '<this>' to italicise in the
I personally find the <angle> somewhat ugly in the documentation,
but we cannot just drop them as the "man -Tascii" would suffer if we
> diff --git a/Documentation/rev-list-options.txt
> index 57d6c90..c828408 100644
> --- a/Documentation/rev-list-options.txt
> +++ b/Documentation/rev-list-options.txt
> @@ -6,12 +6,12 @@ special notations explained in the description, additional
> limiting may be applied.
> Using more options generally further limits the output (e.g.
> -"--since=<date1>" limits to commits newer than <date1>, and using it
> -with "--grep=<pattern>" further limits to commits whose log message
> -has a line that match <pattern>), unless otherwise noted.
> +`--since=<date1>` limits to commits newer than `<date1>`, and using it
> +with `--grep=<pattern>` further limits to commits whose log message
> +has a line that matches `<pattern>`), unless otherwise noted.
> Note that these are applied before commit
> -ordering and formatting options, such as '--reverse'.
> +ordering and formatting options, such as `--reverse`.
> @@ -47,7 +47,7 @@ endif::git-rev-list
> Limit the commits output to ones with author/committer
> header lines that match the specified pattern (regular
> expression). With more than one `--author=<pattern>`,
> - commits whose author match any of the given patterns are
> + commits whose author matches any of the given patterns are
> chosen (similarly for multiple `--committer=<pattern>`).
> @@ -55,7 +55,7 @@ endif::git-rev-list
> Limit the commits output to ones with log message that
> matches the specified pattern (regular expression). With
> more than one `--grep=<pattern>`, commits whose message
> - match any of the given patterns are chosen (but see
> + matches any of the given patterns are chosen (but see
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html