From: Max Maischein <corion@corion.net>
Date: Sat, 3 Jan 2009 19:32:20 +0000 (+0100)
Subject: Add more documentation to make_patchnum.pl
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=6033099bd810c53841b5867de9a8d9195be9c8b6;p=p5sagit%2Fp5-mst-13.2.git

Add more documentation to make_patchnum.pl
---

diff --git a/make_patchnum.pl b/make_patchnum.pl
index df26391..e93015f 100644
--- a/make_patchnum.pl
+++ b/make_patchnum.pl
@@ -9,7 +9,22 @@ make_patchnum.pl - make patchnum
 
 =head1 SYNOPSIS
 
-...
+  miniperl make_patchnum.pl
+
+  perl make_patchnum.pl
+
+This program creates the files holding the information
+about locally applied patches to the source code. The created
+files are C<.patchnum>, C<unpushed.h> and C<lib/Config_git.pl>.
+
+C<.patchnum> contains ???
+
+C<lib/Config_git.pl> contains the configuration of git for
+this branch.
+
+C<unpushed.h> contains the local changes that haven't been
+synchronized with the remote repository as configured with
+C<< git configure branch.<current branch>.remote >>
 
 =cut