New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: gitrepo: Rename get_merge_base's treeishes parameter #2903
Conversation
kyleam
commented
Oct 7, 2018
merge-base accepts any commit-ish, so technically arguments passed to get_merge_base's are tree-ishes, but 'treeishes' is a misleading name because merge-base doesn't accept a tree object. For example, try $ git merge-base HEAD^{tree} HEAD~^{tree}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indeed... Unlikely, if even used it, specified it as a keyword argument
Codecov Report
@@ Coverage Diff @@
## master #2903 +/- ##
==========================================
+ Coverage 90.28% 90.28% +<.01%
==========================================
Files 246 246
Lines 31877 31877
==========================================
+ Hits 28780 28781 +1
+ Misses 3097 3096 -1
Continue to review full report at Codecov.
|
Upgrade of [git-annex] to the most recent available to your release is advisable since a number of issues were resolved at that level. ### Major refactoring and deprecations - `datalad.consts.LOCAL_CENTRAL_PATH` constant was deprecated in favor of `datalad.locations.default-dataset` [configuration] variable ([#2835]) ### Minor refactoring - `"notneeded"` messages are no longer reported by default results renderer - [run] no longer shows commit instructions upon command failure when `explicit` is true and no outputs are specified ([#2922]) - `get_git_dir` moved into GitRepo ([#2886]) - `_gitpy_custom_call` removed from GitRepo ([#2894]) - `GitRepo.get_merge_base` argument is now called `commitishes` instead of `treeishes` ([#2903]) ### Fixes - [update] should not leave the dataset in non-clean state ([#2858]) and some other enhancements ([#2859]) - Fixed chunking of the long command lines to account for decorators and other arguments ([#2864]) - Progress bar should not crash the process on some missing progress information ([#2891]) - Default value for `jobs` set to be `"auto"` (not `None`) to take advantage of possible parallel get if in `-g` mode ([#2861]) - [wtf] must not crash if `git-annex` is not installed etc ([#2865]), ([#2865]), ([#2918]), ([#2917]) - Fixed paths (with spaces etc) handling while reporting annex error output ([#2892]), ([#2893]) - `__del__` should not access `.repo` but `._repo` to avoid attempts for reinstantiation etc ([#2901]) - Fix up submodule `.git` right in `GitRepo.add_submodule` to avoid added submodules being non git-annex friendly ([#2909]), ([#2904]) - [run-procedure] ([#2905]) - now will provide dataset into the procedure if called within dataset - will not crash if procedure is an executable without `.py` or `.sh` suffixes - Use centralized `.gitattributes` handling while setting annex backend ([#2912]) - `GlobbedPaths.expand(..., full=True)` incorrectly returned relative paths when called more than once ([#2921]) ### Enhancements and new features - Report progress on [clone] when installing from "smart" git servers ([#2876]) - Stale/unused `sth_like_file_has_content` was removed ([#2860]) - Enhancements to [search] to operate on "improved" metadata layouts ([#2878]) - Output of `git annex init` operation is now logged ([#2881]) - New - `GitRepo.cherry_pick` ([#2900]) - `GitRepo.format_commit` ([#2902]) - [run-procedure] ([#2905]) - procedures can now recursively be discovered in subdatasets as well. The uppermost has highest priority - Procedures in user and system locations now take precedence over those in datasets. * tag '0.11.0': Make it a 0.11.0 release since there were some API RFings REL: slight tune up to Changelog following the advices DOC: v0.10.4: Mention change in procedure precedence (a0cbcba) DOC: v0.10.4: Fix description of db715b7 DOC: v0.10.4: Improve description of 6f615a4 DOC: v0.10.4: Remove duplicate word
## 0.11.0 (Oct 23, 2018) -- Soon-to-be-perfect [git-annex] 6.20180913 (or later) is now required - provides a number of fixes for v6 mode operations etc. ### Major refactoring and deprecations - `datalad.consts.LOCAL_CENTRAL_PATH` constant was deprecated in favor of `datalad.locations.default-dataset` [configuration] variable ([#2835]) ### Minor refactoring - `"notneeded"` messages are no longer reported by default results renderer - [run] no longer shows commit instructions upon command failure when `explicit` is true and no outputs are specified ([#2922]) - `get_git_dir` moved into GitRepo ([#2886]) - `_gitpy_custom_call` removed from GitRepo ([#2894]) - `GitRepo.get_merge_base` argument is now called `commitishes` instead of `treeishes` ([#2903]) ### Fixes - [update] should not leave the dataset in non-clean state ([#2858]) and some other enhancements ([#2859]) - Fixed chunking of the long command lines to account for decorators and other arguments ([#2864]) - Progress bar should not crash the process on some missing progress information ([#2891]) - Default value for `jobs` set to be `"auto"` (not `None`) to take advantage of possible parallel get if in `-g` mode ([#2861]) - [wtf] must not crash if `git-annex` is not installed etc ([#2865]), ([#2865]), ([#2918]), ([#2917]) - Fixed paths (with spaces etc) handling while reporting annex error output ([#2892]), ([#2893]) - `__del__` should not access `.repo` but `._repo` to avoid attempts for reinstantiation etc ([#2901]) - Fix up submodule `.git` right in `GitRepo.add_submodule` to avoid added submodules being non git-annex friendly ([#2909]), ([#2904]) - [run-procedure] ([#2905]) - now will provide dataset into the procedure if called within dataset - will not crash if procedure is an executable without `.py` or `.sh` suffixes - Use centralized `.gitattributes` handling while setting annex backend ([#2912]) - `GlobbedPaths.expand(..., full=True)` incorrectly returned relative paths when called more than once ([#2921]) ### Enhancements and new features - Report progress on [clone] when installing from "smart" git servers ([#2876]) - Stale/unused `sth_like_file_has_content` was removed ([#2860]) - Enhancements to [search] to operate on "improved" metadata layouts ([#2878]) - Output of `git annex init` operation is now logged ([#2881]) - New - `GitRepo.cherry_pick` ([#2900]) - `GitRepo.format_commit` ([#2902]) - [run-procedure] ([#2905]) - procedures can now recursively be discovered in subdatasets as well. The uppermost has highest priority - Procedures in user and system locations now take precedence over those in datasets. * tag '0.11.0': CHANGELOG adjusted to reflect new minimal version of git-annex