Remove undocumented worktre.git_path

jdavid · jdavid · commit 92f55fb2591b · 2019-03-02T19:04:01.000+01:00
Fixes libgit2#803
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -23,7 +23,10 @@
 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`
+  `.git` file within
+  `#803 <https://github.com/libgit2/pygit2/issues/803>`_
+
+- Remove undocumented `worktree.git_path`
   `#803 <https://github.com/libgit2/pygit2/issues/803>`_
 
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -50,6 +50,7 @@ Usage guide:
    settings
    submodule
    working-copy
+   worktree
 
 
 Indices and tables
diff --git a/docs/worktree.rst b/docs/worktree.rst
@@ -0,0 +1,6 @@
+**********************************************************************
+Worktree
+**********************************************************************
+
+.. autoclass:: pygit2.Worktree
+   :members:
diff --git a/src/worktree.c b/src/worktree.c
@@ -50,14 +50,6 @@ Worktree_path__get__(Worktree *self)
     return to_unicode(git_worktree_path(self->worktree), NULL, NULL);
 }
 
-PyDoc_STRVAR(Worktree_git_path__doc__,
-    "Gets dir within .git path\n");
-PyObject *
-Worktree_git_path__get__(Worktree *self)
-{
-    return to_unicode(self->worktree->gitdir_path, NULL, NULL);
-}
-
 PyDoc_STRVAR(Worktree_is_prunable__doc__,
     "Is the worktree prunable with the given set of flags?\n");
 PyObject *
@@ -105,7 +97,6 @@ PyMethodDef Worktree_methods[] = {
 
 PyGetSetDef Worktree_getseters[] = {
     GETTER(Worktree, path),
-    GETTER(Worktree, git_path),
     GETTER(Worktree, name),
     GETTER(Worktree, is_prunable),
     {NULL}
diff --git a/src/worktree.h b/src/worktree.h
@@ -33,17 +33,6 @@
 #include <git2.h>
 #include <git2/worktree.h>
 
-/* git_worktree is an internal unstable datastructure (#803) */
-struct git_worktree {
-	char *name;
-	char *worktree_path;
-	char *gitlink_path;
-	char *gitdir_path;
-	char *commondir_path;
-	char *parent_path;
-	int locked:1;
-};
-
 PyObject* wrap_worktree(Repository* repo, git_worktree* wt);
 
 #endif
diff --git a/test/test_repository.py b/test/test_repository.py
@@ -696,15 +696,6 @@ def _check_worktree(worktree):
             # file.
             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)
-
         # We should have zero worktrees
         assert self.repo.list_worktrees() == []
         # Add a worktree
@@ -726,5 +717,3 @@ def _check_worktree(worktree):
         # something to take up with libgit2.
         worktree.prune(True)
         assert self.repo.list_worktrees() == []
-        # Confirm that the repo's data dir has been removed
-        assert not os.path.isdir(worktree.git_path)
