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

consistent name for config

Browse source 
annex.private is a bit ambiguous about what kind of privacy, but
it keeps the name symmetric with remote.foo.annex-private.
This commit is contained in:
Joey Hess 2021-04-23 14:36:20 -04:00
parent 32138b8cd8
commit 141a4e9750
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
2 changed files with 23 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/git-annex.mdwn
View file

@ -1158,7 +1158,7 @@ repository, using [[git-annex-config]]. See its man page for a list.)
To avoid that merging, set this to "false". This can be useful To avoid that merging, set this to "false". This can be useful
particularly when you don't have write permission to the repository. particularly when you don't have write permission to the repository.
* `annex.privaterepo` * `annex.private`
When this is set to true, no information about the repository will be When this is set to true, no information about the repository will be
recorded in the git-annex branch. recorded in the git-annex branch.
@ -1166,9 +1166,9 @@ repository, using [[git-annex-config]]. See its man page for a list.)
For example, to make a repository without any mention of it ever For example, to make a repository without any mention of it ever
appearing in the git-annex branch: appearing in the git-annex branch:
git init myprivaterepo git init myprivate
cd myprivaterepo cd myprivaterepo
git config annex.privaterepo true git config annex.private true
git annex init git annex init
* `annex.hardlink` * `annex.hardlink`

22
doc/tips/cloning_a_repository_privately.mdwn
View file

@ -7,14 +7,14 @@ If you don't want the world to know about your clone, either for privacy
reason or only because the clone is a temporary copy of the repository, reason or only because the clone is a temporary copy of the repository,
here's how. here's how.
Recently git-annex got a new config setting, `annex.privaterepo`. Recently git-annex got a new config setting, `annex.private`.
Set it before you start using git-annex in a repository, and git-annex Set it before you start using git-annex in a repository, and git-annex
will avoid recording any information about the repository into the will avoid recording any information about the repository into the
git-annex branch. git-annex branch.
git clone ssh://... myclone git clone ssh://... myclone
cd myclone cd myclone
git config annex.privaterepo true git config annex.private true
git annex init git annex init
Now you can use git-annex as usual, adding files to the repository, Now you can use git-annex as usual, adding files to the repository,
@ -42,3 +42,21 @@ Bear in mind that, if you lose the repository where the private special
remote was created, you'll lose the information git-annex needs to access remote was created, you'll lose the information git-annex needs to access
that special remote, and that will likely mean you'll not be able to that special remote, and that will likely mean you'll not be able to
recover any files stored in it. recover any files stored in it.
## private git remotes
When the git config "remote.name.private" is set, git-annex will avoid
recording anything in the git-annex branch about the remote. This is
set by `git-annex initremote --private`, and could also be set for
git remotes. This could be useful, perhaps. Update this tip if you have a
good way to use it.
## where the data is actually stored
The private data gets stored in .git/annex/journal-private/ rather
than in the git-annex branch.
It's possible to move those files to .git/annex/journal/ (being careful
to not overwrite files already in there), and it will then get committed to
the git-annex branch. Do this only if you decide you don't want a private
repository after all.