Filter! diff.ignoreSubmodules=untracked on top of magit buffer is confusing

[Atemu]

What is that message trying to tell me?

From reading #4019 I gather that this message is intentional. I guess it's to inform the user that Magit may no function correctly with that setting?

AFAICT, setting it to untracked does not affect magit in any way because magit ignores this "modified" status already. I originally set this config flag because I also don't care about untracked files in my submodules when I'm outside of magit; CLI git shows submodules with untracked files as "modified" in git status.

1. The message should explain itself a little better
2. There should be an obvious i-know-what-im-doing variable which disables the message
3. Should this message even show with diff.ignoreSubmodules=untracked?

[tarsius]

Yes, there's room for improvements along those lines.

For now you can hide this using

(remove-hook 'magit-status-headers-hook
             'magit-insert-diff-filter-header)

[Atemu]

Does diff.ignoreSubmodules=untracked inhibit any of Magit's functionality?

[tarsius]

When I took a quick look, I got the impression that it does not.

Dealing with the various things you have brought up, will be a series of (hopefully) small steps, and after each one awaits another. I decided to stop here. I am currently focused on other things and it will be a while until I get around to dealing with such details again.

Also note that since untracked is the default (unless I am mistaken), you too can do something to prevent that from being shown; just don't double down on the default! I believe that shouldn't make a difference, except with regards to the Filter! line.

[Atemu]

Sure, thanks a bunch for your work :)

Contrary to what the git-diff man page suggests, untracked does not appear to be the default in git status:

$ git status
On branch master
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
  (commit or discard the untracked or modified content in submodules)
        modified:   test (untracked content)

no changes added to commit (use "git add" and/or "git commit -a")
$ git -c diff.ignoreSubmodules=untracked status
On branch master
nothing to commit, working tree clean