From 51e846e673ca749273534d063082627a561f7622 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= Date: Mon, 25 Dec 2023 21:21:27 +0000 Subject: [PATCH] doc: enforce placeholders in documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Any string that is not meant to be used verbatim in the documentation should be marked as a placeholder. Signed-off-by: Jean-Noël Avila Signed-off-by: Junio C Hamano --- Documentation/diff-options.txt | 2 +- Documentation/git-config.txt | 8 ++++---- Documentation/git-daemon.txt | 4 ++-- Documentation/git-difftool.txt | 2 +- Documentation/git.txt | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt index 53ec3c9a34..aaaff0d46f 100644 --- a/Documentation/diff-options.txt +++ b/Documentation/diff-options.txt @@ -299,7 +299,7 @@ and accumulating child directory counts in the parent directories: Synonym for --dirstat=cumulative --dirstat-by-file[=...]:: - Synonym for --dirstat=files,param1,param2... + Synonym for --dirstat=files,,... --summary:: Output a condensed summary of extended header information diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index b1caac887a..dff39093b5 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -103,11 +103,11 @@ OPTIONS names are not. --get-urlmatch :: - When given a two-part name section.key, the value for - section..key whose part matches the best to the + When given a two-part as
., the value for +
.. whose part matches the best to the given URL is returned (if no such key exists, the value for - section.key is used as a fallback). When given just the - section as name, do so for all the keys in the section and +
. is used as a fallback). When given just the +
as name, do so for all the keys in the section and list them. Returns error code 1 if no value is found. --global:: diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt index 6ab792228a..ede7b935d6 100644 --- a/Documentation/git-daemon.txt +++ b/Documentation/git-daemon.txt @@ -141,8 +141,8 @@ otherwise `stderr`. specified with no parameter, a request to git://host/{tilde}alice/foo is taken as a request to access 'foo' repository in the home directory of user `alice`. - If `--user-path=path` is specified, the same request is - taken as a request to access `path/foo` repository in + If `--user-path=` is specified, the same request is + taken as a request to access `/foo` repository in the home directory of user `alice`. --verbose:: diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt index 50cb080085..c05f97aca9 100644 --- a/Documentation/git-difftool.txt +++ b/Documentation/git-difftool.txt @@ -90,7 +90,7 @@ instead. `--no-symlinks` is the default on Windows. --extcmd=:: Specify a custom command for viewing diffs. 'git-difftool' ignores the configured defaults and runs - `$command $LOCAL $REMOTE` when this option is specified. + ` $LOCAL $REMOTE` when this option is specified. Additionally, `$BASE` is set in the environment. -g:: diff --git a/Documentation/git.txt b/Documentation/git.txt index 6536a73960..881c77312f 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -202,7 +202,7 @@ If you just want to run git as if it was started in `` then use Do not perform optional operations that require locks. This is equivalent to setting the `GIT_OPTIONAL_LOCKS` to `0`. ---list-cmds=group[,group...]:: +--list-cmds=[,...]:: List commands by group. This is an internal/experimental option and may change or be removed in the future. Supported groups are: builtins, parseopt (builtin commands that use