Ignore submodules running git status

[clemens-tolboom]

Q	A
Doc fix?	no
New docs?	no
Applies to
Fixed tickets

When doing

symfony-docs$ git st On branch master Your branch is up-to-date with 'origin/master'. Changes not staged for commit: (use "git add <file>..." to update what will be committed) (use "git checkout -- <file>..." to discard changes in working directory) (commit or discard the untracked or modified content in submodules) modified: _exts (untracked content) no changes added to commit (use "git add" and/or "git commit -a")

the directory _exts should not get listed.

The patch is based on http://stackoverflow.com/questions/5127178/gitignore-files-added-inside-git-submodules ... ready that issue there is another option dirty.

Not sure what's best so:

• choose between dirty and untracked

[stof]

what are the untracked files being created in the submodule ?

[clemens-tolboom]

symfony-docs/_exts$ git status HEAD detached at 6fea4b1 Untracked files: (use "git add <file>..." to include in what will be committed) sensio/__init__.pyc sensio/sphinx/__init__.pyc sensio/sphinx/configurationblock.pyc sensio/sphinx/phpcode.pyc sensio/sphinx/refinclude.pyc nothing added to commit but untracked files present (use "git add" to track)

[stof]

a much better fix is to add the .pyc files to the gitignore of the extension repo, as these files should never be committed in it. The repo is at https://github.com/fabpot/sphinx-php

[clemens-tolboom]

Will do.

[wouterj]

Then we can close this one, thanks @clemens-tolboom for taking care of this!

[stof]

once the change is merged in sphinx-php, there will still be a need to update the submodule to the fixed version

[xabbuh]

@stof Are you sure? The .gitmodules doesn't mention any exact version.

[stof]

@xabbuh the .gitmodules file is only half of the definition of a submodule for Git (it is the url to get it used when running git submodule init, which can be altered locally if you prefer. the target of the submodule is defined by git as a special kind of object for the /_exts path. If you look at the github tree, you will see that it displays the commit targetted by the submodule: https://github.com/symfony/symfony-docs

[stof]

if you want a comparison between git submodules and composer, git submodule update is the equivalent of composer install: it updates the local working directory to match the locked version.
for submodules, updating the locked version to a different commit (what composer update does) looks like this:

$ cd _exts $ git fetch $ git checkout <newref> $ cd .. $ git add _exts $ git commit -m 'Updating the vendor'

[xabbuh]

That makes sense. Thanks for the great explanation @stof.

[stof]

and if you missed it, the PR is now merged in the extensions

[clemens-tolboom]

Awesome explanation. Thanks @stof