Skip to content

Commit

Permalink
docs: add post-commit hook man page
Browse files Browse the repository at this point in the history
Add a man page for git-lfs-post-commit(1) which largely
parallels the git-lfs-post-merge(1) one, as they have similar
purposes for Git LFS, namely, to ensure all tracked lockable
files are marked read-only in the working copy.
  • Loading branch information
chrisd8088 committed Mar 3, 2020
1 parent 9a8c9bb commit ae5d5b0
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,7 @@ MAN_ROFF_TARGETS = man/git-lfs-checkout.1 \
man/git-lfs-migrate.1 \
man/git-lfs-pointer.1 \
man/git-lfs-post-checkout.1 \
man/git-lfs-post-commit.1 \
man/git-lfs-post-merge.1 \
man/git-lfs-pre-push.1 \
man/git-lfs-prune.1 \
Expand Down Expand Up @@ -501,6 +502,7 @@ MAN_HTML_TARGETS = man/git-lfs-checkout.1.html \
man/git-lfs-migrate.1.html \
man/git-lfs-pointer.1.html \
man/git-lfs-post-checkout.1.html \
man/git-lfs-post-commit.1.html \
man/git-lfs-post-merge.1.html \
man/git-lfs-pre-push.1.html \
man/git-lfs-prune.1.html \
Expand Down
23 changes: 23 additions & 0 deletions docs/man/git-lfs-post-commit.1.ronn
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
git-lfs-post-commit(1) -- Git post-commit hook implementation
=================================================================

## SYNOPSIS

`git lfs post-commit`

## DESCRIPTION

Responds to Git post-commit events. It makes sure that any files which are
marked as lockable by `git lfs track` are read-only in the working copy, if
not currently locked by the local user.

Where the `git lfs post-merge` command, which has a similar purpose, must
examine all files in the working copy, `git lfs post-commit` can limit
itself checking only those files which have changed in `HEAD`. It primarily
handles newly added lockable files which have not yet been made read-only.

## SEE ALSO

git-lfs-post-merge(1), git-lfs-track(1)

Part of the git-lfs(1) suite.

0 comments on commit ae5d5b0

Please sign in to comment.