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

improve docs

Browse source 
I saw a user open a forum post that looked like they had read this man
page, but were unaware of git-annex unlock, and were looking for its
functionality. They later deleted the post, probably when they found
git-annex unlock. Looking at this man page, it was a bit unclear about
the motivation for the command.

Yes, I'm warching... ;-)
This commit is contained in:
Joey Hess 2021-11-12 14:07:29 -04:00
parent 2248b35fb8
commit 258647ce7d
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/git-annex-adjust.mdwn
View file

@ -16,13 +16,18 @@ The adjusted branch will have a name like "adjusted/master(unlocked)".
Since it's a regular git branch, you can use `git checkout` to switch
back to the original branch at any time.
This allows changing how annexed files are handled, without making changes
to a public branch with commands like `git-annex unlock`.
While in the adjusted branch, you can use git-annex and git commands as
usual. Any commits that you make will initially only be made to the
adjusted branch.
To propagate commits from the adjusted branch back to the original branch,
and to other repositories, as well as to merge in changes from other
repositories, run `git annex sync`.
repositories, run `git annex sync`. This will propagate changes that you've
made such as adding/deleting files, but will not propagate the adjustments
made by this command.
When in an adjusted branch, using `git merge otherbranch` is often not
ideal, because merging a non-adjusted branch may lead to unncessary
@ -117,6 +122,8 @@ and will also propagate commits back to the original branch.
[[git-annex-unlock]](1)
[[git-annex-lock]](1)
[[git-annex-upgrade]](1)
[[git-annex-sync]](1)