Now worktree.path returns path to worktree dir

Instead of path to .git file within the worktree directory.
This is a breaking change.

And start changelog for the upcoming release.

Issue #803

Author: jdavid

CHANGELOG.rst

@@ -1,3 +1,32 @@
+0.28.0 (UNRELEASED)
+-------------------------
+
+- Upgrade to libgit2 0.28
+
+- Add fat wheels for Linux
+  `#793 <https://github.com/libgit2/pygit2/issues/793>`_
+  `#869 <https://github.com/libgit2/pygit2/pull/869>`_
+  `#874 <https://github.com/libgit2/pygit2/pull/874>`_
+  `#875 <https://github.com/libgit2/pygit2/pull/875>`_
+  `#883 <https://github.com/libgit2/pygit2/pull/883>`_
+
+- New `pygit2.Mailmap`, see documentation
+  `#804 <https://github.com/libgit2/pygit2/pull/804>`_
+
+- New `Repository.apply(...)` wraps `git_apply(..)`
+  `#841 <https://github.com/libgit2/pygit2/issues/841>`_
+  `#843 <https://github.com/libgit2/pygit2/pull/843>`_
+
+- Tests improvements
+  `#873 <https://github.com/libgit2/pygit2/pull/873>`_
+
+Breaking changes:
+
+- Now `worktree.path` returns the path to the worktree directory, not to the
+  `.git` file within. To get the path to the `.git` file just append `.git`
+  `#803 <https://github.com/libgit2/pygit2/issues/803>`_
+
+
 0.27.4 (2019-01-19)
 -------------------------
 

docs/index.rst

@@ -35,19 +35,21 @@ Usage guide:
    repository
    oid
    objects
-   references
-   revparse
-   log
-   working-copy
+
+   backends
+   blame
+   config
    diff
+   features
+   log
+   mailmap
    merge
-   config
+   references
    remotes
-   submodule
-   blame
+   revparse
    settings
-   features
-   backends
+   submodule
+   working-copy
 
 
 Indices and tables

docs/mailmap.rst

@@ -0,0 +1,6 @@
+**********************************************************************
+Mailmap
+**********************************************************************
+
+.. autoclass:: pygit2.Mailmap
+   :members:

docs/repository.rst

@@ -65,15 +65,17 @@ Below there are some general attributes and methods:
 .. autoattribute:: pygit2.Repository.is_bare
 .. autoattribute:: pygit2.Repository.is_empty
 .. autoattribute:: pygit2.Repository.default_signature
-.. automethod:: pygit2.Repository.read
-.. automethod:: pygit2.Repository.write
+
+.. automethod:: pygit2.Repository.apply
 .. automethod:: pygit2.Repository.ahead_behind
-.. automethod:: pygit2.Repository.descendant_of
 .. automethod:: pygit2.Repository.create_reference
+.. automethod:: pygit2.Repository.descendant_of
 .. automethod:: pygit2.Repository.describe
+.. automethod:: pygit2.Repository.free
 .. automethod:: pygit2.Repository.path_is_ignored
+.. automethod:: pygit2.Repository.read
 .. automethod:: pygit2.Repository.reset
 .. automethod:: pygit2.Repository.revert_commit
 .. automethod:: pygit2.Repository.state_cleanup
+.. automethod:: pygit2.Repository.write
 .. automethod:: pygit2.Repository.write_archive
-.. automethod:: pygit2.Repository.free

src/reference.c

@@ -342,7 +342,7 @@ PyDoc_STRVAR(Reference_type__doc__,
 PyObject *
 Reference_type__get__(Reference *self)
 {
-    git_ref_t c_type;
+    git_reference_t c_type;
 
     CHECK_REFERENCE(self);
     c_type = git_reference_type(self->reference);

src/worktree.c

@@ -39,15 +39,15 @@ PyDoc_STRVAR(Worktree_name__doc__,
 PyObject *
 Worktree_name__get__(Worktree *self)
 {
-    return to_unicode(self->worktree->name, NULL, NULL);
+    return to_unicode(git_worktree_name(self->worktree), NULL, NULL);
 }
 
 PyDoc_STRVAR(Worktree_path__doc__,
     "Gets path worktree\n");
 PyObject *
 Worktree_path__get__(Worktree *self)
 {
-    return to_unicode(self->worktree->gitlink_path, NULL, NULL);
+    return to_unicode(git_worktree_path(self->worktree), NULL, NULL);
 }
 
 PyDoc_STRVAR(Worktree_git_path__doc__,

test/test_repository.py

@@ -687,21 +687,20 @@ def test_worktree(self):
         os.rmdir(worktree_dir)
 
         def _check_worktree(worktree):
-            path = os.path.realpath(
-                os.path.join(worktree_dir, '.git'))
-            git_path = os.path.realpath(
-                os.path.join(self.repo.path, 'worktrees', worktree_name))
-
             # Confirm the name attribute matches the specified name
             assert worktree.name == worktree_name
             # Confirm the path attribute points to the correct path
-            assert os.path.realpath(worktree.path) == path
+            assert os.path.realpath(worktree.path) == worktree_dir
             # The "gitdir" in a worktree should be a file with a reference to
             # the actual gitdir. Let's make sure that the path exists and is a
             # file.
-            assert os.path.isfile(path)
+            assert os.path.isfile(os.path.join(worktree_dir, '.git'))
+
             # Confirm the git_path attribute points to the correct path
+            git_path = os.path.realpath(
+                os.path.join(self.repo.path, 'worktrees', worktree_name))
             assert os.path.realpath(worktree.git_path) == git_path
+
             # Confirm the worktree directory in the main checkout's gitdir
             # actually exists
             assert os.path.isdir(git_path)