From 630d030058c234e50d87196b624adc2049834472 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Mon, 23 Feb 2015 08:33:54 +0100 Subject: Improved documentation on IndexFile.add(...) Related to #224 [ci skip] --- git/index/base.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'git/index/base.py') 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. -- cgit v1.2.3