X Tutup
Skip to content

gc: add git maintenance list command#2201

Open
remyleone wants to merge 1 commit intogit:masterfrom
remyleone:maintenance_list
Open

gc: add git maintenance list command#2201
remyleone wants to merge 1 commit intogit:masterfrom
remyleone:maintenance_list

Conversation

@remyleone
Copy link

List all repositories registered for background maintenance. This displays the paths of all repositories that are configured in the maintenance.repo config variable. By default, it reads from the global config, but you can specify a different config file with the --config-file option.

Thanks for taking the time to contribute to Git! Please be advised that the
Git community does not use github.com for their contributions. Instead, we use
a mailing list (git@vger.kernel.org) for code submissions, code reviews, and
bug reports. Nevertheless, you can use GitGitGadget (https://gitgitgadget.github.io/)
to conveniently send your Pull Requests commits to our mailing list.

For a single-commit pull request, please leave the pull request description
empty
: your commit message itself should describe your changes.

Please read the "guidelines for contributing" linked above!

@gitgitgadget-git
Copy link

Welcome to GitGitGadget

Hi @remyleone, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that either:

  • Your Pull Request has a good description, if it consists of multiple commits, as it will be used as cover letter.
  • Your Pull Request description is empty, if it consists of a single commit, as the commit message should be descriptive enough by itself.

You can CC potential reviewers by adding a footer to the PR description with the following syntax:

CC: Revi Ewer <revi.ewer@example.com>, Ill Takalook <ill.takalook@example.net>

NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description,
because it will result in a malformed CC list on the mailing list. See
example.

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

  • the lines should not exceed 76 columns,
  • the first line should be like a header and typically start with a prefix like "tests:" or "revisions:" to state which subsystem the change is about, and
  • the commit messages' body should be describing the "why?" of the change.
  • Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

Both the person who commented /allow and the PR author are able to /allow you.

An alternative is the channel #git-devel on the Libera Chat IRC network:

<newcontributor> I've just created my first PR, could someone please /allow me? https://github.com/gitgitgadget/git/pull/12345
<veteran> newcontributor: it is done
<newcontributor> thanks!

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this. Note that any reviewers CC'd via the list in the PR description will not actually be sent emails.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail).

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the (raw) link), then import it into your mail program. If you use GMail, you can do this via:

curl -g --user "<EMailAddress>:<Password>" \
    --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

To iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description):

Changes since v1:
- Fixed a typo in the commit message (found by ...)
- Added a code comment to ... as suggested by ...
...

To send a new iteration, just add another PR comment with the contents: /submit.

Need help?

New contributors who want advice are encouraged to join git-mentoring@googlegroups.com, where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join.

You may also be able to find help in real time in the developer IRC channel, #git-devel on Libera Chat. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.

@gitgitgadget-git
Copy link

There is an issue in commit 2836155:
gc: add git maintenance list command

  • Lines in the body of the commit messages should be wrapped between 60 and 76 characters.
    Indented lines, and lines without whitespace, are exempt

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a git maintenance list subcommand to display all repositories registered for background maintenance. This new command provides visibility into which repositories are configured in the maintenance.repo config variable, supporting both global config (default) and custom config files via the --config-file option.

Changes:

  • Added maintenance_list() function in builtin/gc.c to implement the list subcommand
  • Added test coverage for the new list command with both default and --config-file scenarios
  • Updated documentation to describe the new list subcommand

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
builtin/gc.c Implements the maintenance list subcommand with config file reading logic and repository listing functionality
t/t7900-maintenance.sh Adds two test cases to verify the list command works with global config and custom config files
Documentation/git-maintenance.adoc Documents the new list subcommand in the SUBCOMMANDS section

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@dscho
Copy link
Member

dscho commented Feb 17, 2026

/allow

@gitgitgadget-git
Copy link

User remyleone is now allowed to use GitGitGadget.

@remyleone
Copy link
Author

Thanks @dscho :-) What would be the next steps for getting it merge?

@dscho
Copy link
Member

dscho commented Feb 25, 2026

What would be the next steps for getting it merge?

I hoped that the information at #2201 (comment) would be instructive?

Basically, the first step now is to /preview it, and then to /submit it to the git mailing list for review. For reasons of their own, the Git project does not use GitHub, nor does it use PRs or merge requests. It uses strictly mailing list centric process for patch submission and review. So you will have to subject your contribution to that.

@remyleone
Copy link
Author

/preview

@remyleone remyleone force-pushed the maintenance_list branch 2 times, most recently from b2e5580 to 05a1af6 Compare February 25, 2026 17:22
List all repositories registered for background maintenance.

This displays the paths of all repositories that are configured in the
maintenance.repo config variable. By default, it reads from the global
config, but you can specify a different config file with the
--config-file option.

Signed-off-by: Rémy Léone <rleone@scaleway.com>
@remyleone
Copy link
Author

/submit

@gitgitgadget-git
Copy link

Submitted as pull.2201.git.git.1772040758787.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-git-2201/remyleone/maintenance_list-v1

To fetch this version to local tag pr-git-2201/remyleone/maintenance_list-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-git-2201/remyleone/maintenance_list-v1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

X Tutup