From: Eric Sunshine <sunshine@sunshineco.com>
To: Derrick Stolee via GitGitGadget <gitgitgadget@gmail.com>
Cc: "Git List" <git@vger.kernel.org>,
"Jonathan Nieder" <jrnieder@gmail.com>,
"Jonathan Tan" <jonathantanmy@google.com>,
"Son Luong Ngoc" <sluongng@gmail.com>,
"Derrick Stolee" <stolee@gmail.com>,
"Đoàn Trần Công Danh" <congdanhqx@gmail.com>,
"Martin Ågren" <martin.agren@gmail.com>,
"Derrick Stolee" <derrickstolee@github.com>,
"Derrick Stolee" <dstolee@microsoft.com>
Subject: Re: [PATCH v2 2/4] maintenance: include 'cron' details in docs
Date: Wed, 11 Nov 2020 02:10:50 -0500 [thread overview]
Message-ID: <CAPig+cReatZ-iSLWreQqYLM7qONWvBLbDUNVH1dJV37VnmPBgw@mail.gmail.com> (raw)
In-Reply-To: <709a17372099351af3e3b9f2dddcd9ce220a9fcb.1604520368.git.gitgitgadget@gmail.com>
On Wed, Nov 4, 2020 at 3:06 PM Derrick Stolee via GitGitGadget
<gitgitgadget@gmail.com> wrote:
> Advanced and expert users may want to know how 'git maintenance start'
> schedules background maintenance in order to customize their own
> schedules beyond what the maintenance.* config values allow. Start a new
> set of sections in git-maintenance.txt that describe how 'cron' is used
> to run these tasks.
>
> This is particularly valuable for users who want to inspect what Git is
> doing or for users who want to customize the schedule further. Having a
> baseline can provide a way forward for users who have never worked with
> cron schedules.
A few comments below, not necessarily worth a re-roll...
> Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
> ---
> diff --git a/Documentation/git-maintenance.txt b/Documentation/git-maintenance.txt
> @@ -218,6 +218,60 @@ Further, the `git gc` command should not be combined with
> +The standard mechanism for scheduling background tasks on POSIX systems
> +is `cron`. This tool executes commands based on a given schedule. The
It is common in Git (and other Unix) documentation to refer to a Unix
tool by its man page reference. So, for instance, instead of `cron`,
we would say cron(8) since the `cron` man page is in section 8 of the
Unix manual.
> +The `<path>` string is loaded to specifically use the location for the
The word "loaded" sounds odd in this context.
> +`git` executable used in the `git maintenance start` command. This allows
> +for multiple versions to be compatible. However, if the same user runs
> +`git maintenance start` with multiple Git executables, then only the
> +latest executable will be used.
I had to read this paragraph four or five times to understand what it
is trying to say (assuming I do understand it). Perhaps it can be
rewritten more succinctly something like this:
The `crontab` entry specifies the full path of the `git`
executable to ensure that the `git` command run is the same one
with which `git maintenance start` was issued independent of
`PATH`.
> +These commands use `git for-each-repo --config=maintenance.repo` to run
> +`git maintenance run --schedule=<frequency>` on each repository listed in
> +the multi-valued `maintenance.repo` config option. These are typically
> +loaded from the user-specific global config located at `~/.gitconfig`.
I wonder if mentioning `~/.gitconfig` explicitly is wise since it
might also be at $XDG_CONFIG_HOME/git/config or some other location on
Windows. Perhaps it would be sufficient to mention only "global Git
configuration" or something.
> +If the config values are insufficient to achieve your desired background
> +maintenance schedule, then you can create your own schedule. If you run
> +`crontab -e`, then an editor will load with your user-specific `cron`
> +schedule. In that editor, you can add your own schedule lines. You could
> +start by adapting the default schedule listed earlier, or you could read
> +https://man7.org/linux/man-pages/man5/crontab.5.html[the `crontab` documentation]
For consistency with other parts of Git documentation, it might be
better to reference the `crontab` man page simply as crontab(5) rather
than providing an explicit URL.
> +for advanced scheduling techniques. Please do use the full path and
> +`--exec-path` techniques from the default schedule to ensure you are
> +executing the correct binaries in your schedule.
next prev parent reply other threads:[~2020-11-11 7:11 UTC|newest]
Thread overview: 83+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-03 14:03 [PATCH 0/3] Maintenance IV: Platform-specific background maintenance Derrick Stolee via GitGitGadget
2020-11-03 14:03 ` [PATCH 1/3] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2020-11-03 14:03 ` [PATCH 2/3] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2020-11-03 18:45 ` Eric Sunshine
2020-11-03 21:21 ` Derrick Stolee
2020-11-03 22:27 ` Eric Sunshine
2020-11-04 13:33 ` Derrick Stolee
2020-11-04 14:17 ` Derrick Stolee
2020-11-03 14:03 ` [PATCH 3/3] maintenance: use Windows scheduled tasks Derrick Stolee via GitGitGadget
2020-11-03 19:06 ` Eric Sunshine
2020-11-03 21:23 ` Derrick Stolee
2020-11-03 20:18 ` [PATCH 0/3] Maintenance IV: Platform-specific background maintenance Junio C Hamano
2020-11-03 20:21 ` Junio C Hamano
2020-11-03 21:09 ` Derrick Stolee
2020-11-03 22:30 ` Junio C Hamano
2020-11-04 13:02 ` Derrick Stolee
2020-11-04 17:00 ` Junio C Hamano
2020-11-04 18:43 ` Derrick Stolee
2020-11-04 20:06 ` [PATCH v2 0/4] " Derrick Stolee via GitGitGadget
2020-11-04 20:06 ` [PATCH v2 1/4] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2020-11-04 20:06 ` [PATCH v2 2/4] maintenance: include 'cron' details in docs Derrick Stolee via GitGitGadget
2020-11-11 7:10 ` Eric Sunshine [this message]
2020-11-04 20:06 ` [PATCH v2 3/4] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2020-11-11 8:12 ` Eric Sunshine
2020-11-12 13:42 ` Derrick Stolee
2020-11-12 16:43 ` Eric Sunshine
2020-11-04 20:06 ` [PATCH v2 4/4] maintenance: use Windows scheduled tasks Derrick Stolee via GitGitGadget
2020-11-11 8:59 ` Eric Sunshine
2020-11-12 13:56 ` Derrick Stolee
2020-11-13 14:00 ` [PATCH v3 0/4] Maintenance IV: Platform-specific background maintenance Derrick Stolee via GitGitGadget
2020-11-13 14:00 ` [PATCH v3 1/4] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2020-11-13 14:00 ` [PATCH v3 2/4] maintenance: include 'cron' details in docs Derrick Stolee via GitGitGadget
2020-11-13 14:00 ` [PATCH v3 3/4] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2020-11-13 20:19 ` Eric Sunshine
2020-11-13 20:42 ` Derrick Stolee
2020-11-13 20:53 ` Eric Sunshine
2020-11-13 20:56 ` Eric Sunshine
2020-11-13 14:00 ` [PATCH v3 4/4] maintenance: use Windows scheduled tasks Derrick Stolee via GitGitGadget
2020-11-13 20:44 ` Eric Sunshine
2020-11-13 21:32 ` Derrick Stolee
2020-11-13 21:40 ` Eric Sunshine
2020-11-16 13:13 ` Derrick Stolee
2020-11-13 20:47 ` [PATCH v3 0/4] Maintenance IV: Platform-specific background maintenance Eric Sunshine
2020-11-14 9:23 ` Eric Sunshine
2020-11-16 13:17 ` Derrick Stolee
2020-11-17 21:13 ` [PATCH v4 " Derrick Stolee via GitGitGadget
2020-11-17 21:13 ` [PATCH v4 1/4] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2020-11-17 21:13 ` [PATCH v4 2/4] maintenance: include 'cron' details in docs Derrick Stolee via GitGitGadget
2020-11-18 0:34 ` Eric Sunshine
2020-11-18 18:30 ` Derrick Stolee
2020-11-17 21:13 ` [PATCH v4 3/4] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2020-11-18 6:45 ` Eric Sunshine
2020-11-18 18:22 ` Derrick Stolee
2020-11-17 21:13 ` [PATCH v4 4/4] maintenance: use Windows scheduled tasks Derrick Stolee via GitGitGadget
2020-11-18 7:15 ` Eric Sunshine
2020-11-18 18:30 ` Derrick Stolee
2020-11-18 20:54 ` Eric Sunshine
2020-11-18 21:16 ` Derrick Stolee
2020-11-17 23:36 ` [PATCH v4 0/4] Maintenance IV: Platform-specific background maintenance Eric Sunshine
2020-11-24 2:20 ` Derrick Stolee
2020-11-24 2:59 ` Eric Sunshine
2020-11-17 23:54 ` Eric Sunshine
2020-11-24 4:16 ` [PATCH v5 " Derrick Stolee via GitGitGadget
2020-11-24 4:16 ` [PATCH v5 1/4] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2020-11-24 4:16 ` [PATCH v5 2/4] maintenance: include 'cron' details in docs Derrick Stolee via GitGitGadget
2020-11-24 4:16 ` [PATCH v5 3/4] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2020-11-24 4:16 ` [PATCH v5 4/4] maintenance: use Windows scheduled tasks Derrick Stolee via GitGitGadget
2020-11-27 9:08 ` Eric Sunshine
2020-12-09 19:28 ` [PATCH v6 0/4] Maintenance IV: Platform-specific background maintenance Derrick Stolee via GitGitGadget
2020-12-09 19:28 ` [PATCH v6 1/4] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2020-12-09 19:29 ` [PATCH v6 2/4] maintenance: include 'cron' details in docs Derrick Stolee via GitGitGadget
2020-12-09 19:29 ` [PATCH v6 3/4] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2020-12-09 19:29 ` [PATCH v6 4/4] maintenance: use Windows scheduled tasks Derrick Stolee via GitGitGadget
2020-12-10 0:32 ` [PATCH v6 0/4] Maintenance IV: Platform-specific background maintenance Junio C Hamano
2020-12-10 0:49 ` Eric Sunshine
2020-12-10 1:04 ` Junio C Hamano
2021-01-05 12:17 ` Derrick Stolee
2021-01-05 13:08 ` [PATCH v7 " Derrick Stolee via GitGitGadget
2021-01-05 13:08 ` [PATCH v7 1/4] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2021-01-05 13:08 ` [PATCH v7 2/4] maintenance: include 'cron' details in docs Derrick Stolee via GitGitGadget
2021-01-05 13:08 ` [PATCH v7 3/4] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2021-01-10 6:34 ` Eric Sunshine
2021-01-05 13:08 ` [PATCH v7 4/4] maintenance: use Windows scheduled tasks 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=CAPig+cReatZ-iSLWreQqYLM7qONWvBLbDUNVH1dJV37VnmPBgw@mail.gmail.com \
--to=sunshine@sunshineco.com \
--cc=congdanhqx@gmail.com \
--cc=derrickstolee@github.com \
--cc=dstolee@microsoft.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=jonathantanmy@google.com \
--cc=jrnieder@gmail.com \
--cc=martin.agren@gmail.com \
--cc=sluongng@gmail.com \
--cc=stolee@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).