e2c8dc6778
Note that the implementation uses replaceFile, so that the actual replacement of the work tree file is atomic. This seems a good property to have! It would be possible for unlock in v6 mode to be run on files that do not have their content present. However, that would be a behavior change from before, and I don't see any immediate need to support it, so I didn't implement it.
46 lines
1.2 KiB
Markdown
46 lines
1.2 KiB
Markdown
# NAME
|
|
|
|
git-annex unlock - unlock files for modification
|
|
|
|
# SYNOPSIS
|
|
|
|
git annex unlock `[path ...]`
|
|
|
|
# DESCRIPTION
|
|
|
|
Normally, the content of annexed files is protected from being changed.
|
|
Unlocking an annexed file allows it to be modified. This replaces the
|
|
symlink for each specified file with a copy of the file's content.
|
|
You can then modify it and `git annex add` (or `git commit`) to save your
|
|
changes.
|
|
|
|
In repositories with annex.version 5 or earlier, unlocking a file is local
|
|
to the repository, and is temporary. With version 6, unlocking a file
|
|
changes how it is stored in the git repository (from a symlink to a pointer
|
|
file), so you can commit it like any other change. Also in version 6, you
|
|
can use `git add` to add a fie to the annex in unlocked form. This allows
|
|
workflows where a file starts out unlocked, is modified as necessary, and
|
|
is locked once it reaches its final version.
|
|
|
|
# OPTIONS
|
|
|
|
* file matching options
|
|
|
|
The [[git-annex-matching-options]](1)
|
|
can be used to specify files to unlock.
|
|
|
|
# SEE ALSO
|
|
|
|
[[git-annex]](1)
|
|
|
|
[[git-annex-edit]](1)
|
|
|
|
[[git-annex-add]](1)
|
|
|
|
[[git-annex-lock]](1)
|
|
|
|
# AUTHOR
|
|
|
|
Joey Hess <id@joeyh.name>
|
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
|