Docs: AUTHORS formatting updates.
authorGerald Combs <gerald@wireshark.org>
Fri, 17 Aug 2018 17:33:45 +0000 (10:33 -0700)
committerAnders Broman <a.broman58@gmail.com>
Sat, 18 Aug 2018 21:44:00 +0000 (21:44 +0000)
Switch the AUTHORS heading markup from underscores to equals. This makes
it easier to transform to Pod headings.

Update the AUTHORS-SHORT-FORMAT output so that the author lists are
verbatim paragraphs. Add a style for the author lists instead of
wrapping everything in a <pre>.

The AUTHORS files are UTF-8 and wireshark.pod sets "=encoding utf8".
There's no need to translate characters.

Change-Id: I43cf18ff86774421b08edb84d968a9410be177fe
Reviewed-on: https://code.wireshark.org/review/29181
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
AUTHORS
AUTHORS.src
doc/make-authors-format.pl
tools/generate_authors.pl

diff --git a/AUTHORS b/AUTHORS
index e07c1f97c0f6430304518e4be9c0820091e7077c..6003edf2a5087003ba12a0a6688fe75ec5b5fc79 100644 (file)
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,12 +1,12 @@
 
 
-Original Author
--------- ------
+= Original Author =
+
 Gerald Combs            <gerald[AT]wireshark.org>
 
 
-Contributors
-------------
+= Contributors =
+
 Gilbert Ramirez         <gram[AT]alumni.rice.edu> {
        Wiretap
        Printing
@@ -3533,7 +3533,7 @@ Subramanian Ramachandran <sramach6[AT]ncsu.edu> {
        Support for BFD for MPLS LSP's as per RFC 5884
 }
 
-Manuel Hofer           <manuel[At]mnlhfr.at> {
+Manuel Hofer           <manuel[AT]mnlhfr.at> {
        OpenVPN dissector
        SSTP Dissection
 }
@@ -3962,8 +3962,8 @@ Benoît Canet             <benoit[AT]scylladb.com>
 Håkon Øye Amundsen      <haakon.amundsen[AT]nordicsemi.no>
 
 
-From git log
----------------
+= From git log =
+
 Adam Goldman           <adam.goldman[AT]intel.com>
 Adam Mitz              <mitza[AT]ociweb.com>
 Adam Pridgen           <adam.pridgen[AT]thecoverofnight.com>
@@ -4327,6 +4327,7 @@ Merlin Chlosta            <merlin.chlosta+gnuradio[AT]ruhr-uni-bochum.de>
 Micha Reiser           <michafamreiser.ch>
 Michael Adam           <obnox[AT]samba.org>
 Michael Cistera                <michael.cistera[AT]netscout.com>
+Michael Honsel         <lesnoh[AT]gmx.de>
 Michael McConville     <mmcco[AT]mykolab.com>
 Michael Oed            <michael.oed[AT]gmail.com>
 Michael Pergament      <mpergament[AT]googlemail.com>
@@ -4417,8 +4418,10 @@ Prerit Jain              <prerit.jain[AT]samsung.com>
 Priyanka Mondal                <priyanka02010[AT]gmail.com>
 Radhashyam Behera      <radhashyambehera[AT]gmail.com>
 Rado Radoulov          <rad0x6f[AT]gmail.com>
+Ralf Nasilowski                <Ralf.Nasilowski[AT]ise.de>
 Ray Gomez              <rayvincent.gomez[AT]gmail.com>
 Remi Gacogne           <remi.gacogne[AT]powerdns.com>
+Remous-Aris Koutsiamanis <aris[AT]ariskou.com>
 Ricardo Cristian Ramirez <r.cristian.ramirez[AT]gmail.com>
 Rich Coe               <richcoe2[AT]gmail.com>
 Richard Kuemmel                <kuemmel.ric[AT]googlemail.com>
@@ -4565,8 +4568,8 @@ shqking                   <shqking[AT]gmail.com>
 Дмитрий Цветцих          <dmitrycvet[AT]gmail.com>
 
 
-Acknowledgements
-------------
+= Acknowledgements =
+
 Dan Lasley <dlasley[AT]promus.com> gave permission for his
 dumpit() hex-dump routine to be used.
 
index 56cfc53fc677f1d32a136d81872ce92e6fec4675..ec50683c48f4dafdb4a8a266e62d2e7c2a4a826e 100644 (file)
@@ -1,12 +1,12 @@
 
 
-Original Author
--------- ------
+= Original Author =
+
 Gerald Combs            <gerald[AT]wireshark.org>
 
 
-Contributors
-------------
+= Contributors =
+
 Gilbert Ramirez         <gram[AT]alumni.rice.edu> {
        Wiretap
        Printing
@@ -3533,7 +3533,7 @@ Subramanian Ramachandran <sramach6[AT]ncsu.edu> {
        Support for BFD for MPLS LSP's as per RFC 5884
 }
 
-Manuel Hofer           <manuel[At]mnlhfr.at> {
+Manuel Hofer           <manuel[AT]mnlhfr.at> {
        OpenVPN dissector
        SSTP Dissection
 }
@@ -3961,8 +3961,8 @@ João Valverde            <joao.valverde[AT]tecnico.ulisboa.pt>
 Benoît Canet          <benoit[AT]scylladb.com>
 Håkon Øye Amundsen      <haakon.amundsen[AT]nordicsemi.no>
 
-Acknowledgements
-------------
+= Acknowledgements =
+
 Dan Lasley <dlasley[AT]promus.com> gave permission for his
 dumpit() hex-dump routine to be used.
 
index 33d4a116a5f34afad5ccda4fe894da8acf90d07b..f5124a117e2c6344e0a114800224b337536e62bc 100755 (executable)
 
 use strict;
 
-print "=for html <pre>\n\n";
+# This might not be necessary.
+print "=for html <style>div#authors pre, div#authors pre code { white-space: pre-wrap; }</style>\n\n";
+print "=for html <div id=authors>\n\n";
+
 print "=for man .nf\n\n";
 
 while (<>) {
        printline();
 }
 
-print "\n=for html </pre>\n";
+print "\n=for html </div>\n";
 print "\n=for man .fi\n";
 
 sub printline {
        my $line = shift || $_;
-#
-# Translate UTF-8 characters to the E<> escapes handled by Pod::Man
-# (and only those, since they're a subset of HTML entities)
-#
-       $line =~ s/\xc3\x80/E<Agrave>/g;
-       $line =~ s/\xc3\x81/E<Aacute>/g;
-       $line =~ s/\xc3\x82/E<Acirc>/g;
-       $line =~ s/\xc3\x83/E<Atilde>/g;
-       $line =~ s/\xc3\x84/E<Auml>/g;
-       $line =~ s/\xc3\x85/E<Aring>/g;
-       $line =~ s/\xc3\x86/E<AElig>/g;
-       $line =~ s/\xc3\x87/E<Ccedil>/g;
-       $line =~ s/\xc3\x88/E<Egrave>/g;
-       $line =~ s/\xc3\x89/E<Eacute>/g;
-       $line =~ s/\xc3\x8a/E<Ecirc>/g;
-       $line =~ s/\xc3\x8b/E<Euml>/g;
-       $line =~ s/\xc3\x8c/E<Igrave>/g;
-       $line =~ s/\xc3\x8d/E<Iacute>/g;
-       $line =~ s/\xc3\x8e/E<Icirc>/g;
-       $line =~ s/\xc3\x8f/E<Iuml>/g;
-       $line =~ s/\xc3\x90/E<ETH>/g;
-       $line =~ s/\xc3\x91/E<Ntilde>/g;
-       $line =~ s/\xc3\x92/E<Ograve>/g;
-       $line =~ s/\xc3\x93/E<Oacute>/g;
-       $line =~ s/\xc3\x94/E<Ocirc>/g;
-       $line =~ s/\xc3\x95/E<Otilde>/g;
-       $line =~ s/\xc3\x96/E<Ouml>/g;
-       $line =~ s/\xc3\x98/E<Oslash>/g;
-       $line =~ s/\xc3\x99/E<Ugrave>/g;
-       $line =~ s/\xc3\x9a/E<Uacute>/g;
-       $line =~ s/\xc3\x9b/E<Ucirc>/g;
-       $line =~ s/\xc3\x9c/E<Uuml>/g;
-       $line =~ s/\xc3\x9d/E<Yacute>/g;
-       $line =~ s/\xc3\x9e/E<THORN>/g;
-       $line =~ s/\xc3\x9f/E<szlig>/g;
-       $line =~ s/\xc3\xa0/E<agrave>/g;
-       $line =~ s/\xc3\xa1/E<aacute>/g;
-       $line =~ s/\xc3\xa2/E<acirc>/g;
-       $line =~ s/\xc3\xa3/E<atilde>/g;
-       $line =~ s/\xc3\xa4/E<auml>/g;
-       $line =~ s/\xc3\xa5/E<aring>/g;
-       $line =~ s/\xc3\xa6/E<aelig>/g;
-       $line =~ s/\xc3\xa7/E<ccedil>/g;
-       $line =~ s/\xc3\xa8/E<egrave>/g;
-       $line =~ s/\xc3\xa9/E<eacute>/g;
-       $line =~ s/\xc3\xaa/E<ecirc>/g;
-       $line =~ s/\xc3\xab/E<euml>/g;
-       $line =~ s/\xc3\xac/E<igrave>/g;
-       $line =~ s/\xc3\xad/E<iacute>/g;
-       $line =~ s/\xc3\xae/E<icirc>/g;
-       $line =~ s/\xc3\xaf/E<iuml>/g;
-       $line =~ s/\xc3\xb0/E<eth>/g;
-       $line =~ s/\xc3\xb1/E<ntilde>/g;
-       $line =~ s/\xc3\xb2/E<ograve>/g;
-       $line =~ s/\xc3\xb3/E<oacute>/g;
-       $line =~ s/\xc3\xb4/E<ocirc>/g;
-       $line =~ s/\xc3\xb5/E<otilde>/g;
-       $line =~ s/\xc3\xb6/E<ouml>/g;
-       $line =~ s/\xc3\xb8/E<oslash>/g;
-       $line =~ s/\xc3\xb9/E<ugrave>/g;
-       $line =~ s/\xc3\xba/E<uacute>/g;
-       $line =~ s/\xc3\xbb/E<ucirc>/g;
-       $line =~ s/\xc3\xbc/E<uuml>/g;
-       $line =~ s/\xc3\xbd/E<yacute>/g;
-       $line =~ s/\xc3\xbe/E<thorn>/g;
-       $line =~ s/\xc3\xbf/E<yuml>/g;
+
+       if ($line =~ /^=/) {
+               #
+               # Convert Asciidoctor-style headings to Pod.
+               #
+               $line =~ s/^= /=head2 /;
+               $line =~ s/\s*=+$//;
+               print $line;
+               return;
+       }
+
+       if ($line =~ /<\S+\[AT\]\S+>$/i or $line =~ /address removed.*\)/) {
+               # Make the author lists verbatim paragraphs.
+               $line = "    " . $line;
+       }
+
+       if ($line =~ /^and by:/) {
+               # This needs to be a regular paragraph.
+               $line = "\n" . $line;
+       }
+
        print $line;
 }
index 9c7bd2adf38d7bc246d9e85ff063fe6778efb1f7..51ac89b6009b796ae31860270970d210dd7cb1d0 100755 (executable)
@@ -26,8 +26,8 @@ my $is_contributing = 0;
 
 my $header = "
 
-Original Author
--------- ------
+= Original Author =
+
 Gerald Combs            <gerald[AT]wireshark.org>
 
 
@@ -35,8 +35,8 @@ Gerald Combs            <gerald[AT]wireshark.org>
 
 my $trailer = "
 
-Acknowledgements
-------------
+= Acknowledgements =
+
 Dan Lasley <dlasley[AT]promus.com> gave permission for his
 dumpit() hex-dump routine to be used.
 
@@ -71,8 +71,8 @@ to use QCustomPlot.
 ";
 
 my $git_log_text = "
-From git log
----------------
+= From git log =
+
 ";
 
 # Perl trim function to remove whitespace from the start and end of the string