X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=docs%2Fautodocifier.pl;h=3aa838eb40cc74b5ba4f8cb7cf1bd778e30b75dd;hb=7a431b3715299854fb423ec00d5fafc0e2c7f07b;hp=377c8b55b385c524128730d7667b16f9974ee346;hpb=ce22feea01132e8316213d2cb9b7aa06885f7234;p=oweals%2Fbusybox.git

diff --git a/docs/autodocifier.pl b/docs/autodocifier.pl
index 377c8b55b..3aa838eb4 100755
--- a/docs/autodocifier.pl
+++ b/docs/autodocifier.pl
@@ -3,7 +3,7 @@
 use strict;
 use Getopt::Long;
 
-# collect lines continued with a '\' into an array 
+# collect lines continued with a '\' into an array
 sub continuation {
 	my $fh = shift;
 	my @line;
@@ -21,12 +21,17 @@ sub continuation {
 # regex && eval away unwanted strings from documentation
 sub beautify {
 	my $text = shift;
-	$text =~ s/USAGE_NOT\w+\(.*?"\s*\)//sxg;
-	$text =~ s/USAGE_\w+\(\s*?(.*?)"\s*\)/$1"/sxg;
+	for (;;) {
+		my $text2 = $text;
+		$text =~ s/SKIP_\w+\(.*?"\s*\)//sxg;
+		$text =~ s/USE_\w+\(\s*?(.*?)"\s*\)/$1"/sxg;
+		$text =~ s/USAGE_\w+\(\s*?(.*?)"\s*\)/$1"/sxg;
+		last if ( $text2 eq $text );
+	}
 	$text =~ s/"\s*"//sg;
 	my @line = split("\n", $text);
 	$text = join('',
-		map { 
+		map {
 			s/^\s*"//;
 			s/"\s*$//;
 			s/%/%%/g;
@@ -42,12 +47,23 @@ sub pod_for_usage {
 	my $name  = shift;
 	my $usage = shift;
 
+	# Sigh.  Fixup the known odd-name applets.
+	$name =~ s/dpkg_deb/dpkg-deb/g;
+	$name =~ s/fsck_minix/fsck.minix/g;
+	$name =~ s/mkfs_minix/mkfs.minix/g;
+	$name =~ s/run_parts/run-parts/g;
+	$name =~ s/start_stop_daemon/start-stop-daemon/g;
+
 	# make options bold
 	my $trivial = $usage->{trivial};
-	$trivial =~ s/(?<!\w)(-\w+)/B<$1>/sxg;
-	my @f0 = 
+	if (!defined $usage->{trivial}) {
+		$trivial = "";
+	} else {
+		$trivial =~ s/(?<!\w)(-\w+)/B<$1>/sxg;
+	}
+	my @f0 =
 		map { $_ !~ /^\s/ && s/(?<!\w)(-\w+)/B<$1>/g; $_ }
-		split("\n", $usage->{full});
+		split("\n", (defined $usage->{full} ? $usage->{full} : ""));
 
 	# add "\n" prior to certain lines to make indented
 	# lines look right
@@ -69,39 +85,31 @@ sub pod_for_usage {
 
 	# prepare examples if they exist
 	my $example = (defined $usage->{example})
-		?  
+		?
 			"Example:\n\n" .
-			join ("\n", 
-			map  { "\t$_" } 
+			join ("\n",
+			map  { "\t$_" }
 			split("\n", $usage->{example})) . "\n\n"
 		: "";
 
+	# Pad the name so that the applet name gets a line
+	# by itself in BusyBox.txt
+	my $spaces = 10 - length($name);
+	if ($spaces > 0) {
+		$name .= " " x $spaces;
+	}
+
 	return
 		"=item B<$name>".
-		"\n\n"  .
-		"$name $trivial".
-		"\n\n"  .
-		$full   .
-		"\n\n"  .
-		$notes  .
-		$example.
-		"-------------------------------".
+		"\n\n$name $trivial\n\n".
+		"$full\n\n"   .
+		"$notes"  .
+		"$example" .
 		"\n\n"
 	;
 }
 
-# FIXME | generate SGML for an applet
-sub sgml_for_usage {
-	my $name  = shift;
-	my $usage = shift;
-	return
-		"<fixme>\n".
-		"  $name\n".
-		"</fixme>\n"
-	;
-}
-
-# the keys are applet names, and 
+# the keys are applet names, and
 # the values will contain hashrefs of the form:
 #
 # {
@@ -120,7 +128,6 @@ my %opt;
 GetOptions(
 	\%opt,
 	"help|h",
-	"sgml|s",
 	"pod|p",
 	"verbose|v",
 );
@@ -129,7 +136,6 @@ if (defined $opt{help}) {
 	print
 		"$0 [OPTION]... [FILE]...\n",
 		"\t--help\n",
-		"\t--sgml\n",
 		"\t--pod\n",
 		"\t--verbose\n",
 	;
@@ -159,11 +165,22 @@ foreach (@ARGV) {
 # generate structured documentation
 
 my $generator = \&pod_for_usage;
-if (defined $opt{sgml}) {
-	$generator = \&sgml_for_usage;
+
+my @names = sort keys %docs;
+my $line = "\t[, [[, ";
+for (my $i = 0; $i < $#names; $i++) {
+	if (length ($line.$names[$i]) >= 65) {
+		print "$line\n\t";
+		$line = "";
+	}
+	$line .= "$names[$i], ";
 }
+print $line . $names[-1];
+
+print "\n\n=head1 COMMAND DESCRIPTIONS\n";
+print "\n=over 4\n\n";
 
-foreach my $applet (sort keys %docs) {
+foreach my $applet (@names) {
 	print $generator->($applet, $docs{$applet});
 }
 
@@ -187,18 +204,18 @@ Example:
 
 =head1 DESCRIPTION
 
-The purpose of this script is to automagically generate documentation
-for busybox using its usage.h as the original source for content.
-It used to be that same content has to be duplicated in 3 places in
-slightly different formats -- F<usage.h>, F<docs/busybox.pod>, and
-F<docs/busybox.sgml>.  This was tedious and error-prone, so it was
+The purpose of this script is to automagically generate
+documentation for busybox using its usage.h as the original source
+for content.  It used to be that same content has to be duplicated
+in 3 places in slightly different formats -- F<usage.h>,
+F<docs/busybox.pod>.  This was tedious and error-prone, so it was
 decided that F<usage.h> would contain all the text in a
 machine-readable form, and scripts could be used to transform this
 text into other forms if necessary.
 
-F<autodocifier.pl> is one such script.
-It was based on a script by Erik Andersen <andersen@lineo.com>
-which was in turn based on a script by Mark Whitley <markw@lineo.com>
+F<autodocifier.pl> is one such script.  It is based on a script by
+Erik Andersen <andersen@codepoet.org> which was in turn based on a
+script by Mark Whitley <markw@codepoet.org>
 
 =head1 OPTIONS
 
@@ -212,10 +229,6 @@ This displays the help message.
 
 Generate POD (this is the default)
 
-=item B<--sgml>
-
-Generate SGML
-
 =item B<--verbose>
 
 Be verbose (not implemented)
@@ -288,4 +301,4 @@ John BEPPU <b@ax9.org>
 
 =cut
 
-# $Id: autodocifier.pl,v 1.23 2001/10/31 04:29:18 beppu Exp $
+# $Id: autodocifier.pl,v 1.26 2004/04/06 15:26:25 andersen Exp $