mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve git-annex-drop man page required content docs

Browse source 
Does --unused bypass required content checks in any meaningful sense?
I documented it as such but am unsure of what required content setting
would be considered to match unused content.
This commit is contained in:
Joey Hess 2019-06-26 12:22:59 -04:00
parent c28f9b34c2
commit f64eac55a4
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
2 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/bugs/git-annex-drop_docs_and_git-annex-requires.mdwn
View file

@ -1 +1,3 @@
The [[`git-annex-drop`|git-annex-drop]] man page warns for several options: "bypasses checking the .gitattributes `annex.numcopies` setting". I'm guessing these also bypass [[`git-annex-required`|git-annex-required]] ? If yes, maybe add that to the manpage.
> Good spotting, I've done so. [[done]] --[[Joey]]

16
doc/git-annex-drop.mdwn
View file

@ -1,4 +1,4 @@
# NAME
#a NAME
git-annex drop - remove content of files from repository
@ -12,7 +12,11 @@ Drops the content of annexed files from this repository, when
possible.
git-annex will refuse to drop content if it cannot verify it is
safe to do so.
safe to do so. Usually this involves verifying that the content is stored
in some other repository.
Content that is required to be stored in the repository will not be dropped
even if enough copies exist elsewhere. See [[git-annex-required]](1).
# OPTIONS
@ -43,28 +47,28 @@ safe to do so.
This is the default behavior when running git-annex drop in a bare repository.
Note that this bypasses checking the .gitattributes annex.numcopies
setting.
setting and required content settings.
* `--branch=ref`
Drop files in the specified branch or treeish.
Note that this bypasses checking the .gitattributes annex.numcopies
setting.
setting and required content settings.
* `--unused`
Drop files found by last run of git-annex unused.
Note that this bypasses checking the .gitattributes annex.numcopies
setting.
setting and required content settings.
* `--key=keyname`
Use this option to drop a specified key.
Note that this bypasses checking the .gitattributes annex.numcopies
setting.
setting and required content settings.
* file matching options