diff options
| author | Sebastian Thiel <byronimo@gmail.com> | 2015-02-23 08:33:54 +0100 |
|---|---|---|
| committer | Sebastian Thiel <byronimo@gmail.com> | 2015-02-23 08:34:04 +0100 |
| commit | 630d030058c234e50d87196b624adc2049834472 (patch) | |
| tree | 15d4679b94be1bf517225b0a1f022c5b37b947c1 | |
| parent | 9d1a489931ecbdd652111669c0bd86bcd6f5abbe (diff) | |
| download | gitpython-630d030058c234e50d87196b624adc2049834472.tar.gz | |
Improved documentation on IndexFile.add(...)
Related to #224
[ci skip]
| -rw-r--r-- | git/index/base.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/git/index/base.py b/git/index/base.py index b73edd6f..733d4a63 100644 --- a/git/index/base.py +++ b/git/index/base.py @@ -625,6 +625,10 @@ class IndexFile(LazyMixin, diff.Diffable, Serializable): 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. |