From: Joey Hess Date: Fri, 12 Nov 2021 18:07:29 +0000 (-0400) Subject: improve docs X-Git-Tag: archive/raspbian/10.20250416-2+rpi1~2^2^2~57^2~34 X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=258647ce7d3a26dd64610dea4bbdf41083bd785c;p=git-annex.git improve docs 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... ;-) --- diff --git a/doc/git-annex-adjust.mdwn b/doc/git-annex-adjust.mdwn index 644e9fb267..42ec030a20 100644 --- a/doc/git-annex-adjust.mdwn +++ b/doc/git-annex-adjust.mdwn @@ -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)