From: Taylor Blau <me@ttaylorr.com>
To: Jeff Hostetler <git@jeffhostetler.com>
Cc: Rudy Rigot via GitGitGadget <gitgitgadget@gmail.com>,
git@vger.kernel.org, Rudy Rigot <rudy.rigot@gmail.com>
Subject: Re: [PATCH v2] status: long status advice adapted to recent capabilities
Date: Wed, 2 Nov 2022 19:59:27 -0400 [thread overview]
Message-ID: <Y2MEXyhh2cJ14ba9@nand.local> (raw)
In-Reply-To: <8abc5272-4e01-e793-5155-ea116e9ad4fd@jeffhostetler.com>
On Wed, Nov 02, 2022 at 03:45:18PM -0400, Jeff Hostetler wrote:
> Let me suggest an alternative commit message. We want to lead with a
> "command" -- as in: "make Git do this" or "teach Git to do this". Then
> explain why. Maybe something like:
>
> [...]
Excellent suggestions, thank you.
> > @@ -1870,13 +1884,25 @@ static void wt_longstatus_print(struct wt_status *s)
> > wt_longstatus_print_other(s, &s->untracked, _("Untracked files"), "add");
> > if (s->show_ignored_mode)
> > wt_longstatus_print_other(s, &s->ignored, _("Ignored files"), "add -f");
> > - if (advice_enabled(ADVICE_STATUS_U_OPTION) && 2000 < s->untracked_in_ms) {
> > - status_printf_ln(s, GIT_COLOR_NORMAL, "%s", "");
> > - status_printf_ln(s, GIT_COLOR_NORMAL,
> > - _("It took %.2f seconds to enumerate untracked files. 'status -uno'\n"
> > - "may speed it up, but you have to be careful not to forget to add\n"
> > - "new files yourself (see 'git help status')."),
> > - s->untracked_in_ms / 1000.0);
> > + if (uf_was_slow(s->untracked_in_ms)) {
> > + if (advice_enabled(ADVICE_STATUS_U_OPTION)) {
> > + status_printf_ln(s, GIT_COLOR_NORMAL, "%s", "");
> > + if (s->repo->settings.core_untracked_cache == UNTRACKED_CACHE_WRITE) {
> > + status_printf_ln(s, GIT_COLOR_NORMAL,
> > + _("It took %.2f seconds to enumerate untracked files,\n"
> > + "but this is currently being cached, with fsmonitor %s."),
> > + s->untracked_in_ms / 1000.0,
> > + (fsm_mode > FSMONITOR_MODE_DISABLED) ? "ON" : "OFF");
> > + } else {
> > + status_printf_ln(s, GIT_COLOR_NORMAL,
> > + _("It took %.2f seconds to enumerate untracked files."),
> > + s->untracked_in_ms / 1000.0);
> > + }
> > + status_printf_ln(s, GIT_COLOR_NORMAL,
> > + _("See https://git-scm.com/docs/git-status#_untracked_files_and_status_speed\n"
> > + "for configuration options that may improve that time."));
> > + status_printf_ln(s, GIT_COLOR_NORMAL, "%s", "");
> > + }
>
> I'm not sure I like the various mixture of messages here. Maybe
> it would be better with a single simple message:
>
> _("It took %.2f seconds to enumerate untracked files.\n"
> "See 'git help status' for information on how to improve this.")
>
> This keeps all of the information in the documentation rather
> than having part of it here in the code.
>
> Also, we should refer to the documentation via `git help` rather
> than as a link to the website.
I agree with your suggestion of not linking out to git-scm.com here, but
I wonder if we could get by without mentioning 'git help' here, either.
Presumably looking up an unknown configuration variable with 'man
git-config' is easy enough.
Thanks,
Taylor
next prev parent reply other threads:[~2022-11-02 23:59 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-15 13:04 [PATCH] fsmonitor: long status advice adapted to the fsmonitor use case Rudy Rigot via GitGitGadget
2022-10-15 13:08 ` Rudy Rigot
2022-10-17 15:39 ` Jeff Hostetler
2022-10-17 16:59 ` Rudy Rigot
2022-10-20 12:56 ` Jeff Hostetler
2022-10-20 20:17 ` Rudy Rigot
2022-10-24 14:55 ` Jeff Hostetler
2022-10-29 0:06 ` [PATCH v2] status: long status advice adapted to recent capabilities Rudy Rigot via GitGitGadget
2022-11-02 19:45 ` Jeff Hostetler
2022-11-02 20:34 ` Rudy Rigot
2022-11-02 23:59 ` Taylor Blau [this message]
2022-11-03 14:28 ` Rudy Rigot
2022-11-04 8:52 ` Ævar Arnfjörð Bjarmason
2022-11-04 15:33 ` Rudy Rigot
2022-11-04 21:38 ` Taylor Blau
2022-11-02 21:27 ` [PATCH v3] " Rudy Rigot via GitGitGadget
2022-11-04 21:40 ` Taylor Blau
2022-11-07 20:02 ` Derrick Stolee
2022-11-07 23:19 ` Taylor Blau
2022-11-15 16:38 ` Jeff Hostetler
2022-11-07 20:01 ` Derrick Stolee
2022-11-07 20:20 ` Eric Sunshine
2022-11-07 20:31 ` Rudy Rigot
2022-11-10 4:46 ` [PATCH v4] " Rudy Rigot via GitGitGadget
2022-11-10 5:42 ` Eric Sunshine
2022-11-10 17:01 ` Rudy Rigot
2022-11-10 17:30 ` Eric Sunshine
2022-11-10 17:47 ` Rudy Rigot
2022-11-10 20:04 ` [PATCH v5] " Rudy Rigot via GitGitGadget
2022-11-15 16:39 ` Jeff Hostetler
2022-11-15 16:42 ` Rudy Rigot
2022-11-15 17:26 ` Eric Sunshine
2022-11-15 17:45 ` Rudy Rigot
2022-11-15 18:06 ` Eric Sunshine
2022-11-15 18:08 ` Rudy Rigot
2022-11-15 21:19 ` [PATCH v6] " Rudy Rigot via GitGitGadget
2022-11-21 5:06 ` Eric Sunshine
2022-11-21 15:54 ` Rudy Rigot
2022-11-21 16:17 ` Eric Sunshine
2022-11-22 16:52 ` Rudy Rigot
2022-11-22 17:18 ` Eric Sunshine
2022-11-22 17:24 ` Eric Sunshine
2022-11-22 17:29 ` Rudy Rigot
2022-11-22 17:40 ` Eric Sunshine
2022-11-22 18:07 ` Eric Sunshine
2022-11-22 19:19 ` Rudy Rigot
2022-11-22 19:48 ` Eric Sunshine
2022-11-22 16:59 ` [PATCH v7] status: modernize git-status "slow untracked files" advice Rudy Rigot via GitGitGadget
2022-11-22 22:07 ` [PATCH v8] " Rudy Rigot via GitGitGadget
2022-11-25 4:58 ` Junio C Hamano
2022-11-29 15:21 ` Rudy Rigot
2022-11-30 0:51 ` Rudy Rigot
2022-11-30 0:52 ` [PATCH v9] " Rudy Rigot via GitGitGadget
2022-12-01 6:48 ` Junio C Hamano
2022-12-01 15:16 ` Rudy Rigot
2022-12-01 22:45 ` Junio C Hamano
2022-12-01 22:57 ` Rudy Rigot
2023-05-11 5:17 ` [PATCH v8] " Eric Sunshine
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=Y2MEXyhh2cJ14ba9@nand.local \
--to=me@ttaylorr.com \
--cc=git@jeffhostetler.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=rudy.rigot@gmail.com \
/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).