From 23f8239bbe0a893bd8754a03e9d4fda62804ac14 Mon Sep 17 00:00:00 2001 From: Matthieu Moy Date: Tue, 28 Jun 2016 13:40:10 +0200 Subject: doc: typeset short command-line options as literal It was common in our documentation to surround short option names with forward quotes, which renders as italic in HTML. Instead, use backquotes which renders as monospace. This is one more step toward conformance to Documentation/CodingGuidelines. This was obtained with: perl -pi -e "s/'(-[a-z])'/\`\$1\`/g" *.txt Signed-off-by: Matthieu Moy Signed-off-by: Junio C Hamano --- Documentation/git.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/git.txt') diff --git a/Documentation/git.txt b/Documentation/git.txt index 25ef006c3..24efc63c8 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -508,7 +508,7 @@ OPTIONS --help:: Prints the synopsis and a list of the most commonly used - commands. If the option '--all' or '-a' is given then all + commands. If the option '--all' or `-a` is given then all available commands are printed. If a Git command is named this option will bring up the manual page for that command. + @@ -974,7 +974,7 @@ other The command will be given exactly two or four arguments: the 'username@host' (or just 'host') from the URL and the shell command to execute on that remote system, optionally preceded by - '-p' (literally) and the 'port' from the URL when it specifies + `-p` (literally) and the 'port' from the URL when it specifies something other than the default SSH port. + `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted -- cgit v1.2.1 From bcf9626a71a0d90be65acc265ad0ec488d95d6ed Mon Sep 17 00:00:00 2001 From: Matthieu Moy Date: Tue, 28 Jun 2016 13:40:11 +0200 Subject: doc: typeset long command-line options as literal Similarly to the previous commit, use backquotes instead of forward-quotes, for long options. This was obtained with: perl -pi -e "s/'(--[a-z][a-z=<>-]*)'/\`\$1\`/g" *.txt and manual tweak to remove false positive in ascii-art (o'--o'--o' to describe rewritten history). Signed-off-by: Matthieu Moy Signed-off-by: Junio C Hamano --- Documentation/git.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'Documentation/git.txt') diff --git a/Documentation/git.txt b/Documentation/git.txt index 24efc63c8..56d579b58 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -508,7 +508,7 @@ OPTIONS --help:: Prints the synopsis and a list of the most commonly used - commands. If the option '--all' or `-a` is given then all + commands. If the option `--all` or `-a` is given then all available commands are printed. If a Git command is named this option will bring up the manual page for that command. + @@ -850,16 +850,16 @@ Git so take care if using a foreign front-end. If the `GIT_DIR` environment variable is set then it specifies a path to use instead of the default `.git` for the base of the repository. - The '--git-dir' command-line option also sets this value. + The `--git-dir` command-line option also sets this value. `GIT_WORK_TREE`:: Set the path to the root of the working tree. - This can also be controlled by the '--work-tree' command-line + This can also be controlled by the `--work-tree` command-line option and the core.worktree configuration variable. `GIT_NAMESPACE`:: Set the Git namespace; see linkgit:gitnamespaces[7] for details. - The '--namespace' command-line option also sets this value. + The `--namespace` command-line option also sets this value. `GIT_CEILING_DIRECTORIES`:: This should be a colon-separated list of absolute paths. If -- cgit v1.2.1