{"thread":{"id":"57563","subject":"[PATCH] maintenance: fix synopsis in documentation","startedAt":"2022-03-15T17:42:03Z","lastAt":"2022-03-15T17:57:30Z","messageCount":2,"participants":["Derrick Stolee via GitGitGadget","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"451404","messageId":"pull.1178.git.1647366104967.gitgitgadget@gmail.com","threadId":"57563","inReplyTo":null,"subject":"[PATCH] maintenance: fix synopsis in documentation","fromName":"Derrick Stolee via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2022-03-15T17:41:44Z","receivedAt":"2022-03-15T17:42:03Z","isPatch":true,"sender":{"key":"stolee@gmail.com","avatar":"https://avatars.githubusercontent.com/u/570044?v=4"},"body":"From: Derrick Stolee <derrickstolee@github.com>\n\nThe synopsis for 'git maintenance' did not include the commands other\nthan the 'run' command. Update this to include the others. The 'start'\ncommand is the only one of these that parses additional options, and\nthen only the --scheduler option.\n\nAlso move the 'register' command down after 'stop' and before\n'unregister' for a logical grouping of the commands instead of an\nalphabetical one. The diff makes it look as three other commands are\nmoved up.\n\nSigned-off-by: Derrick Stolee <derrickstolee@github.com>\n---\n    maintenance: fix synopsis in documentation\n    \n    This is a quick fix for an issue I noticed during another review [1].\n    \n    Thanks, -Stolee\n    \n    [1]\n    https://lore.kernel.org/git/dd9413da-1b8c-2adf-c471-e5fd4230375c@github.com/\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-1178%2Fderrickstolee%2Fmaintenance-docs-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1178/derrickstolee/maintenance-docs-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/1178\n\n Documentation/git-maintenance.txt | 38 ++++++++++++++++---------------\n 1 file changed, 20 insertions(+), 18 deletions(-)\n\ndiff --git a/Documentation/git-maintenance.txt b/Documentation/git-maintenance.txt\nindex e2cfb68ab57..e56bad28c65 100644\n--- a/Documentation/git-maintenance.txt\n+++ b/Documentation/git-maintenance.txt\n@@ -10,6 +10,8 @@ SYNOPSIS\n --------\n [verse]\n 'git maintenance' run [<options>]\n+'git maintenance' start [--scheduler=<scheduler>]\n+'git maintenance' (stop|register|unregister)\n \n \n DESCRIPTION\n@@ -29,6 +31,24 @@ Git repository.\n SUBCOMMANDS\n -----------\n \n+run::\n+\tRun one or more maintenance tasks. If one or more `--task` options\n+\tare specified, then those tasks are run in that order. Otherwise,\n+\tthe tasks are determined by which `maintenance.<task>.enabled`\n+\tconfig options are true. By default, only `maintenance.gc.enabled`\n+\tis true.\n+\n+start::\n+\tStart running maintenance on the current repository. This performs\n+\tthe same config updates as the `register` subcommand, then updates\n+\tthe background scheduler to run `git maintenance run --scheduled`\n+\ton an hourly basis.\n+\n+stop::\n+\tHalt the background maintenance schedule. The current repository\n+\tis not removed from the list of maintained repositories, in case\n+\tthe background maintenance is restarted later.\n+\n register::\n \tInitialize Git config values so any scheduled maintenance will\n \tstart running on this repository. This adds the repository to the\n@@ -55,24 +75,6 @@ task:\n setting `maintenance.auto = false` in the current repository. This config\n setting will remain after a `git maintenance unregister` command.\n \n-run::\n-\tRun one or more maintenance tasks. If one or more `--task` options\n-\tare specified, then those tasks are run in that order. Otherwise,\n-\tthe tasks are determined by which `maintenance.<task>.enabled`\n-\tconfig options are true. By default, only `maintenance.gc.enabled`\n-\tis true.\n-\n-start::\n-\tStart running maintenance on the current repository. This performs\n-\tthe same config updates as the `register` subcommand, then updates\n-\tthe background scheduler to run `git maintenance run --scheduled`\n-\ton an hourly basis.\n-\n-stop::\n-\tHalt the background maintenance schedule. The current repository\n-\tis not removed from the list of maintained repositories, in case\n-\tthe background maintenance is restarted later.\n-\n unregister::\n \tRemove the current repository from background maintenance. This\n \tonly removes the repository from the configured list. It does not\n\nbase-commit: 1a4874565fa3b6668042216189551b98b4dc0b1b\n-- \ngitgitgadget\n"},{"id":"451407","messageId":"xmqqmthrdrp8.fsf@gitster.g","threadId":"57563","inReplyTo":"pull.1178.git.1647366104967.gitgitgadget@gmail.com","subject":"Re: [PATCH] maintenance: fix synopsis in documentation","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2022-03-15T17:57:23Z","receivedAt":"2022-03-15T17:57:30Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Derrick Stolee via GitGitGadget\" <gitgitgadget@gmail.com> writes:\n\n> From: Derrick Stolee <derrickstolee@github.com>\n>\n> The synopsis for 'git maintenance' did not include the commands other\n> than the 'run' command. Update this to include the others. The 'start'\n> command is the only one of these that parses additional options, and\n> then only the --scheduler option.\n>\n> Also move the 'register' command down after 'stop' and before\n> 'unregister' for a logical grouping of the commands instead of an\n> alphabetical one. The diff makes it look as three other commands are\n> moved up.\n\nWill queue.  Thanks.\n"}]}