diff --git a/CHANGELOG.md b/CHANGELOG.md index 7378099c..eba577f5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -340,6 +340,7 @@ the "monorepo" recursion mode, and single-directory reporting options of `iter_gitstatus()`. It is the first command to use `dataclass` instances as result types, rather than the traditional dictionaries. + Git v2.31 or later is required. - `SshUrlOperations` now supports non-standard SSH ports, non-default user names, and custom identity file specifications. diff --git a/README.md b/README.md index f34a2e91..9e421e4d 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,7 @@ package and its commands. - A `next-status` command that is A LOT faster than `status`, and offers a `mono` recursion mode that shows modifications of nested dataset hierarchies relative to the state of the root dataset. + Requires Git v2.31 (or later). ## Summary of additional features for DataLad extension development diff --git a/datalad_next/iter_collections/gitstatus.py b/datalad_next/iter_collections/gitstatus.py index 1088d1de..8e407bb1 100644 --- a/datalad_next/iter_collections/gitstatus.py +++ b/datalad_next/iter_collections/gitstatus.py @@ -96,6 +96,11 @@ def iter_gitstatus( The ``name`` and ``prev_name`` attributes of an item are a ``str`` with the corresponding (relative) path, as reported by Git (in POSIX conventions). + + .. note:: + + The implementation requires `git rev-parse --path-format=relative` + that was introduced with Git v2.31. """ path = Path(path)