Skip to content

[Outreachy] diff: move diff_auto_refresh_index to repo_config_values - #2289

Open
Lynndabel wants to merge 1 commit into
gitgitgadget:masterfrom
Lynndabel:outreachy-contribution
Open

Lynndabel wants to merge 1 commit into
gitgitgadget:masterfrom
Lynndabel:outreachy-contribution

Conversation

@Lynndabel

@Lynndabel Lynndabel commented Nov 1, 2026 •

Copy link
Copy Markdown

cc: Patrick Steinhardt ps@pks.im
cc: Usman Akinyemi usmanakinyemi202@gmail.com

@gitgitgadget

gitgitgadget Bot commented Nov 1, 2026

Copy link
Copy Markdown

Welcome to GitGitGadget

Hi @Lynndabel, 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 gitgitgadget Bot added the new user label Nov 1, 2026
@gitgitgadget

gitgitgadget Bot commented Nov 1, 2026

Copy link
Copy Markdown

There are issues in commit 3180f1d:
environment: move diff_auto_refresh_index into repo_config_values

  • Commit checks stopped - the message is too short
  • Commit not signed off

@gitgitgadget

gitgitgadget Bot commented Nov 1, 2026

Copy link
Copy Markdown

There are issues in commit 32d9485:
diff: use repo_config_values for diff.autorefreshindex

  • Commit checks stopped - the message is too short
  • Commit not signed off

@gitgitgadget

gitgitgadget Bot commented Nov 1, 2026

Copy link
Copy Markdown

There are issues in commit a1b7d2f:
diff: remove global diff_auto_refresh_index declaration

  • Commit checks stopped - the message is too short
  • Commit not signed off

@gitgitgadget

gitgitgadget Bot commented Nov 1, 2026

Copy link
Copy Markdown

There are issues in commit d0dc9c9:
builtin/diff: use repo_diff_auto_refresh_index getter

  • Commit checks stopped - the message is too short
  • Commit not signed off

@gitgitgadget

gitgitgadget Bot commented Nov 1, 2026

Copy link
Copy Markdown

There are issues in commit c3b1b24:
t4000: add tests for diff.autorefreshindex config

  • Commit checks stopped - the message is too short
  • Commit not signed off

@dscho

dscho commented Nov 1, 2026

Copy link
Copy Markdown
Member

/allow

@gitgitgadget

gitgitgadget Bot commented Nov 1, 2026

Copy link
Copy Markdown

User Lynndabel is now allowed to use GitGitGadget.

WARNING: Lynndabel has no public email address set on GitHub; GitGitGadget needs an email address to Cc: you on your contribution, so that you receive any feedback on the Git mailing list. Go to https://github.com/settings/profile to make your preferred email public to let GitGitGadget know which email address to use.

@dscho

dscho commented Nov 1, 2026

Copy link
Copy Markdown
Member

@Lynndabel please note that the Git project insists on the DCO. You can fix it by configuring user.name, then git commit --amend --reset-author --signoff (deleting the superseded Signed-off-by line), and force-pushing.

Also, Git's commit messages are almost never mere one-liners. Please follow the guidance in https://github.blog/2022-06-30-write-better-commits-build-better-projects/ to improve it, in particular with a strong focus on this part:

  What you’re doing Why you’re doing it
High-level (strategic) Intent (what does this accomplish?) Context (why does the code do what it does now?)
Low-level (tactical) Implementation (what did you do to accomplish your goal?) Justification (why is this change being made?)

The diff_auto_refresh_index variable is currently a global,
which makes it difficult to use Git as a library since
global state can't be isolated between different repository
instances.

Move it into repo_config_values so that each repository can
have its own setting. This follows the pattern used for other
recently migrated config options like trust_executable_bit.

Add a getter function repo_diff_auto_refresh_index() that
returns the value from the repo's config, falling back to 1
(the default) if the repo isn't initialized yet.

Update the config handler to write to the repo config struct,
remove the global variable declaration, and update the caller
in builtin/diff.c to use the new getter function.

Add tests to verify the configuration can be set to both true
and false without errors.

Signed-off-by: Lynndabel <okolo.ebelelynda@gmail.com>
@Lynndabel
Lynndabel force-pushed the outreachy-contribution branch from c3b1b24 to 97319dd Compare November 2, 2026 02:32
@Lynndabel

Copy link
Copy Markdown
Author

@Lynndabel please note that the Git project insists on the DCO. You can fix it by configuring user.name, then git commit --amend --reset-author --signoff (deleting the superseded Signed-off-by line), and force-pushing.

Also, Git's commit messages are almost never mere one-liners. Please follow the guidance in https://github.blog/2022-06-30-write-better-commits-build-better-projects/ to improve it, in particular with a strong focus on this part:

  What you’re doing Why you’re doing it
High-level (strategic) Intent (what does this accomplish?) Context (why does the code do what it does now?)
Low-level (tactical) Implementation (what did you do to accomplish your goal?) Justification (why is this change being made?)

Thank you. i have committed using the guideline and pushed.

@dscho

dscho commented Nov 2, 2026

Copy link
Copy Markdown
Member

@Lynndabel very good. Now try /preview (as described here) and look over the email that should have been sent to you (don't worry about the Cc:, it will look as if it had been sent to the Git mailing list, too, but it won't have been). If everything looks as you think it should look, run /submit.

@Lynndabel

Copy link
Copy Markdown
Author

/preview

@gitgitgadget

gitgitgadget Bot commented Nov 2, 2026

Copy link
Copy Markdown

Preview email sent as pull.2289.git.1793607166561.gitgitgadget@gmail.com

@Lynndabel

Copy link
Copy Markdown
Author

/submit

@gitgitgadget

gitgitgadget Bot commented Nov 2, 2026

Copy link
Copy Markdown

Submitted as pull.2289.git.1793607304156.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-2289/Lynndabel/outreachy-contribution-v1

To fetch this version to local tag pr-2289/Lynndabel/outreachy-contribution-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-2289/Lynndabel/outreachy-contribution-v1

@gitgitgadget

gitgitgadget Bot commented Nov 3, 2026

Copy link
Copy Markdown

Junio C Hamano wrote on the Git mailing list (how to reply to this email):

"Ebele Lynda Okolo via GitGitGadget" <gitgitgadget@gmail.com>
writes:

> From: Lynndabel <okolo.ebelelynda@gmail.com>
>
> The diff_auto_refresh_index variable is currently a global,
> which makes it difficult to use Git as a library since
> global state can't be isolated between different repository
> instances.

We do not want to put it in repo_config_value, because access to the
structure will barf when given anything other than the_repository,
hence such a move does not help the "library" scene very much to
begin with.

It is only set in diff.c when the ui related configuration variable
is read from the git_config() callback.  The callback is *not*
repository specific but is a synthesized computation result after
reading system, global, and repository configuration files, which is
another reason why it does not look like a good idea to tie this
setting to repo_config_values.

Thanks.

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.

2 participants