add git clean/smudge man pages

This commit is contained in:
Rick Olson 2014-06-02 16:56:01 -06:00
parent ac0e0bbfaa
commit cade956a7b
4 changed files with 51 additions and 0 deletions

@ -0,0 +1,20 @@
git-media-clean(1) -- Git clean filter that converts large files to pointers.
## SYNOPSIS
`git media clean` <path>
## DESCRIPTION
Clean calculates a SHA-256 signature of the data from STDOUT, and outputs a
Git Media pointer file. It also queues the file to be pushed by
git-media-push(1).
Clean is typicall run by Git's clean filter, configured by the repository's
Git attributes.
## SEE ALSO
git-media-init(1), git-media-push(1), gitattributes(5).
Part of the git-media(1) suite.

@ -12,4 +12,6 @@ current Git remote.
## SEE ALSO
git-media-clean(1).
Part of the git-media(1) suite.

@ -0,0 +1,22 @@
git-media-smudge(1) -- Git smudge filter that converts pointer in blobs to the actual content.
==============================================================================================
## SYNOPSIS
`git media smudge` <path>
## DESCRIPTION
Smudge takes a Git Media pointer file in STDIN, parses out the pointer's ID,
and then dumps the file's contents to STDOUT. The file will be downloaded from
the Git Media endpoint if needed. The optional <path> argument is only used for
a progress bar.
Smudge is typically run by Git's smudge filter, configured by the repository's
Git attributes.
## SEE ALSO
git-media-init(1), gitattributes(5).
Part of the git-media(1) suite.

@ -26,3 +26,10 @@ commands and low level ("plumbing") commands.
Ensure Git Media is configured properly.
* git-media-push(1):
Push queued large files to the Git Media endpoint.
### Low level commands (plumbing)
* git-media-clean(1):
Git clean filter that converts large files to pointers.
* git-media-smudge(1):
Git smudge filter that converts pointer in blobs to the actual content.