git-lfs/docs/man/git-lfs-uninstall.1.ronn
Chris Darroch e36cc12117 docs: add worktree option to install and uninstall
Add help text to document the --worktree option we've added
to the "git lfs install" and "git lfs uninstall" commands,
along with a reference to git-worktree(1) as it further explains
the use of the extensions.worktreeConfig setting.
2020-06-26 14:56:06 -07:00

42 lines
1.4 KiB
Markdown

git-lfs-uninstall(1) -- Remove Git LFS configuration
=================================================
## SYNOPSIS
`git lfs uninstall`
## DESCRIPTION
Perform the following actions to remove the Git LFS configuration:
* Remove the "lfs" clean and smudge filters from the global Git config.
* Uninstall the Git LFS pre-push hook if run from inside a Git repository.
## OPTIONS
* --local:
Removes the "lfs" smudge and clean filters from the local repository's git
config, instead of the global git config (~/.gitconfig).
* --worktree:
Removes the "lfs" smudge and clean filters from the current working tree's
git config, instead of the global git config (~/.gitconfig) or local
repository's git config ($GIT_DIR/config).
If multiple working trees are in use, the Git config extension
`worktreeConfig` must be enabled to use this option.
If only one working tree is in use, `--worktree` has the same effect
as `--local`.
This option is only available if the installed Git version is at least
2.20.0 and therefore supports the "worktreeConfig" extension.
* --system:
Removes the "lfs" smudge and clean filters from the system git config,
instead of the global git config (~/.gitconfig).
* --skip-repo:
Skips cleanup of the local repo; use if you want to uninstall the global lfs
filters but not make changes to the current repo.
## SEE ALSO
git-lfs-install(1), git-worktree(1).
Part of the git-lfs(1) suite.