git-lfs/docs/man/git-lfs-filter-process.1.ronn
Taylor Blau 04d5a84ebb docs/man/git-lfs-config.5.ronn: document GIT_LFS_SKIP_SMUDGE
Since its inception in [1], the `GIT_LFS_SKIP_SMUDGE` environment
variable has not been documented. This feature is not meant to be
hidden, so let's document how it works in `git-lfs-config.5` in case
users are interested in it.

Let's write this in `git-lfs-config(5)` since this is where environment
variables that aren't tied to a particular command go. We note its
existence in the related manual pages (e.g., `git-lfs-smudge(1)` and
`git-lfs-filter-process(1)`) but refer to the authoritative source in
`git-lfs-config(5)`.

[1]: 8cd51c00 (rename the options to SKIP_SMUDGE and --skip-smudge,
     2015-09-23)
2019-02-04 19:00:53 -08:00

35 lines
1.0 KiB
Markdown

git-lfs-filter-process(1) -- Git filter process that converts between pointer and actual content
===========================================================================================
## SYNOPSIS
`git lfs filter-process`
`git lfs filter-process --skip`
## DESCRIPTION
Implement the Git process filter API, exchanging handshake messages and then
accepting and responding to requests to either clean or smudge a file.
filter-process is always run by Git's filter process, and is configured by the
repository's Git attributes.
The filter process uses Git's pkt-line protocol to communicate, and is
documented in detail in gitattributes(5).
## OPTIONS
Without any options, filter-process accepts and responds to requests normally.
* `--skip`:
Skip automatic downloading of objects on clone or pull.
* `GIT_LFS_SKIP_SMUDGE`:
Disables the smudging process. For more, see: git-lfs-config(5).
## SEE ALSO
git-lfs-clean(1), git-lfs-install(1), git-lfs-smudge(1), gitattributes(5).
Part of the git-lfs(1) suite.