From: Junio C Hamano <gitster@pobox.com>
To: git@vger.kernel.org
Subject: [PATCH v3 0/3] doc: spell configuration variable names in camelCase
Date: Wed, 24 Feb 2021 12:26:38 -0800 [thread overview]
Message-ID: <20210224202641.913770-1-gitster@pobox.com> (raw)
In-Reply-To: <xmqqlfbe1sim.fsf@gitster.g>
I said in the first review on Denton's patch
This obviously does not have to be part of this miniseries, but I
wonder if we should have a list of all the configuration variables
in one place that we can use to record the canonical spelling of
these variables. As
$ git grep -h -E -i \
-e '^[a-z][-a-z0-9]*\.[a-z][-a-z0-9]*::' \
-e '^[a-z][-a-z0-9]*\.(\*|<?[a-z][-a-z0-9]*>?)\.(\*|<?[a-z][-a-z0-9]*>?)::' \
Documentation/config
gives many hits with camelCased names, it might be a good place to
start.
Pretending that the above gives a good "canonical list" (it does not
yet, if you look at the hits), I got curious how far we can go.
Massaging the output from the above into config-variables.lst
$ ... above command ... |
sed -e 's/::$//' |
sort -u >config-variables.lst
and then to extract use of these tokens in the main part of the
documentation like this:
$ git grep -h -o -i -F -f config-variables.lst -- \
Documentation/ ':!Documentation/RelNotes/' |
sort -u >config-usage.lst
gives us something we can compare with the "canonical" usage list.
$ comm -3 config-usage.lst config-variables.lst
blame.blankboundary
core.excludesfile
core.filemode
core.gitproxy
core.ignorestat
core.logallrefupdates
core.repositoryformatversion
core.trustCtime
http.sslverify
http.sslversion
i18n.commitencoding
push.pushoption
remote.<name>.partialCloneFilter
remote.pushdefault
repack.UseDeltaBaseOffset
sendemail.aliasesfile
showbranch.default
transfer.hiderefs
uploadArchive.allowUnreachable
Some of them may be false hits, some may be showing that the copy in
Documentation/config/ are spelled in all lowercase, but the majority
of the hits above seem to be genuine errors similar to what you fixed
in your patch.
Thanks.
and as I identified a handful of low hanging fruits that way, here
are a few patches on top of his patch that started the whole thing.
I think we should make sure Documentation/config/*.txt
- spells all the configuration variables in the way we want to see
them, and
- covers all the configuration variables.
before we can proceed with more low hanging fruits with confidence,
as I do think the coverage is very good, but I know it is not 100%,
and the eventual goal should be to make sure we can teach lint-docs
to catch these before the reviewers even see them.
Denton Liu (1):
i18n.txt: camel case and monospace "i18n.commitEncoding"
Junio C Hamano (2):
blame-options.txt: camelcase blame.blankBoundary
index-format doc: camelCase core.excludesFile
Documentation/blame-options.txt | 2 +-
Documentation/git-am.txt | 2 +-
Documentation/git-mailinfo.txt | 4 ++--
Documentation/i18n.txt | 2 +-
Documentation/technical/index-format.txt | 4 ++--
5 files changed, 7 insertions(+), 7 deletions(-)
--
2.30.1-826-g07a034c5ea
next prev parent reply other threads:[~2021-02-24 20:28 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-23 6:39 [PATCH 0/3] docs: misc cleanup Denton Liu
2021-02-23 6:39 ` [PATCH 1/3] i18n.txt: camel case and monospace "i18n.commitEncoding" Denton Liu
2021-02-23 19:15 ` Junio C Hamano
2021-02-23 19:26 ` [PATCH v2] " Junio C Hamano
2021-02-23 19:32 ` Eric Sunshine
2021-02-23 19:41 ` Junio C Hamano
2021-02-24 20:26 ` Junio C Hamano [this message]
2021-02-24 20:26 ` [PATCH v3 1/3] " Junio C Hamano
2021-02-24 20:26 ` [PATCH v3 2/3] blame-options.txt: camelcase blame.blankBoundary Junio C Hamano
2021-02-24 20:26 ` [PATCH v3 3/3] index-format doc: camelCase core.excludesFile Junio C Hamano
2021-02-23 6:39 ` [PATCH 2/3] git-cat-file.txt: monospace args and placeholders Denton Liu
2021-02-23 6:44 ` Eric Sunshine
2021-02-23 6:59 ` [PATCH v1.1 2/3] git-cat-file.txt: monospace args, placeholders and filenames Denton Liu
2021-02-23 6:39 ` [PATCH 3/3] git-cat-file.txt: remove references to "sha1" Denton Liu
2021-02-23 6:48 ` Eric Sunshine
2021-02-23 7:17 ` [PATCH v2] " Denton Liu
2021-02-23 7:48 ` Junio C Hamano
2021-03-03 9:21 ` [PATCH v2 0/2] git-cat-file.txt: doc cleanup Denton Liu
2021-03-03 9:21 ` [PATCH v2 1/2] git-cat-file.txt: monospace args, placeholders and filenames Denton Liu
2021-03-03 9:21 ` [PATCH v2 2/2] git-cat-file.txt: remove references to "sha1" Denton Liu
2021-03-04 0:43 ` [PATCH v2 0/2] git-cat-file.txt: doc cleanup 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=20210224202641.913770-1-gitster@pobox.com \
--to=gitster@pobox.com \
--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).