Skip to content

config: read both home and xdg config in list --global [do not submit] #1926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 7 commits into from
Closed

config: read both home and xdg config in list --global [do not submit] #1926

wants to merge 7 commits into from

Conversation

delilahw
Copy link

@delilahw delilahw commented May 22, 2025 •
edited
Loading

This is Lilah's working tree with additional commits that may not be relevant to the contribution. They will be excluded from the final patch series, but I want to use CI to check my changes (e.g. commit message linting, which isn't normally included in forks' CI) 😇

delilahw added 6 commits May 22, 2025 16:32
@delilahw
lilah(config): add tracing
8d98751 
Do not submit this commit; it's only intended for debugging.

Signed-off-by: Delilah Ashley Wu <[email protected]>
@delilahw
config: refactor file error handling into function
99e712a 
Not actually required for the fix. I just wanted to do it hehe.
Could always split it out to another patch or keep the current code.

Signed-off-by: Delilah Ashley Wu <[email protected]>
@delilahw
config: read from config sequence for global scope
b85f0ed 
Based on
https://lore.kernel.org/git/[email protected].

We assumed that git config is always read from a single file, but that
is not the case for the global scope, which takes inputs from both
`$HOME/.gitconfig` and `$XDG_CONFIG_HOME/git/config`. The existing
`do_git_config_sequence()` function respects both locations, in addition
to other scopes. Hence, modify the function to support reading only the
global scope, by introducing new flags that exclude everything else
(i.e. `ignore_system` and `ignore_global`).

I've assumed that `config_source->scope == CONFIG_SCOPE_GLOBAL` iff
`--global` is specified. This allows us to call the modified
`do_git_config_sequence()` function when reading only the the global
scope, rather than calling
`git_config_from_file_with_options(..., "~/.gitconfig", ...)`. This
fixes the issue where `XDG_CONFIG_HOME` location is ignored in
`git config list --global`.

NB: The `ignore_global` flag is not set to truthy anywhere, so the
`if (!opts->ignore_global)` condition is always met. We can actually
remove this unused flag if we want.

The `opts->source.file` is still set in `builtin/config.c` because it is
required for write operations. I thought that this would be misleading
because there is no single source of truth for the source files in the
global scope. So I added comments that will (hopefully) clarify this.

Reported-by: Jade Lovelace <[email protected]>
Suggested-by: Glen Choo <[email protected]>
Signed-off-by: Delilah Ashley Wu <[email protected]>
@delilahw
config: keep bailing on unreadable global files
97664f2 
The expected existing behaviour for `git config list` is:
  A. Without `--global`, it should not bail on unreadable/non-existent
     global config files.
  B. With `--global`, it should bail when both `$HOME/.gitconfig` and
     `$XDG_CONFIG_HOME/git/config` are unreadable. It should not bail
     when one or more of them is readable.

The previous patch introduced a regression in scenario B; running
`git config list --global` would not fail after encountering an
unreadable global config file, e.g.
`GIT_CONFIG_GLOBAL=does-not-exist git config list --global` would exit
with status code 0.

Given that `config_source->scope == CONFIG_SCOPE_GLOBAL` iff `--global`
is specified, we can use this to determine whether to bail or not.
When both global config files are unreadable and we are restricted to
reading only the global scope, adjust the return code to be non-zero.

Signed-off-by: Delilah Ashley Wu <[email protected]>
@delilahw
config: test home and xdg files in list --global
ace72c4 
Checks for regressions in two existing behaviours of `git config list`,as described in the previous commit message:
    A. Without `--global`, it should not bail on unreadable/non-existent
       global config files.
    B. With `--global`, it should bail when both `$HOME/.gitconfig` and
       `$XDG_CONFIG_HOME/git/config` are unreadable. It should not bail
       when one or more of them is readable.

Also adds a test for the issue that this contribution solves.
    C. `git config list --global` should include contents from both
       `$HOME/.gitconfig` and `$XDG_CONFIG_HOME/git/config` (assuming
       they are readable), not just the former.

Signed-off-by: Delilah Ashley Wu <[email protected]>
@delilahw
lilah: Add nix flakes for my hot girl git-scm workspace
8c209c6 
Intentional --no-signoff; this commit should not be included in the
final patch series.
@delilahw delilahw changed the title config: read both home and xdg config in list --global config: read both home and xdg config in list --global [do not submit] May 22, 2025
@gitgitgadget GitGitGadget
Copy link

gitgitgadget bot commented May 22, 2025

Welcome to GitGitGadget

Hi @delilahw, 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 <[email protected]>, Ill Takalook <[email protected]>

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 [email protected], 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 GitGitGadget
Copy link

gitgitgadget bot commented May 22, 2025

There are issues in commit ace72c4:
config: test home and xdg files in list --global``
Lines in the body of the commit messages should be wrapped between 60 and 76 characters.
Indented lines, and lines without whitespace, are exempt

@gitgitgadget GitGitGadget
Copy link

gitgitgadget bot commented May 22, 2025

There are issues in commit 8c209c6:
lilah: Add nix flakes for my hot girl git-scm workspace
Prefixed commit message must be in lower case
Commit not signed off

@gitgitgadget GitGitGadget
Copy link

gitgitgadget bot commented May 23, 2025

There are issues in commit ace72c4:
config: test home and xdg files in list --global``
Lines in the body of the commit messages should be wrapped between 60 and 76 characters.
Indented lines, and lines without whitespace, are exempt

@gitgitgadget GitGitGadget
Copy link

gitgitgadget bot commented May 23, 2025

There are issues in commit 8c209c6:
lilah: Add nix flakes for my hot girl git-scm workspace
Prefixed commit message must be in lower case
Commit not signed off

@gitgitgadget GitGitGadget
Copy link

gitgitgadget bot commented May 23, 2025

There are issues in commit 936fe97:
Revert "lilah(config): add tracing"
Commit not signed off

@delilahw delilahw closed this May 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

new user

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@delilahw