Add more documentation to make_patchnum.pl
authorMax Maischein <corion@corion.net>
Sat, 3 Jan 2009 19:32:20 +0000 (20:32 +0100)
committerDavid Mitchell <davem@iabyn.com>
Sat, 11 Apr 2009 15:43:15 +0000 (16:43 +0100)
(cherry picked from commit 6033099bd810c53841b5867de9a8d9195be9c8b6)

make_patchnum.pl

index df26391..e93015f 100644 (file)
@@ -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