close bug report and improve docs that led to it being filed

This commit is contained in:
Joey Hess 2023-06-12 16:30:21 -04:00
parent 64738ea157
commit 6f0783d7a0
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
3 changed files with 22 additions and 11 deletions

View file

@ -15,18 +15,20 @@ If no path is specified, adds files from the current directory and below.
Files that are already checked into git and are unmodified, or that
git has been configured to ignore will be silently skipped.
If annex.largefiles is configured, and does not match a file,
`git annex add` will behave the same as `git add` and add the
non-large file directly to the git repository, instead of to the annex.
(By default dotfiles are assumed to not be large, and are added directly
to git, but annex.dotfiles can be configured to annex those too.)
See the git-annex manpage for documentation of these and other
configuration settings.
If annex.largefiles is configured (in git config, gitattributes, or
git-annex config), and does not match a file, `git annex add` will behave
the same as `git add` and add the non-large file directly to the git
repository, instead of to the annex. (By default dotfiles are assumed to
not be large, and are added directly to git, but annex.dotfiles can be
configured to annex those too.) See the git-annex manpage for documentation
of these and other configuration settings.
Large files are added to the annex in locked form, which prevents further
modification of their content unless unlocked by [[git-annex-unlock]](1).
(This is not the case however when a repository is in a filesystem not
supporting symlinks.)
By default, large files are added to the annex in locked form, which
prevents further modification of their content until
unlocked by [[git-annex-unlock]](1). (This is not the case however
when a repository is in a filesystem not supporting symlinks.)
The annex.addunlocked git config (and git-annex config) can be used to
change this behavior.
This command can also be used to add symbolic links, both symlinks to
annexed content, and other symlinks.

View file

@ -41,3 +41,5 @@ git config annex.addunlocked 'include=**/*.odt or include=**/*.pdf'
What do you think?
Cheers, Yann
> [[notabug|done]] --[[Joey]]

View file

@ -0,0 +1,7 @@
[[!comment format=mdwn
username="joey"
subject="""comment 4"""
date="2023-06-12T20:29:05Z"
content="""
I've updated the man page to document annex.addunlocked.
"""]]