Formatting of progdoc works in both HTML and LaTeX. The LaTeX output

still has somewhat weird spacing, but it will be hopefully easy
to fix.

diff --git a/doc/kernel-doc b/doc/kernel-doc
index cb28d304324821dfe0c1b445593cd23c209b4fc8..07d126225a5321500ff839623b04a502442c2ad0 100755 (executable)
--- a/doc/kernel-doc
+++ b/doc/kernel-doc
@@ -524,9 +524,7 @@ sub output_bird {
     my %args = %{$_[0]};
     my ($parameter, $section);
     my $count;
-    print "<sect2>Function\n";
-
-    print "<p><type>".$args{'functiontype'}."</type>\n";
+    print "<function><p><type>".$args{'functiontype'}."</type>\n";
     print "<funcdef>".$args{'function'}."</funcdef>\n";
     print "(";
     $count = 0;
@@ -539,7 +537,7 @@ sub output_bird {
     }
     print ")\n";
 
-    print "<sect3>Arguments\n";
+    print "<funcsect>Arguments\n";
     print "<p><descrip>\n";
     foreach $parameter (@{$args{'parameterlist'}}) {
        print "<tagp><type>".$args{'parametertypes'}{$parameter}."</type> <param>".$parameter."</param></tagp>\n";
@@ -551,7 +549,7 @@ sub output_bird {
        print "<p>\n";
        output_highlight($args{'sections'}{$section});
     }
-    print "<hrule>\n";
+    print "</function>\n";
 }
 
 # output in birddoc

diff --git a/doc/prog-foot.sgml b/doc/prog-foot.sgml
new file mode 100644 (file)
index 0000000..c847722
--- /dev/null
+++ b/doc/prog-foot.sgml
@@ -0,0 +1,2 @@
+
+</article>

diff --git a/doc/prog-intro.sgml b/doc/prog-intro.sgml
index 18637feb35c9f30d4b3526e99e76fc658b51b0b1..e4affaf870f6538f4fcc204ae59eaceee45914cd 100644 (file)
--- a/doc/prog-intro.sgml
+++ b/doc/prog-intro.sgml
@@ -137,7 +137,7 @@ script created using GNU Autoconf.
 
 <p>The documentation is generated using <file/SGMLtools/ with our own DTD
 and mapping rules. The printed form of the documentation is first converted
-from SGML to <LaTeX> and then processed by <LaTeX> and <file/dvips/ to
+from SGML to &latex; and then processed by &tex; and <file/dvips/ to
 produce a PostScript file.
 
 <p>The comments from C sources which form a part of the programmer's

diff --git a/doc/sbase/dist/birddoc/html/mapping b/doc/sbase/dist/birddoc/html/mapping
index e703fb47d96e46f45a8efa6efa334a4210acedd5..9d05a76a8f2b77753b69694ddd5b88d66133b0ef 100644 (file)
--- a/doc/sbase/dist/birddoc/html/mapping
+++ b/doc/sbase/dist/birddoc/html/mapping
@@ -182,6 +182,12 @@
 <funcdef>              "<B>"
 </funcdef>             "</B>"
 
+<function>             "<HR><H3>Function</H3>\n"
+</function>            "\n"
+
+<funcsect>             "<H3>"
+</funcsect>            "</H3>\n"
+
 % url support by HG
 
 <url>          +       "<@@url>[URL]\n"

diff --git a/doc/sbase/dist/birddoc/latex2e/mapping b/doc/sbase/dist/birddoc/latex2e/mapping
index e12ef7d310b395f3339ef31dd670bc8735ba7978..2875c6dd4a89e93b82e7d785076dab476b539461 100644 (file)
--- a/doc/sbase/dist/birddoc/latex2e/mapping
+++ b/doc/sbase/dist/birddoc/latex2e/mapping
@@ -190,6 +190,9 @@
 <tag>          +       "\\item\[{\\ttfamily "
 </tag>                 "}\] \\mbox{}\n\n"
 
+<tagp>         +       "\\item\[ "
+</tagp>                        "\] \\mbox{}\n\n"
+
 <cite>                 "\\cite{[ID]"
 </cite>                        "}"
 
@@ -250,6 +253,32 @@
 <cf>                   "{\\ttfamily "
 </cf>                  "}"
 
+<const>                        "{\\tt "
+</const>               "}"
+
+<func>                 "{\\it "
+</func>                        "\\/}"
+
+<struct>               "{\\tt "
+</struct>              "}"
+
+<param>                        "{\\it "
+</param>               "}"
+
+<type>                 "{\\rm "
+</type>                        "}"
+
+<funcdef>              "{\\it "
+</funcdef>             "\\/}"
+
+<function>             "\\bigbreak\\hrule\\nobreak\\bigskip\\nobreak\\leftline{\\bf Function}\\nobreak\\smallskip\\nobreak{\\parskip=0pt "
+</function>            "}\n\n"
+
+<funcsect>             "\n\\medbreak\\leftline{\\bf "
+</funcsect>            "}\\nobreak "
+
+<hrule>                        "\\hrule"
+
 % Added by mdw
 <cparam>               "\\cparam{"
 </cparam>              "}"

diff --git a/doc/sbase/dtd/birddoc.dtd b/doc/sbase/dtd/birddoc.dtd
index 4e818ab883b05a00044d9092035129b5c03d61ef..f7fbcc67cfbe2ed1a5aee3a670c41592a460c761 100644 (file)
--- a/doc/sbase/dtd/birddoc.dtd
+++ b/doc/sbase/dtd/birddoc.dtd
@@ -12,7 +12,12 @@ anywhere else. <pavel@ucw.cz>
      Tom Gordon.
 
      $Log$
-     Revision 1.2  2000-05-31 11:28:52  mj
+     Revision 1.3  2000-05-31 14:24:21  mj
+     Formatting of progdoc works in both HTML and LaTeX. The LaTeX output
+     still has somewhat weird spacing, but it will be hopefully easy
+     to fix.
+
+     Revision 1.2  2000/05/31 11:28:52  mj
      Added tags for markup of programmer's documentation.
 
      Revision 1.1  2000/05/29 12:05:21  mj
@@ -108,7 +113,7 @@ anywhere else. <pavel@ucw.cz>
 
 <!entity % sectpar 
         " %par; | figure | tabular | table | %mathpar; | 
-         %thrm; | %litprog; ">
+         %thrm; | %litprog; | function ">
 <!element birddoc o o 
         (sect | chapt | article | report | 
         book | letter | telefax | slides | notes | manpage ) >
@@ -172,6 +177,9 @@ anywhere else. <pavel@ucw.cz>
 <!element type - - (%inline)>
 <!element funcdef - - (%inline)>
 
+<!element function - - (%inline | p | funcsect)*>
+<!element funcsect - o (%inline)>
+
 <!entity   ftag     '<f>'    -- formula begin -- >
 <!entity   qendtag  '</sq>'>