Improved documentation on IndexFile.add(...)

Byron · Byron · commit 630d030058c2 · 2015-02-23T08:34:04.000+01:00
Related to gitpython-developers#224 [ci skip]
diff --git a/git/index/base.py b/git/index/base.py
@@ -625,6 +625,10 @@ def add(self, items, force=True, fprogress=lambda *args: None, path_rewriter=Non
                 strings denote a relative or absolute path into the repository pointing to
                 an existing file, i.e. CHANGES, lib/myfile.ext, '/home/gitrepo/lib/myfile.ext'.
 
+                Absolute paths must start with working tree directory of this index's repository
+                to be considered valid. For example, if it was initialized with a non-normalized path, like
+                `/root/repo/../repo`, absolute paths to be added must start with `/root/repo/../repo`.
+
                 Paths provided like this must exist. When added, they will be written
                 into the object database.
 
