From: "Jean-Noël Avila" <jn.avila@free.fr>
To: git@vger.kernel.org
Cc: "Jean-Noël Avila" <jn.avila@free.fr>
Subject: [PATCH v3 00/10] doc: fix grammar rules in commands' syntax
Date: Sat, 6 Nov 2021 19:48:48 +0100 [thread overview]
Message-ID: <20211106184858.11500-1-jn.avila@free.fr> (raw)
In-Reply-To: <pull.1066.git.1635261072531.gitgitgadget@gmail.com>
There are command expressions which do not follow the grammar syntax rules.
According to the coding guidelines, the placeholders must:
* be in small letters
* enclosed in angle brackets
* use hyphens as spaces
They also must represent tokens' meaning as atomic entities.
Some fixups for git-credential, git-ls-files, git-init and git-http-push.
changes since v1:
* split changes across simpler commits
changes since v2:
* remove back-quote formatting of placeholders from patches
* revert renaming <bool> placeholder
Jean-Noël Avila (9):
doc: fix git credential synopsis
doc: split placeholders as individual tokens
doc: express grammar placeholders between angle brackets
doc: use only hyphens as word separators in placeholders
doc: git-ls-files: express options as optional alternatives
doc: use three dots for indicating repetition instead of star
doc: uniformize <URL> placeholders' case
doc: git-http-push: describe the refs as pattern pairs
doc: git-init: clarify file modes in octal.
Junio C Hamano (1):
init doc: --shared=0xxx does not give umask but perm bits
Documentation/date-formats.txt | 6 +--
Documentation/git-archimport.txt | 14 +++----
Documentation/git-checkout.txt | 36 +++++++++---------
Documentation/git-cherry-pick.txt | 6 +--
Documentation/git-clone.txt | 8 ++--
Documentation/git-config.txt | 46 +++++++++++------------
Documentation/git-credential.txt | 2 +-
Documentation/git-cvsexportcommit.txt | 4 +-
Documentation/git-cvsimport.txt | 8 ++--
Documentation/git-diff-files.txt | 2 +-
Documentation/git-diff-index.txt | 2 +-
Documentation/git-diff-tree.txt | 2 +-
Documentation/git-fsck.txt | 2 +-
Documentation/git-gui.txt | 2 +-
Documentation/git-help.txt | 6 +--
Documentation/git-http-fetch.txt | 2 +-
Documentation/git-http-push.txt | 15 ++++----
Documentation/git-init-db.txt | 2 +-
Documentation/git-init.txt | 27 ++++++++------
Documentation/git-log.txt | 8 ++--
Documentation/git-ls-files.txt | 6 +--
Documentation/git-merge-index.txt | 2 +-
Documentation/git-p4.txt | 8 ++--
Documentation/git-pack-objects.txt | 4 +-
Documentation/git-pack-redundant.txt | 2 +-
Documentation/git-reflog.txt | 4 +-
Documentation/git-remote.txt | 8 ++--
Documentation/git-request-pull.txt | 8 ++--
Documentation/git-shortlog.txt | 8 ++--
Documentation/git-sparse-checkout.txt | 2 +-
Documentation/git-stage.txt | 2 +-
Documentation/git-svn.txt | 2 +-
Documentation/git-web--browse.txt | 2 +-
Documentation/gitcredentials.txt | 4 +-
Documentation/gitsubmodules.txt | 2 +-
Documentation/gitworkflows.txt | 6 +--
Documentation/pretty-formats.txt | 54 +++++++++++++--------------
Documentation/urls-remotes.txt | 8 ++--
builtin/credential.c | 2 +-
39 files changed, 168 insertions(+), 166 deletions(-)
--
2.33.1
next prev parent reply other threads:[~2021-11-06 18:49 UTC|newest]
Thread overview: 49+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-26 15:11 [PATCH] doc: fix grammar rules in commands'syntax Jean-Noël Avila via GitGitGadget
2021-10-26 18:21 ` Eric Sunshine
2021-10-27 13:01 ` Jean-Noël Avila
2021-10-27 18:56 ` Martin Ågren
2021-10-27 20:08 ` Eric Sunshine
2021-10-28 9:31 ` Jean-Noël Avila
2021-10-28 18:47 ` Martin Ågren
2021-10-28 16:21 ` [PATCH v2 0/9] doc: fix grammar rules in commands' syntax Jean-Noël Avila via GitGitGadget
2021-10-28 16:21 ` [PATCH v2 1/9] doc: fix git credential synopsis Jean-Noël Avila via GitGitGadget
2021-10-28 16:21 ` [PATCH v2 2/9] doc: split placeholders as individual tokens Jean-Noël Avila via GitGitGadget
2021-10-28 18:45 ` Martin Ågren
2021-10-28 16:21 ` [PATCH v2 3/9] doc: express grammar placeholders between angle brackets Jean-Noël Avila via GitGitGadget
2021-10-28 17:46 ` Eric Sunshine
2021-10-28 19:36 ` Junio C Hamano
2021-10-28 16:21 ` [PATCH v2 4/9] doc: use only hyphens as word separators in placeholders Jean-Noël Avila via GitGitGadget
2021-10-28 18:47 ` Martin Ågren
2021-10-28 19:35 ` Junio C Hamano
2021-10-31 18:58 ` Eli Schwartz
2021-10-31 20:23 ` Jean-Noël AVILA
2021-11-01 6:47 ` Junio C Hamano
2021-11-03 12:46 ` Jean-Noël Avila
2021-11-03 16:28 ` Junio C Hamano
2021-11-04 0:38 ` Johannes Schindelin
2021-11-04 17:36 ` Junio C Hamano
2021-11-07 12:40 ` Eli Schwartz
2021-10-28 16:22 ` [PATCH v2 5/9] doc: git-ls-files: express options as optional alternatives Jean-Noël Avila via GitGitGadget
2021-10-28 16:22 ` [PATCH v2 6/9] doc: use three dots for indicating repetition instead of star Jean-Noël Avila via GitGitGadget
2021-10-28 16:22 ` [PATCH v2 7/9] doc: uniformize <URL> placeholders' case Jean-Noël Avila via GitGitGadget
2021-10-28 17:53 ` Junio C Hamano
2021-10-28 16:22 ` [PATCH v2 8/9] doc: git-http-push: describe the refs as pattern pairs Jean-Noël Avila via GitGitGadget
2021-10-28 17:55 ` Junio C Hamano
2021-10-28 16:22 ` [PATCH v2 9/9] doc: git-init: clarify file modes in octal Jean-Noël Avila via GitGitGadget
2021-10-28 17:17 ` Junio C Hamano
2021-10-28 17:25 ` Junio C Hamano
2021-10-28 19:22 ` [PATCH v2 0/9] doc: fix grammar rules in commands' syntax Junio C Hamano
2021-11-06 18:48 ` Jean-Noël Avila [this message]
2021-11-06 18:48 ` [PATCH v3 01/10] doc: fix git credential synopsis Jean-Noël Avila
2021-11-06 18:48 ` [PATCH v3 02/10] doc: split placeholders as individual tokens Jean-Noël Avila
2021-11-06 18:48 ` [PATCH v3 03/10] doc: express grammar placeholders between angle brackets Jean-Noël Avila
2021-11-06 18:48 ` [PATCH v3 04/10] doc: use only hyphens as word separators in placeholders Jean-Noël Avila
2021-11-06 18:48 ` [PATCH v3 05/10] doc: git-ls-files: express options as optional alternatives Jean-Noël Avila
2021-11-06 18:48 ` [PATCH v3 06/10] doc: use three dots for indicating repetition instead of star Jean-Noël Avila
2021-11-06 18:48 ` [PATCH v3 07/10] doc: uniformize <URL> placeholders' case Jean-Noël Avila
2021-11-06 18:48 ` [PATCH v3 08/10] doc: git-http-push: describe the refs as pattern pairs Jean-Noël Avila
2021-11-06 18:48 ` [PATCH v3 09/10] doc: git-init: clarify file modes in octal Jean-Noël Avila
2021-11-07 13:20 ` Johannes Altmanninger
2021-11-06 18:48 ` [PATCH v3 10/10] init doc: --shared=0xxx does not give umask but perm bits Jean-Noël Avila
2021-11-07 13:22 ` Johannes Altmanninger
2021-11-09 17:32 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20211106184858.11500-1-jn.avila@free.fr \
--to=jn.avila@free.fr \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).