Skip to content

Commit

Permalink
Add manpages
Browse files Browse the repository at this point in the history
  • Loading branch information
mika committed Sep 25, 2008
1 parent d7517a7 commit 4c0bcda
Show file tree
Hide file tree
Showing 4 changed files with 99 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/Makefile
Expand Up @@ -8,7 +8,8 @@
sed -i 's/\.sp//' `echo $^ |sed -e 's/.txt//'`
gzip -f --best `echo $^ |sed -e 's/.txt//'`

MANPAGES = git-last.1
MANPAGES = git-last.1 git-publish-branch.1 git-rank-contributors.1 git-wtf.1


all: doc

Expand Down
30 changes: 30 additions & 0 deletions docs/git-publish-branch.1.txt
@@ -0,0 +1,30 @@
git-publish-branch(1)
=====================

Name
----
git-publish-branch - publish a branch to a remote repository

Synopsis
--------
git-publish-branch <branch>

Description
-----------

git-publish-branch is a simple script to ease the unnecessarily complex task of
"publishing" a branch, i.e., taking a local branch, creating a reference to it
on a remote repo, and setting up the local branch to track the remote one, all
in one go.

You give it a branch name, and that branch is published in your remote
repository. That's it. If you use -d, it will delete the remote reference.

Useful if you publish your topic branches to the outside world.

Authors
-------

Author of git-publish-branch is William Morgan <wmorgan-git-wt-add@masanjin.net>.

This manpage was written by Michael Prokop <mika@grml.org>.
39 changes: 39 additions & 0 deletions docs/git-rank-contributors.1.txt
@@ -0,0 +1,39 @@
git-rank-contributors(1)
========================

Name
----
git-rank-contributors - rank all authors by patch size

Synopsis
--------
git-rank-contributors [-v] [-o]

Description
-----------

git-rank-contributors is a trivial script that paws through your logs and ranks
all the contributors by the size of their diffs. As always, bigger is better!

This is similar to git shortlog -s -n --no-merges, but counts diff size rather
than number of commits.

Options
-------

-v

Get the raw diff size.

-o

Get high-tech email obfuscation. Output with just -o may be suitable for piping
into a CREDITS file. It probably will require some editing in case people submit
from more than one email address, though.

Authors
-------

Author of git-rank-contributors is William Morgan <wmorgan-git-wt-add@masanjin.net>.

This manpage was written by Michael Prokop <mika@grml.org>.
28 changes: 28 additions & 0 deletions docs/git-wtf.1.txt
@@ -0,0 +1,28 @@
git-wtf(1)
==========

Name
----
git-wtf - understand the current state of your git repository

Synopsis
--------
git-last [<branch>]

Description
-----------

git-wtf is a tool for working with feature branches. If you're on a feature
branch, it tells you which version branches it's merged into. If you're on a
version branch, it tells you which feature branches are merged in and which
aren't. For every branch, if it's a tracking branch, it tells you which commits
need to be pulled and which need to be pushed.

Use immediately after git fetch.

Authors
-------

Author of git-wtf is William Morgan <wmorgan-git-wt-add@masanjin.net>.

This manpage was written by Michael Prokop <mika@grml.org>.

0 comments on commit 4c0bcda

Please sign in to comment.