diff options
| author |  Joey Hess <joeyh@joeyh.name> | 2017-12-13 14:34:32 -0400 |
|---|---|---|
| committer | Joey Hess <joeyh@joeyh.name> | 2017-12-13 14:34:32 -0400 |
| commit | 667617a1f2c39f338cbbcb7cab861472b5d7e438 (patch) | |
| tree | 98acb4bc30370126c803936f7d374fa8093d84e8 /doc | |
| parent | 859c133f46931fc0f8e2d2b5a027d33dab2cec75 (diff) | |
.noannex file
A top-level .noannex file will prevent git-annex init from being used in a
repository. This is useful for repositories that have a policy reason not
to use git-annex. The content of the file will be displayed to the user who
tries to run git-annex init.
This also affects git annex reinit and initialization via the webapp.
It does not affect automatic inits, when there's a sibling git-annex branch
already.
This commit was supported by the NSF-funded DataLad project.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/git-annex-init.mdwn | 5 | ||||
| -rw-r--r-- | doc/todo/prevent_unwanted_init.mdwn | 2 |
2 files changed, 7 insertions, 0 deletions
diff --git a/doc/git-annex-init.mdwn b/doc/git-annex-init.mdwn index 29522181d..4538f54e5 100644 --- a/doc/git-annex-init.mdwn +++ b/doc/git-annex-init.mdwn @@ -23,6 +23,11 @@ mark it as dead (see [[git-annex-dead]](1)). This command is entirely safe, although usually pointless, to run inside an already initialized git-annex repository. + +A top-level `.noannex` file will prevent git-annex init from being used +in a repository. This is useful for repositories that have a policy +reason not to use git-annex. The content of the file will be displayed +to the user who tries to run git-annex init. # OPTIONS diff --git a/doc/todo/prevent_unwanted_init.mdwn b/doc/todo/prevent_unwanted_init.mdwn index 6481ce6be..b452a4735 100644 --- a/doc/todo/prevent_unwanted_init.mdwn +++ b/doc/todo/prevent_unwanted_init.mdwn @@ -6,3 +6,5 @@ annoying. --[[Joey]] This could be a git configuration setting, or it could be something checked into the repo. Either might make sense depending on the scope in which one wants to prevent the accidental init. + +> [[done]] using .noannex file. --[[Joey]] |