How to get rid of Git submodules untracked status?

Question

I can't seem to get rid of untracked content in Git's submodules. Running git status yields:

# On branch master
# Changes not staged for commit:
#   (use "git add ..." to update what will be committed)
#   (use "git checkout -- ..." to discard changes in working directory)
#   (commit or discard the untracked or modified content in submodules)
#
#    modified:   bundle/snipmate (untracked content)
#    modified:   bundle/surround (untracked content)
#    modified:   bundle/trailing-whitespace (untracked content)
#    modified:   bundle/zencoding (untracked content)
#
no changes added to commit (use "git add" and/or "git commit -a")

Adding the --ignore-submodules parameter hides these messages; but I wonder if there's a way to get rid of this dirt in a more suitable, core-ish, manner.

This answer: http://stackoverflow.com/a/5127213/199649 evokes more option. — charlax, Jan 14 '12 at 19:34
Does this answer your question? [Git: can I suppress listing of 'modified content'/dirty submodule entries in status, diff, etc?](https://stackoverflow.com/questions/3240881/git-can-i-suppress-listing-of-modified-content-dirty-submodule-entries-in-sta) — aij, Jan 18 '21 at 22:48

score 175 · Answer 1 · edited Sep 13 '21 at 17:49

175

I found this blog post to work overall. By adding the ignore = dirty option to each one of the entries in the .gitmodules file.

[submodule "zen-coding-gedit3"]
    path = zen-coding-gedit3
    url = git://github.com/leafac/zen-coding-gedit3.git
    ignore = dirty

edited Sep 13 '21 at 17:49

exic

2,220
1
22
29

answered Sep 08 '12 at 15:38

ezraspectre

3,148
5
23
28

My preferred solution, as it's easily automated. – lethal-guitar Nov 26 '13 at 10:52
38

Worth mentioning that `ignore = untracked` also exists, and shows modified tracked files, but not untracked files. It'd be nice if there was a global setting for this for all submodules... – naught101 Nov 27 '15 at 04:56
1

Unsuprisingly, after almost a decade, the blog post link is dead. :) – Jesse Adelman Feb 08 '21 at 17:01

score 117 · Accepted Answer · edited Jan 26 '18 at 00:12

117

Since the git status reports untracked content, the actual way to have a clean status would be to go into each one of those submodules and:

add and commit the untracked contents,
or reference the untracked contents in a .gitignore specific to each module.
or you can add the same ignored content to the submodule's .git/info/exclude, as peci1 reports in the comments.
or add dirty to the submodule specification, as mentioned in ezraspectre's answer (upvoted).
```
git config -f .gitmodules submodule.<path>.ignore untracked
```
or add a global .gitignore file (often ~/.gitignore-global). Like for example .DS_Store or in my case Carthage/Build as reported by Marián Černý in the comments. See .gitginore man page:

Patterns which a user wants Git to ignore in all situations (e.g., backup or temporary files generated by the user’s editor of choice) generally go into a file specified by core.excludesFile in the user’s ~/.gitconfig. Its default value is $XDG_CONFIG_HOME/git/ignore. If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore is used instead.

edited Jan 26 '18 at 00:12

mehmet

7,720
5
42
48

answered Feb 26 '11 at 12:30

VonC

1,262,500
529
4,410
5,250

7

+1, I was about ready to scream until I found this...then realizing a `.DS_Store` file had been automatically created (by OS X) in one of my submodules, preventing me from committing the main project. Arg! Time to update `.gitignore`... – Courtney Christensen Sep 09 '11 at 19:12
Using Xcode, I've also found it useful to add *.xcuserdatad to the .gitignore-global file. This prevents git from trying to track local Xcode preferences. – Roy Sharon Oct 10 '11 at 04:00
If you don't have push rights to the submodule then you cannot share your changes to the submodule with other users of the parent repo. @quincyglenn's solution seems to work in such a case. – Drew Noakes Jan 31 '13 at 21:01
@DrewNoakes I agree. It is just that I prefer dealing with dirty changes (by adding them to a `.gitignore` or adding them to source control), but not by "hiding" them with a local config option. – VonC Jan 31 '13 at 21:23
1

@VonC, either answer makes sense depending upon the situation and preference. I wanted to highlight the distinction here as a reference to others. BTW thanks for your many answers regarding Git here on SO -- you've helped me out many a time. – Drew Noakes Jan 31 '13 at 23:56
3

You can even do without both commiting and creating a .gitignore (which itself becomes untracked). Open the submodule's `.git/info/exclude` and add the ignore lines there (it works like a .gitignore, but is not part of the shared repository). – Martin Pecka Dec 15 '14 at 21:24
@peci1 good point. I have included your comment in the answer for more visibility. – VonC Dec 15 '14 at 21:34
Sometimes you can also add those untracked contents into a global gitignore file (often `~/.gitignore-global`). Like for example `.DS_Store` or in my case `Carthage/Build`. – Marián Černý Jan 18 '18 at 14:31

score 21 · Answer 3 · answered Jun 04 '12 at 21:00

21

You can also go to each submodule dir and act as a separated git. For example:

cd my/project/submodule
git status

... /gets the list of modified files/

git add .  //to add all of them to commit into submodule
git commit -m "message to your submodule repo"

you can also update your remote submodule repo with

git submodule update

after all

answered Jun 04 '12 at 21:00

Ricardo Martins

5,702
3
40
59

5

You probably don't want to do `git add .` without reviewing the modified files. Most of the time, the changes that were made are the added `.DS_Store` files - this should probably be caught by your `.gitignore`, as zourtney mentioned in the first comment to the answer. – gregoltsov Jun 25 '12 at 16:04
2

In case you actually didn't want to update the submodules and want to revert to the original state, you might want to run `git submodule update --force`. – Tom Aug 24 '16 at 11:11

score 11 · Answer 4 · edited Jun 11 '20 at 02:37

11

This worked out just fine for me:

git update-index --skip-worktree <path>

If it doesn't work with the pathname, try the file name. Let me know if this worked for you too.

edited Jun 11 '20 at 02:37

Max von Hippel

2,856
3
29
46

answered Sep 07 '18 at 15:08

DarkCrazy

527
5
6

score 5 · Answer 5 · edited Jun 11 '20 at 02:39

5

It could be due to the detached HEAD in your submodule branch. If this is the case, go into your submodule path (e.g.: ./bundle/snipmate), then rungit checkout master.

edited Jun 11 '20 at 02:39

Max von Hippel

2,856
3
29
46

answered Nov 03 '13 at 05:14

Browny Lin

2,427
3
28
32

1

But I do not want a master, only looking for a specific commit. – V B Mar 13 '23 at 16:19

score 3 · Answer 6 · answered Feb 01 '19 at 06:20

This probably happens when you have another .git [hidden folder] inside the particular folder..

modified: ./../.. (modified content, untracked content)

make sure your sub-directory does not contains this .git folder.

If That is the case the issue can be resolved by deleting the .git folder manually from the sub directory.

score 2 · Answer 7 · answered Feb 11 '15 at 18:38

I got stuck on this issue yesterday, in a project which had close to 12 submodules.

git status was showing output.

# On branch master
# Changes not staged for commit:
#   (use "git add ..." to update what will be committed)
#   (use "git checkout -- ..." to discard changes in working directory)
#   (commit or discard the untracked or modified content in submodules)
#
#   modified:   proj1 (untracked content)
#   modified:   proj1 (modified content, untracked content)
#   ...

To resolve the untracked content error, I had to remove the untracked files from all submodules (all were *.pyc, *.pyo files generated by python) using a .gitignore.

To resolve the other, I had to run git submodule update which updated each of the submodules.

score 1 · Answer 8 · answered Aug 05 '15 at 10:21

In my situation I clone modules as a starting point for a new module in my ZF2 environment. What this does is put its own .git folder into the directory.

Solution in this case is to delete the .git folder (you will likely need to show hidden files to view it).

score 1 · Answer 9 · answered May 08 '19 at 08:39

I prefer to use SourceTree, so the solution for me was to open the submodule repo in SourceTree which shows me list of all untracked files. I then group selected them all then used "Remove".

I was able to do this because I knew all the untracked files weren't actually needed.

score 0 · Answer 10 · answered Dec 09 '14 at 15:16

0

If this is a temporary issue, you can go into the submodule folder and run git reset HEAD --hard but you will lose all your changes inside of the submodule.

answered Dec 09 '14 at 15:16

daigo

17
2

score 0 · Answer 11 · answered May 03 '21 at 16:26

0

In my experience, for MacOS, this can appear because ._ files were created: In that case: try dot_clean .

answered May 03 '21 at 16:26

Benedikt Wimmer

1

score -6 · Answer 12 · answered Jun 19 '22 at 10:50

-6

Just delete the .git folder in the subfolders.

answered Jun 19 '22 at 10:50

Risk Zer0

1
1

How to get rid of Git submodules untracked status?

12 Answers12

Linked

Related