1git-annex-adjust(1)         General Commands Manual        git-annex-adjust(1)
2
3
4

NAME

6       git-annex-adjust - enter an adjusted branch
7

SYNOPSIS

9       git    annex    adjust    --unlock|--lock|--fix|--hide-missing   [--un‐
10       lock|--lock|--fix]|--unlock-present
11

DESCRIPTION

13       Enters an adjusted form of the current branch. The annexed  files  will
14       be  treated  differently.  For  example with --unlock all annexed files
15       will be unlocked.
16
17       The adjusted branch will have a name like  "adjusted/master(unlocked)".
18       Since  it's  a  regular  git branch, you can use git checkout to switch
19       back to the original branch at any time.
20
21       While in the adjusted branch, you can use git-annex and git commands as
22       usual. Any commits that you make will initially only be made to the ad‐
23       justed branch.
24
25       To propagate commits from the adjusted  branch  back  to  the  original
26       branch,  and to other repositories, as well as to merge in changes from
27       other repositories, run git annex sync.
28
29       When in an adjusted branch, using git merge otherbranch  is  often  not
30       ideal,  because  merging  a  non-adjusted branch may lead to unncessary
31       merge conflicts, or add files in  non-adjusted  form.  To  avoid  those
32       problems, use git annex merge otherbranch.
33
34       Re-running this command with the same options while inside the adjusted
35       branch  will  update  the  adjusted  branch  as   necessary   (eg   for
36       --hide-missing  and  --unlock-present), and will also propagate commits
37       back to the original branch.
38

OPTIONS

40       --unlock
41
42              Unlock all annexed files in the adjusted branch. This allows an‐
43              nexed files to be modified.
44
45              Normally,  unlocking  a  file  requires a copy to be made of its
46              content, so that its original content is  preserved,  while  the
47              copy  can be modified.  To use less space, annex.thin can be set
48              to true before running this command; this makes a hard  link  to
49              the  content  be made instead of a copy.  (When supported by the
50              file system.) While this can save considerable disk  space,  any
51              modification  made  to  a file will cause the old version of the
52              file to be lost from the local repository. So, enable annex.thin
53              with care.
54
55              When  in  an  adjusted  unlocked  branch, git annex add will add
56              files unlocked instead of the default behavior  of  adding  them
57              locked.
58
59       --lock Lock  all  annexed file in the adjusted branch. This may be pre‐
60              ferred by those who like seeing broken symlinks when the content
61              of an annexed file is not present.
62
63              When  in an adjusted locked branch, git annex add will add files
64              locked, as usual. However, git add (and git commit -a etc) still
65              add  files unlocked. This is because it's not possible for those
66              git commands to add files locked.
67
68       --fix  Fix the symlinks to annexed files to point to the local git  an‐
69              nex  object  directory.  This  can  be useful if a repository is
70              checked out in an unusual way that prevents the symlinks commit‐
71              ted to git from pointing at the annex objects.
72
73       --hide-missing
74              Only  include  annexed  files  in the adjusted branch when their
75              content is present.
76
77              The adjusted branch is  not  immediately  changed  when  content
78              availability  changes, so if you git annex drop files, they will
79              become broken links in the usual way. And when files  that  were
80              missing  are  copied  into  the  repository from elsewhere, they
81              won't immediatly become visible in the branch.
82
83              To update the adjusted branch  to  reflect  changes  to  content
84              availability,  run git annex adjust --hide-missing again. Or, to
85              automate updates, set the annex.adjustedbranchrefresh config.
86
87              Despite missing files being hidden,  git  annex  sync  --content
88              will  still operate on them, and can be used to download missing
89              files from remotes. It also updates the  adjusted  branch  after
90              transferring content.
91
92              This option can be combined with --unlock, --lock, or --fix.
93
94       --unlock-present
95              Unlock files whose content is present, and lock files whose con‐
96              tent is missing. This provides the benefits of working with  un‐
97              locked  files,  but makes it easier to see when the content of a
98              file is not missing, since it will be a broken symlink.
99
100              The adjusted branch is  not  immediately  changed  when  content
101              availability changes, so when you git annex get files, they will
102              remain locked.  And when you git annex drop files, they will re‐
103              main locked and so will not be broken symlinks.
104
105              To  update  the  adjusted  branch  to reflect changes to content
106              availability, run git annex adjust --unlock-present  again.  Or,
107              to automate updates, set the annex.adjustedbranchrefresh config.
108              Or use git-annex sync --content, which updates the branch  after
109              transferring content.
110
111       Also the git-annex-common-options(1) can be used.
112

SEE ALSO

114       git-annex(1)
115
116       git-annex-unlock(1)
117
118       git-annex-upgrade(1)
119
120       git-annex-sync(1)
121

AUTHOR

123       Joey Hess <id@joeyh.name>
124
125                                                           git-annex-adjust(1)
Impressum