From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: Derrick Stolee via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, gitster@pobox.com,
johannes.schindelin@gmx.de, Jeff King <peff@peff.net>,
Derrick Stolee <derrickstolee@github.com>
Subject: Re: [PATCH v2 3/3] *: avoid "whitelist"
Date: Fri, 15 Jul 2022 13:19:58 +0200 [thread overview]
Message-ID: <220715.86k08ezkbl.gmgdl@evledraar.gmail.com> (raw)
In-Reply-To: <0d862cbbebe1a9f47f72255217faf734b1db4055.1657852722.git.gitgitgadget@gmail.com>
On Fri, Jul 15 2022, Derrick Stolee via GitGitGadget wrote:
> From: Derrick Stolee <derrickstolee@github.com>
> [...]
> - logerror("'%s': not in whitelist", path);
> + logerror("'%s': not in directory list", path);
> return NULL; /* Fallthrough. Deny by default */
> }
> if (strict_paths && (!ok_paths || !*ok_paths))
> - die("option --strict-paths requires a whitelist");
> + die("option --strict-paths requires a directory list");
>
> if (base_path && !is_directory(base_path))
> die("base-path '%s' does not exist or is not a directory",
The former here is worse than before, which relates to the latter.
Put yourself in the shoes of a user who gets this error message. You
then do "man git-daemon", search for "whitelist", and the only thing
you'll find are references to --strict-paths and --interpolated-path,
which puts you on the right path.
IOW I don't care about the term "whitelist" here, I care that it it has
(goes and counts...) 5 occurances in the manpage, directorty has 16.
And SYNOPSIS of "git-daemon" says "...[<directory...]", so that
hypothehtical user is probably wondering e.g. if the directory they
provided on argv is bad. It's not just 5 v.s. 16, it's that we've
introduced jargon we only used for that feature, but now we use a vague
general term.
So we need to tell the user *what directory*. That's obviously easy, we
should refer back to the option that brought us here.
So per [1] I really welcome any improvements to the docs, but I was also
expecting to find various issues related to the origin of this series
blindly replacing things :( Please look a bit more at the bigger picture
beyond the specific hunks being changed, I might have missed some
similar issues on this read-through...
1. https://lore.kernel.org/git/220715.86sfn2zlkm.gmgdl@evledraar.gmail.com/
next prev parent reply other threads:[~2022-07-15 11:30 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-13 13:20 [PATCH 0/3] Use "allowlist" and "denylist" tree-wide Derrick Stolee via GitGitGadget
2022-07-13 13:20 ` [PATCH 1/3] Documentation: use allowlist and denylist Derrick Stolee via GitGitGadget
2022-07-13 15:21 ` Jeff King
2022-07-13 18:34 ` Derrick Stolee
2022-07-13 20:20 ` Junio C Hamano
2022-07-13 13:20 ` [PATCH 2/3] t/*: use allowlist Derrick Stolee via GitGitGadget
2022-07-13 13:20 ` [PATCH 3/3] *: use allowlist and denylist Derrick Stolee via GitGitGadget
2022-07-13 13:27 ` Johannes Schindelin
2022-07-13 15:23 ` Jeff King
2022-07-13 13:29 ` [PATCH 0/3] Use "allowlist" and "denylist" tree-wide Johannes Schindelin
2022-07-13 16:18 ` Junio C Hamano
2022-07-13 18:33 ` Derrick Stolee
2022-07-13 20:32 ` Junio C Hamano
2022-07-13 19:42 ` Ævar Arnfjörð Bjarmason
2022-07-13 22:28 ` Junio C Hamano
2022-07-15 2:25 ` Derrick Stolee
2022-07-13 20:02 ` Ævar Arnfjörð Bjarmason
2022-07-15 2:38 ` [PATCH v2 0/3] Remove use of "whitelist" Derrick Stolee via GitGitGadget
2022-07-15 2:38 ` [PATCH v2 1/3] Documentation: remove use of whitelist Derrick Stolee via GitGitGadget
2022-07-15 10:47 ` Ævar Arnfjörð Bjarmason
2022-07-19 14:21 ` Derrick Stolee
2022-07-15 2:38 ` [PATCH v2 2/3] t/*: avoid "whitelist" Derrick Stolee via GitGitGadget
2022-07-15 11:02 ` Ævar Arnfjörð Bjarmason
2022-07-19 15:09 ` Derrick Stolee
2022-07-19 15:26 ` Ævar Arnfjörð Bjarmason
2022-07-19 15:42 ` Derrick Stolee
2022-07-19 19:44 ` Junio C Hamano
2022-07-15 2:38 ` [PATCH v2 3/3] *: " Derrick Stolee via GitGitGadget
2022-07-15 11:19 ` Ævar Arnfjörð Bjarmason [this message]
2022-07-15 6:30 ` [PATCH v2 0/3] Remove use of "whitelist" Junio C Hamano
2022-07-15 16:16 ` Phillip Wood
2022-07-19 18:32 ` [PATCH v3 0/5] " Derrick Stolee via GitGitGadget
2022-07-19 18:32 ` [PATCH v3 1/5] daemon: clarify directory arguments Derrick Stolee via GitGitGadget
2022-07-19 18:32 ` [PATCH v3 2/5] git-cvsserver: clarify directory list Derrick Stolee via GitGitGadget
2022-07-19 18:32 ` [PATCH v3 3/5] git.txt: remove redundant language Derrick Stolee via GitGitGadget
2022-07-31 0:35 ` Jeff King
2022-07-19 18:32 ` [PATCH v3 4/5] t: avoid "whitelist" Derrick Stolee via GitGitGadget
2022-07-19 18:32 ` [PATCH v3 5/5] transport.c: " Derrick Stolee via GitGitGadget
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=220715.86k08ezkbl.gmgdl@evledraar.gmail.com \
--to=avarab@gmail.com \
--cc=derrickstolee@github.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=johannes.schindelin@gmx.de \
--cc=peff@peff.net \
/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).