git-add : Respect submodule ignore=all and only add changes with --force <path>

[bicschneider]

The feature of configuring a submodule to "ignore=all" is nicely respected in commands "status" and "diff". However the "add" command does not respect the configuration the same way. The behavior is problematic for the logic between status/diff and add. Secondly it makes it problematic to track branches in the submodule configuration as developers unintentionally keeps add submodule updates and get conflicts for no intentional reason. Both adds unnecessary friction to the usage of submodules.

The patches implement the same logical behavior for ignore=all submodules as regular ignored files. The status now does not show any diff - nor will the add command update the reference submodule reference. If you add the submodule path which is ignore=all then you are presented with a message that you need to use the --force option. The branch=, ignore=all (and update=none) now works great with update --remote, but developers does not have to consider changes in the updates of the submodule sha1. The implementation removes a friction of working with submodules and can be used like the repo tool with branches configured. The submodule status report could be used for build/release documentation for reproduction of a setup.

[gitgitgadget]

Welcome to GitGitGadget

Hi @bicschneider, 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:

• Search: is:pr is:open "/allow"

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]

There are issues in commit a3105e7:
first working submodule ignore=all skipped in adding
Commit checks stopped - the message is too short
Commit not signed off

[gitgitgadget]

There are issues in commit b2d5354:
add --force for adding submodule even ignore=all is set
Commit checks stopped - the message is too short
Commit not signed off

[gitgitgadget]

There are issues in commit 8348a4a:
create tests for git add of submodule behavior for ignore=all
Commit checks stopped - the message is too short
Commit not signed off

[gitgitgadget]

There are issues in commit 6657438:
remove unnecassary trace print in read-cache.c
Commit checks stopped - the message is too short
Commit not signed off

[gitgitgadget]

There are issues in commit c2d703e:
update tests with explicit scenary around ignore=all and using --ignore-submodules option on log, status
Commit checks stopped - the message is too short
First line of commit message is too long (> 76 columns)
Commit not signed off

[gitgitgadget]

There are issues in commit a56d8b8:
add description per test-case
Commit checks stopped - the message is too short
Commit not signed off

[gitgitgadget]

There are issues in commit 79598c6:
update documentation for add and gitmodules
Commit checks stopped - the message is too short
Commit not signed off

[gitgitgadget]

There are issues in commit 1b8d93b:
Add required explicit pathspec in order to add
Commit checks stopped - the message is too short
Commit not signed off

[gitgitgadget]

There are issues in commit e45daed:
clean-up tailing spaces, traces, writings and shell spellcheck in test
Commit checks stopped - the message is too short
Commit not signed off

[dscho]

/allow

[gitgitgadget]

User bicschneider is now allowed to use GitGitGadget.

WARNING: bicschneider 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]

@bicschneider the Git project is very particular about the form of the commit messages it accepts, and it is outright hostile towards contributors who send patches that introduce white-space problems even if those are fixed by later patches in the same patch series (they demand that the fixes are squashed into the appropriate patches, which I recommend you do before /submiting).

Further, they are adamant about the Signed-off-by trailer. You can fix it by calling git commit --amend --reset-author --signoff, or via git rebase --signoff.

Finally, you can increase the chances for a pleasant review on the Git mailing list dramatically by imitating the rather verbose style of Git's own commit messages. There is some really useful guidance here, in particular the part where it recommends to ensure that the following are covered by the commit message:

	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?)

[gitgitgadget]

There are issues in commit fa7cf4e:
read-cache: let read-cache respect submodule ignore=all and bypass with --force
First line of commit message is too long (> 76 columns)
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]

There are issues in commit 78c6a1a:
tests: Add new t2206-add-submodule-ignored.sh to test ignore=all scenario
Prefixed commit message must be in lower case

[gitgitgadget]

There are issues in commit d94d2d5:
Documentation: update add and submodule describing the ignore=all and --force
First line of commit message is too long (> 76 columns)
Lines in the body of the commit messages should be wrapped between 60 and 76 characters.
Indented lines, and lines without whitespace, are exempt