mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
git-annex/doc/git-annex-assist.mdwn

70 lines
1.7 KiB
Text
Raw Normal View History

git-annex assist assist: New command, which is the same as git-annex sync but with new files added and content transferred by default. (Also this fixes another reversion in git-annex sync, --commit --no-commit, and --message were not enabled, oops.) See added comment for why git-annex assist does commit staged changes elsewhere in the work tree, but only adds files under the cwd. Note that it does not support --no-commit, --no-push, --no-pull like sync does. My thinking is, why should it? If you want that level of control, use git commit, git annex push, git annex pull. Sync only got those options because pull and push were not split out. Sponsored-by: k0ld on Patreon
2023-05-18 18:37:29 +00:00
# NAME
git-annex assist - add files and sync changes with remotes
# SYNOPSIS
git annex assist `[remote ...]`
# DESCRIPTION
This command assists you in checking files into the repository
and syncing with remotes. It's the simplest possible way to use git-annex
at the command line, since only this one command needs to be run on a
regular basis.
assist: operate on all files in working tree by default Consistency with sync and internal consistency is more important than consistency with the assistant, which is not itself consistent about what it does when run in a subdirectory. Note that with -C, it will still commit staged changes to files outside the directory. Like sync does. Presumably if the user is manually staging things, then running this command, they intend to build up a commit. Sponsored-by: unqueued on Patreon
2023-05-19 18:47:05 +00:00
This command first adds any new files to the repository, and commits those
as well as any modified files. Then it does the equivilant of running
git-annex assist assist: New command, which is the same as git-annex sync but with new files added and content transferred by default. (Also this fixes another reversion in git-annex sync, --commit --no-commit, and --message were not enabled, oops.) See added comment for why git-annex assist does commit staged changes elsewhere in the work tree, but only adds files under the cwd. Note that it does not support --no-commit, --no-push, --no-pull like sync does. My thinking is, why should it? If you want that level of control, use git commit, git annex push, git annex pull. Sync only got those options because pull and push were not split out. Sponsored-by: k0ld on Patreon
2023-05-18 18:37:29 +00:00
[[git-annex-pull](1) followed by [[git-annex-push]](1).
assist: operate on all files in working tree by default Consistency with sync and internal consistency is more important than consistency with the assistant, which is not itself consistent about what it does when run in a subdirectory. Note that with -C, it will still commit staged changes to files outside the directory. Like sync does. Presumably if the user is manually staging things, then running this command, they intend to build up a commit. Sponsored-by: unqueued on Patreon
2023-05-19 18:47:05 +00:00
This command operates on all files in the whole working tree,
even when ran in a subdirectory. To limit it to operating on files in a
subdirectory, use the `--content-of` option.
git-annex assist assist: New command, which is the same as git-annex sync but with new files added and content transferred by default. (Also this fixes another reversion in git-annex sync, --commit --no-commit, and --message were not enabled, oops.) See added comment for why git-annex assist does commit staged changes elsewhere in the work tree, but only adds files under the cwd. Note that it does not support --no-commit, --no-push, --no-pull like sync does. My thinking is, why should it? If you want that level of control, use git commit, git annex push, git annex pull. Sync only got those options because pull and push were not split out. Sponsored-by: k0ld on Patreon
2023-05-18 18:37:29 +00:00
To block some files from being added to the repository, use `.gitignore`
files.
By default, all files that are added are added to the annex, the same
as when you run `git annex add`. If you configure annex.largefiles,
files that it does not match will instead be added with `git add`.
# OPTIONS
document -m
2023-05-23 15:46:54 +00:00
* `--message=msg` `-m msg`
git-annex assist assist: New command, which is the same as git-annex sync but with new files added and content transferred by default. (Also this fixes another reversion in git-annex sync, --commit --no-commit, and --message were not enabled, oops.) See added comment for why git-annex assist does commit staged changes elsewhere in the work tree, but only adds files under the cwd. Note that it does not support --no-commit, --no-push, --no-pull like sync does. My thinking is, why should it? If you want that level of control, use git commit, git annex push, git annex pull. Sync only got those options because pull and push were not split out. Sponsored-by: k0ld on Patreon
2023-05-18 18:37:29 +00:00
Use this option to specify a commit message.
multiple -m second try Test suite passes this time. When committing the adjusted branch, use the old method to make a message that old git-annex can consume. Also made the code accept the new message, so that eventually commitTreeExactMessage can be removed. Sponsored-by: Kevin Mueller on Patreon
2024-04-09 16:56:47 +00:00
If multiple -m options are given, their values are concatenated
as separate paragraphs.
assist: operate on all files in working tree by default Consistency with sync and internal consistency is more important than consistency with the assistant, which is not itself consistent about what it does when run in a subdirectory. Note that with -C, it will still commit staged changes to files outside the directory. Like sync does. Presumably if the user is manually staging things, then running this command, they intend to build up a commit. Sponsored-by: unqueued on Patreon
2023-05-19 18:47:05 +00:00
* `--content-of=path` `-C path`
Only add, pull, and push files in the given path.
This option can be repeated multiple times with different paths.
git-annex assist assist: New command, which is the same as git-annex sync but with new files added and content transferred by default. (Also this fixes another reversion in git-annex sync, --commit --no-commit, and --message were not enabled, oops.) See added comment for why git-annex assist does commit staged changes elsewhere in the work tree, but only adds files under the cwd. Note that it does not support --no-commit, --no-push, --no-pull like sync does. My thinking is, why should it? If you want that level of control, use git commit, git annex push, git annex pull. Sync only got those options because pull and push were not split out. Sponsored-by: k0ld on Patreon
2023-05-18 18:37:29 +00:00
* Also all options supported by [[git-annex-pull]](1) and
[[git-annex-push]](1) can be used.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)
[[git-annex-add]](1)
[[git-annex-pull]](1)
[[git-annex-push]](1)
[[git-annex-sync]](1)
[[git-annex-assistant]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
Reference in a new issue Copy permalink