04d5a84ebb
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)
42 lines
1.1 KiB
Markdown
42 lines
1.1 KiB
Markdown
git-lfs-smudge(1) -- Git smudge filter that converts pointer in blobs to the actual content
|
|
===========================================================================================
|
|
|
|
## SYNOPSIS
|
|
|
|
`git lfs smudge` [<path>]
|
|
`git lfs smudge` --skip [<path>]
|
|
|
|
## DESCRIPTION
|
|
|
|
Read a Git LFS pointer file from standard input and write the contents
|
|
of the corresponding large file to standard output. If needed,
|
|
download the file's contents from the Git LFS endpoint. The <path>
|
|
argument, if provided, is only used for a progress bar.
|
|
|
|
Smudge is typically run by Git's smudge filter, configured by the repository's
|
|
Git attributes.
|
|
|
|
## OPTIONS
|
|
|
|
Without any options, `git lfs smudge` outputs the raw Git LFS content to
|
|
standard output.
|
|
|
|
* `--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).
|
|
|
|
## KNOWN BUGS
|
|
|
|
On Windows, Git does not handle files in the working tree larger than 4
|
|
gigabytes.
|
|
|
|
For more information, see: https://github.com/git-lfs/git-lfs/issues/2434.
|
|
|
|
## SEE ALSO
|
|
|
|
git-lfs-install(1), gitattributes(5).
|
|
|
|
Part of the git-lfs(1) suite.
|