Add make-readme.pl script to generate links for module README files

This is the script I've used to create/update the README's in many
X.org modules so that people finding them packaged in distros or
mirrored on other sites have an easier time finding the origin and
our bugtracker/git/etc.

Signed-off-by: Alan Coopersmith <alan.coopersmith@sun.com>

1 files changed, 112 insertions, 0 deletions

diff --git a/make-readme.pl b/make-readme.pl
new file mode 100755
index 0000000..16354c5
--- /dev/null
+++ b/make-readme.pl
@@ -0,0 +1,112 @@
+#! /usr/bin/perl -w
+
+# Script to add some common URL's to X.Org module README files so that
+# people finding them packaged in distros or mirrored on other sites
+# have an easier time finding the origin and our bugtracker/git/etc.
+
+###########################################################################
+#
+# Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, and/or sell copies of the Software, and to permit persons
+# to whom the Software is furnished to do so, provided that the above
+# copyright notice(s) and this permission notice appear in all copies of
+# the Software and that both the above copyright notice(s) and this
+# permission notice appear in supporting documentation.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+# OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
+# INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
+# FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
+# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+# Except as contained in this notice, the name of a copyright holder
+# shall not be used in advertising or otherwise to promote the sale, use
+# or other dealings in this Software without prior written authorization
+# of the copyright holder.
+#
+###########################################################################
+
+use strict;
+use Cwd;
+
+my $module = cwd();
+$module =~ s|^.*/([^/]+)/([^/]+)$|$1/$2|;
+
+my $modname = $2;
+
+my $desc;
+
+my @manpage = glob('man/*.man');
+push @manpage, glob('*.man');
+
+foreach my $manpage (@manpage) {
+  if ($manpage && (-f $manpage)) {
+    open(my $MANPAGE, '<', $manpage) or warn "Cannot read $manpage\n";
+
+    while (my $l = <$MANPAGE>) {
+      if ($l =~ /^.SH NAME/) {
+	$desc = <$MANPAGE>;
+	last;
+      }
+    }
+    close($MANPAGE);
+
+    chomp($desc);
+
+    # Remove backslashes, such as \- instead of -
+    $desc =~ s/\\//g;
+
+    if ($modname =~ /^xf86-(input|video)-(.*)$/) {
+      my $driver = $2;
+
+      $desc =~ s/^\s*$driver/$modname/;
+      $desc =~ s/driver$/driver for the Xorg X server/;
+    }
+
+    last if ($desc ne '');
+  }
+}
+
+open(my $README, '>>', 'README') or die;
+
+if ($desc) {
+  print $README $desc, "\n";
+}
+
+print $README <<__EOF__;
+
+All questions regarding this software should be directed at the
+Xorg mailing list:
+
+        http://lists.freedesktop.org/mailman/listinfo/xorg
+
+Please submit bug reports to the Xorg bugzilla:
+
+        https://bugs.freedesktop.org/enter_bug.cgi?product=xorg
+
+The master development code repository can be found at:
+
+        git://anongit.freedesktop.org/git/xorg/$module
+
+        http://cgit.freedesktop.org/xorg/$module
+
+For patch submission instructions, see:
+
+	http://www.x.org/wiki/Development/Documentation/SubmittingPatches
+
+For more information on the git code manager, see:
+
+        http://wiki.x.org/wiki/GitPage
+
+__EOF__
+
+close($README);