From: Nikos Mavrogiannopoulos <nmav@gnutls.org>
Date: Tue, 14 Feb 2012 11:05:13 +0000 (+0100)
Subject: updated documentation for included programs.
X-Git-Tag: gnutls_3_0_13~47
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a4bc93184738e4226e1a8079c68ff4be2c9c2b53;p=thirdparty%2Fgnutls.git

updated documentation for included programs.
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index e07d90b2a2..28c16fafc1 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -30,41 +30,57 @@ endif
 
 invoke-gnutls-cli.texi: ../src/cli-args.def
 	@-cd ../src/ && autogen -Tagtexi-cmd.tpl $< && \
-	mv -f ../src/$@ ../doc
+	rm -f ../doc/$@ && \
+	../doc/scripts/cleanup-autogen.pl <../src/$@ >../doc/$@ && \
+	rm -f ../src/$@
 
 invoke-gnutls-cli-debug.texi: ../src/cli-debug-args.def
 	@-cd ../src/ && autogen -Tagtexi-cmd.tpl $< && \
-	mv -f ../src/$@ ../doc
+	rm -f ../doc/$@ && \
+	../doc/scripts/cleanup-autogen.pl <../src/$@ >../doc/$@ && \
+	rm -f ../src/$@
 
 invoke-gnutls-serv.texi: ../src/serv-args.def
 	@-cd ../src/ && autogen -Tagtexi-cmd.tpl $< && \
-	mv -f ../src/$@ ../doc
+	rm -f ../doc/$@ && \
+	../doc/scripts/cleanup-autogen.pl <../src/$@ >../doc/$@ && \
+	rm -f ../src/$@
 
 invoke-certtool.texi: ../src/certtool-args.def
 	@-cd ../src/ && autogen -Tagtexi-cmd.tpl $< && \
-	mv -f ../src/$@ ../doc
+	rm -f ../doc/$@ && \
+	../doc/scripts/cleanup-autogen.pl <../src/$@ >../doc/$@ && \
+	rm -f ../src/$@
 
-invoke-srptool.texi: ../src/srptool-args.def
+invoke-ocsptool.texi: ../src/ocsptool-args.def
 	@-cd ../src/ && autogen -Tagtexi-cmd.tpl $< && \
-	sed -i 's/@subsection/@subsubsection/g' $@ && \
-	sed -i 's/@section/@subsection/g' $@ && \
-	mv -f ../src/$@ ../doc
+	rm -f ../doc/$@ && \
+	../doc/scripts/cleanup-autogen.pl <../src/$@ >../doc/$@ && \
+	rm -f ../src/$@
 
-invoke-ocsptool.texi: ../src/ocsptool-args.def
+invoke-srptool.texi: ../src/srptool-args.def
 	@-cd ../src/ && autogen -Tagtexi-cmd.tpl $< && \
-	mv -f ../src/$@ ../doc
+	rm -f ../doc/$@ && \
+	../doc/scripts/cleanup-autogen.pl <../src/$@ >../doc/$@ && \
+	rm -f ../src/$@ && \
+	sed -i 's/@subheading/@subsubheading/g' ../doc/$@ && \
+	sed -i 's/@section/@subsection/g' ../doc/$@
 
 invoke-psktool.texi: ../src/psk-args.def
 	@-cd ../src/ && autogen -Tagtexi-cmd.tpl $< && \
-	sed -i 's/@subsection/@subsubsection/g' $@ && \
-	sed -i 's/@section/@subsection/g' $@ && \
-	mv -f ../src/$@ ../doc
+	rm -f ../doc/$@ && \
+	../doc/scripts/cleanup-autogen.pl <../src/$@ >../doc/$@ && \
+	rm -f ../src/$@ && \
+	sed -i 's/@subheading/@subsubheading/g' ../doc/$@ && \
+	sed -i 's/@section/@subsection/g' ../doc/$@
 
 invoke-p11tool.texi: ../src/p11tool-args.def
 	@-cd ../src/ && autogen -Tagtexi-cmd.tpl $< && \
-	sed -i 's/@subsection/@subsubsection/g' $@ && \
-	sed -i 's/@section/@subsection/g' $@ && \
-	mv -f ../src/$@ ../doc
+	rm -f ../doc/$@ && \
+	../doc/scripts/cleanup-autogen.pl <../src/$@ >../doc/$@ && \
+	rm -f ../src/$@ && \
+	sed -i 's/@subheading/@subsubheading/g' ../doc/$@ && \
+	sed -i 's/@section/@subsection/g' ../doc/$@
 
 info_TEXINFOS = gnutls.texi gnutls-guile.texi
 gnutls_TEXINFOS = gnutls.texi fdl-1.3.texi				\
diff --git a/doc/gnutls.texi b/doc/gnutls.texi
index 74c556e1c5..9d98de5e4b 100644
--- a/doc/gnutls.texi
+++ b/doc/gnutls.texi
@@ -49,7 +49,7 @@ Documentation License''.
 @subtitle Transport Layer Security Library for the GNU system
 @subtitle for version @value{VERSION}, @value{UPDATED}
 @sp 7
-@image{gnutls-logo,6cm,6cm}
+@center @image{gnutls-logo,6cm,6cm}
 @author Nikos Mavrogiannopoulos
 @author Simon Josefsson (@email{bug-gnutls@@gnu.org})
 @page
@@ -160,13 +160,13 @@ Documentation License''.
 * Internal architecture of GnuTLS::
 * Support::
 * Error codes::
-* API reference::
 * Supported ciphersuites::
+* API reference::
 * Copying Information::
-* Concept Index::
+* Bibliography::
 * Function and Data Index::
+* Concept Index::
 @c * @mybibnode{}::
-* Bibliography::
 @end menu
 
 @include cha-preface.texi
@@ -195,10 +195,10 @@ Documentation License''.
 
 @include cha-errors.texi
 
-@include cha-functions.texi
-
 @include cha-ciphersuites.texi
 
+@include cha-functions.texi
+
 @include cha-copying.texi
 
 @include cha-bib.texi
diff --git a/doc/scripts/cleanup-autogen.pl b/doc/scripts/cleanup-autogen.pl
new file mode 100755
index 0000000000..7d2d43a010
--- /dev/null
+++ b/doc/scripts/cleanup-autogen.pl
@@ -0,0 +1,53 @@
+eval '(exit $?0)' && eval 'exec perl -wS "$0" ${1+"$@"}'
+  & eval 'exec perl -wS "$0" $argv:q'
+    if 0;
+
+# Copyright (C) 2012 Free Software Foundation, Inc.
+#
+# This file is part of GnuTLS.
+#
+# This file is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This file is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this file; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+my $line;
+my $init = 0;
+my $menu = 0;
+
+while ($line = <>) {
+  if ($line =~ /\@node/) {
+    if ($init == 0) {
+      $init = 1;
+    } else {
+      next;
+    }
+  }
+
+  if ($line =~ /\@menu/) {
+    $menu = 1;
+    next;
+  }
+
+  if ($line =~ /\@end menu/) {
+    $menu = 0;
+    next;
+  }
+
+  next if ($menu != 0);
+
+  if ($line =~ /\@subsection\s(.*)/) {
+    $line = "\@subheading $1\n";
+  }
+
+  print $line;
+}