diff options
author | Eric Andersen <andersen@codepoet.org> | 2004-03-13 08:32:14 +0000 |
---|---|---|
committer | Eric Andersen <andersen@codepoet.org> | 2004-03-13 08:32:14 +0000 |
commit | 55c704c119c871e25253d8dc3582f623d7d47708 (patch) | |
tree | efb07ee478a87f68f1f508a1c620ea1d28a3de8a | |
parent | ed43806c3b3394ea4ee94c5c9ab042d0aa51f033 (diff) | |
download | busybox-55c704c119c871e25253d8dc3582f623d7d47708.tar.gz |
Fix some doc generation problems
-rwxr-xr-x | docs/autodocifier.pl | 34 | ||||
-rw-r--r-- | docs/busybox_footer.pod | 11 |
2 files changed, 24 insertions, 21 deletions
diff --git a/docs/autodocifier.pl b/docs/autodocifier.pl index e06a1dad8..e1101d9d0 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; @@ -26,7 +26,7 @@ sub beautify { $text =~ s/"\s*"//sg; my @line = split("\n", $text); $text = join('', - map { + map { s/^\s*"//; s/"\s*$//; s/%/%%/g; @@ -42,10 +42,17 @@ 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 = + my @f0 = map { $_ !~ /^\s/ && s/(?<!\w)(-\w+)/B<$1>/g; $_ } split("\n", $usage->{full}); @@ -69,22 +76,19 @@ 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" : ""; 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" ; @@ -101,7 +105,7 @@ sub sgml_for_usage { ; } -# the keys are applet names, and +# the keys are applet names, and # the values will contain hashrefs of the form: # # { @@ -288,4 +292,4 @@ John BEPPU <b@ax9.org> =cut -# $Id: autodocifier.pl,v 1.24 2003/07/14 21:20:48 andersen Exp $ +# $Id: autodocifier.pl,v 1.25 2004/03/13 08:32:14 andersen Exp $ diff --git a/docs/busybox_footer.pod b/docs/busybox_footer.pod index 0fc29f4c4..d243a92d9 100644 --- a/docs/busybox_footer.pod +++ b/docs/busybox_footer.pod @@ -47,7 +47,7 @@ John Beppu <beppu@codepoet.org> Edward Betts <edward@debian.org> expr, hostid, logname, tty, wc, whoami, yes - + =for html <br> Brian Candler <B.Candler@pobox.com> @@ -62,10 +62,9 @@ Randolph Chung <tausq@debian.org> =for html <br> -Dave Cinege <dcinege@psychosis.com> +Dave Cinege <dcinege@psychosis.com> - more(v2), makedevs, dutmp, modularization, auto links file, - various fixes, Linux Router Project maintenance + more(v2), makedevs, modularization, various fixes =for html <br> @@ -99,7 +98,7 @@ Matt Kraai <kraai@alumni.carnegiemellon.edu> =for html <br> -John Lombardo <john@deltanet.com> +John Lombardo <john@deltanet.com> dirname, tr @@ -174,4 +173,4 @@ Glenn Engel <glenne@engel.org> =cut -# $Id: busybox_footer.pod,v 1.12 2003/07/14 21:20:48 andersen Exp $ +# $Id: busybox_footer.pod,v 1.13 2004/03/13 08:32:14 andersen Exp $ |