Skip to contentSkip to conversation

'stg add FILE' when FILE is a symlink to dir adds dir contents

BUG Tomash Brechko 3 participants 3 messages Jun 15, 2016

lore
Share & tools
lore
#0 lore raw

Hello,

I have noticed that 'stg add FILE' works differently from 'git add FILE' when file is a symlink to the directory: StGIT adds the contents of dir, while GIT adds the symlink itself.

In stgit/git.py we see:

Quoted 20 lines

def add(names):
"""Add the files or recursively add the directory contents """
# generate the file list
files = []
for i in names:
if not os.path.exists(i):
raise GitException, 'Unknown file or directory: %s' % i

if os.path.isdir(i):
# recursive search. We only add files
for root, dirs, local_files in os.walk(i):
for name in [os.path.join(root, f) for f in local_files]:
if os.path.isfile(name):
files.append(os.path.normpath(name))
elif os.path.isfile(i):
files.append(os.path.normpath(i))
else:
raise GitException, '%s is not a file or directory' % i

Quoted 3 lines

if files:
if __run('git-update-index --add --', files):
raise GitException, 'Unable to add file'

I have no knowledge of Python, so I can't fix it myself, but perhaps one should check for symlink before 'if os.path.isdir(i):'. This also will fix 'elif os.path.isfile(i):' branch if 'os.path.normpath(i)' call dereferences symlinks (I'm not sure if that is the case).

But curious, why does the code traverse the tree itself? Why not to give the file list directly to git-update-index, and let it decide what files to add, and how? I also guess the code doesn't honor .gitignore.

Could 'names' list be passed to git-update-index directly?

Signature · 1 line
   Tomash Brechko
#1 lore raw
Quoted 2 lines · Tomash Brechko

I have no knowledge of Python, so I can't fix it myself, but perhaps one should check for symlink before 'if os.path.isdir(i):'.

Correct. From the Python library reference:

isdir(path)
Return True if path is an existing directory. This follows symbolic links, so both islink() and isdir() can be true for the same path.

So, os.path.islink() would be the function to use.

Signature · 2 lines
Karl Hasselström, [email protected]
      www.treskal.com/kalle
#2 lore raw
In reply to Tomash Brechko
Quoted 3 lines · Tomash Brechko

I have noticed that 'stg add FILE' works differently from 'git add FILE' when file is a symlink to the directory: StGIT adds the contents of dir, while GIT adds the symlink itself.

Thanks for this.

Quoted 3 lines

But curious, why does the code traverse the tree itself? Why not to give the file list directly to git-update-index, and let it decide what files to add, and how?

Because this code was implemented almost 2 years ago when I don't think git-update-index was able to scan directories. Never looked at re-implementing it.

Quoted 1 line

I also guess the code doesn't honor .gitignore.

It doesn't, unless git-update-index ignores the files passed on the command line according to the .gitignore content.

Quoted 1 line

Could 'names' list be passed to git-update-index directly?

Probably, I'll give it a try and see whether it breaks anything.

Signature · 1 line
Catalin