Fix doc placeholders #1626
Fix doc placeholders #1626
Conversation
The CodingGuidelines documents stipulates that multi-word placeholders are to be separated by dashes, not underscores nor spaces. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
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 <jn.avila@free.fr>
jnavila
force-pushed
the
fix_doc_placeholders
branch
from
60b58e0
to
e928f27
Compare
|
/preview |
|
Preview email sent as pull.1626.git.1703412798.gitgitgadget@gmail.com |
|
/submit |
|
Submitted as pull.1626.git.1703539287.gitgitgadget@gmail.com To fetch this version into To fetch this version to local tag |
|
On the Git mailing list, Junio C Hamano wrote (reply to this): "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com> writes:
> While setting up a check of (the absence of) translations of commands,
> options and environment variable in the manpages in the manpage translation
> project, some false positives appeared.
>
> Here is a series that enforces the formatting rules for placeholders in
> documentation and help.
Nice. Will take a look and then queue. Thanks.
>
> Jean-Noël Avila (2):
> doc: enforce dashes in placeholders
> doc: enforce placeholders in documentation
>
> Documentation/diff-options.txt | 2 +-
> Documentation/git-blame.txt | 2 +-
> Documentation/git-bugreport.txt | 4 ++--
> Documentation/git-commit-graph.txt | 2 +-
> Documentation/git-config.txt | 8 ++++----
> Documentation/git-cvsserver.txt | 4 ++--
> Documentation/git-daemon.txt | 10 +++++-----
> Documentation/git-diagnose.txt | 2 +-
> Documentation/git-difftool.txt | 2 +-
> Documentation/git-fast-import.txt | 4 ++--
> Documentation/git-fetch.txt | 4 ++--
> Documentation/git-filter-branch.txt | 6 +++---
> Documentation/git-format-patch.txt | 20 ++++++++++----------
> Documentation/git-mv.txt | 2 +-
> Documentation/git-notes.txt | 2 +-
> Documentation/git-replace.txt | 6 +++---
> Documentation/git-revert.txt | 4 ++--
> Documentation/git-send-email.txt | 2 +-
> Documentation/git-status.txt | 4 ++--
> Documentation/git-submodule.txt | 4 ++--
> Documentation/git-svn.txt | 18 +++++++++---------
> Documentation/git-tag.txt | 2 +-
> Documentation/git.txt | 4 ++--
> Documentation/gitdiffcore.txt | 8 ++++----
> Documentation/gitformat-index.txt | 4 ++--
> Documentation/githooks.txt | 8 ++++----
> Documentation/gitk.txt | 4 ++--
> Documentation/gitprotocol-capabilities.txt | 2 +-
> Documentation/gitprotocol-http.txt | 14 +++++++-------
> Documentation/gitprotocol-v2.txt | 8 ++++----
> Documentation/gitsubmodules.txt | 4 ++--
> Documentation/gitweb.conf.txt | 10 +++++-----
> Documentation/gitweb.txt | 2 +-
> Documentation/trace2-target-values.txt | 2 +-
> Documentation/urls.txt | 8 ++++----
> Documentation/user-manual.txt | 4 ++--
> builtin/commit-graph.c | 2 +-
> 37 files changed, 99 insertions(+), 99 deletions(-)
>
>
> base-commit: 564d0252ca632e0264ed670534a51d18a689ef5d
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1626%2Fjnavila%2Ffix_doc_placeholders-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1626/jnavila/fix_doc_placeholders-v1
> Pull-Request: https://github.com/gitgitgadget/git/pull/1626 |
|
This branch is now known as |
|
This patch series was integrated into seen via git@b068324. |
|
This patch series was integrated into seen via git@ba1797b. |
|
There was a status update in the "New Topics" section about the branch Docfix. Needs review. source: <pull.1626.git.1703539287.gitgitgadget@gmail.com> |
|
This patch series was integrated into seen via git@9841bb8. |
|
This patch series was integrated into seen via git@1a08b10. |
|
This patch series was integrated into seen via git@f1821d6. |
|
There was a status update in the "Cooking" section about the branch Docfix. Needs review. source: <pull.1626.git.1703539287.gitgitgadget@gmail.com> |
|
This patch series was integrated into seen via git@1d41de1. |
|
This patch series was integrated into seen via git@7c02866. |
|
This patch series was integrated into seen via git@5a9f78a. |
|
There was a status update in the "Cooking" section about the branch Docfix. Needs review. source: <pull.1626.git.1703539287.gitgitgadget@gmail.com> |
|
This patch series was integrated into seen via git@63be843. |
|
There was a status update in the "Cooking" section about the branch Docfix. Needs review. source: <pull.1626.git.1703539287.gitgitgadget@gmail.com> |
|
This patch series was integrated into seen via git@4408167. |
|
There was a status update in the "Cooking" section about the branch Docfix. Needs review. source: <pull.1626.git.1703539287.gitgitgadget@gmail.com> |
|
This patch series was integrated into seen via git@17a4e8a. |
|
This patch series was integrated into seen via git@3b1934e. |
|
There was a status update in the "Cooking" section about the branch Docfix. Needs review. source: <pull.1626.git.1703539287.gitgitgadget@gmail.com> |
|
This patch series was integrated into seen via git@54ffad0. |
|
This patch series was integrated into seen via git@9108b67. |
|
This patch series was integrated into seen via git@fc7af06. |
|
There was a status update in the "Cooking" section about the branch Docfix. Needs review. source: <pull.1626.git.1703539287.gitgitgadget@gmail.com> |
|
This patch series was integrated into seen via git@4dfd20a. |
|
This patch series was integrated into seen via git@1204224. |
|
There was a status update in the "Cooking" section about the branch Docfix. Needs review. source: <pull.1626.git.1703539287.gitgitgadget@gmail.com> |
|
This patch series was integrated into seen via git@3dcd43f. |
|
This patch series was integrated into seen via git@94d74e5. |
|
This patch series was integrated into seen via git@9a093bb. |
|
This patch series was integrated into seen via git@36a3bfc. |
|
This patch series was integrated into seen via git@72f72ee. |
|
This patch series was integrated into seen via git@4c3c855. |
|
There was a status update in the "Cooking" section about the branch Docfix. Will merge to 'next'. source: <pull.1626.git.1703539287.gitgitgadget@gmail.com> |
|
This patch series was integrated into seen via git@c0f66a1. |
|
There was a status update in the "Cooking" section about the branch Docfix. Will merge to 'next'. source: <pull.1626.git.1703539287.gitgitgadget@gmail.com> |
|
This patch series was integrated into seen via git@798074c. |
|
This patch series was integrated into next via git@047da8c. |
|
This patch series was integrated into seen via git@47b5cf6. |
|
There was a status update in the "Cooking" section about the branch Docfix. Will merge to 'master'. source: <pull.1626.git.1703539287.gitgitgadget@gmail.com> |
|
This patch series was integrated into seen via git@ab61a68. |
|
This patch series was integrated into seen via git@ae1588d. |
|
This patch series was integrated into seen via git@b0425ab. |
|
This patch series was integrated into seen via git@d4b6719. |
|
This patch series was integrated into seen via git@2a10505. |
|
This patch series was integrated into master via git@2a10505. |
|
This patch series was integrated into next via git@2a10505. |
|
Closed via 2a10505. |
While setting up a check of (the absence of) translations of commands, options and environment variable in the manpages in the manpage translation project, some false positives appeared.
Here is a series that enforces the formatting rules for placeholders in documentation and help.