]> granicus.if.org Git - p11-kit/commitdiff
doc: Move manual into doc/manual subdirectory
authorStef Walter <stefw@gnome.org>
Mon, 11 Mar 2013 09:56:07 +0000 (10:56 +0100)
committerStef Walter <stefw@gnome.org>
Tue, 12 Mar 2013 08:31:36 +0000 (09:31 +0100)
18 files changed:
.gitignore
Makefile.am
configure.ac
doc/Makefile.am
doc/manual/Makefile.am [new file with mode: 0644]
doc/manual/annotation-glossary.xml [moved from doc/annotation-glossary.xml with 100% similarity]
doc/manual/docbook-params.xsl [moved from doc/docbook-params.xsl with 100% similarity]
doc/manual/p11-kit-config.xml [moved from doc/p11-kit-config.xml with 100% similarity]
doc/manual/p11-kit-devel.xml [moved from doc/p11-kit-devel.xml with 100% similarity]
doc/manual/p11-kit-docs.sgml [moved from doc/p11-kit-docs.sgml with 100% similarity]
doc/manual/p11-kit-overrides.txt [moved from doc/p11-kit-overrides.txt with 100% similarity]
doc/manual/p11-kit-sections.txt [moved from doc/p11-kit-sections.txt with 100% similarity]
doc/manual/p11-kit-sharing.xml [moved from doc/p11-kit-sharing.xml with 100% similarity]
doc/manual/p11-kit-trust.xml [moved from doc/p11-kit-trust.xml with 97% similarity]
doc/manual/p11-kit.xml [moved from doc/p11-kit.xml with 99% similarity]
doc/manual/pkcs11.conf.xml [moved from doc/pkcs11.conf.xml with 100% similarity]
doc/manual/style.css [moved from doc/style.css with 100% similarity]
doc/manual/version.xml.in [moved from doc/version.xml.in with 100% similarity]

index ee5c6b3d586670a3ddcd1a4f6f924f92b2deabcd..506249e8c1b539a1681c6144f82d3e5d954ff850 100644 (file)
@@ -58,23 +58,23 @@ temp.txt
 
 /common/tests/hash-test
 
-/doc/html
-/doc/p11-kit-decl-list.txt
-/doc/p11-kit-decl.txt
-/doc/p11-kit-undeclared.txt
-/doc/p11-kit-undocumented.txt
-/doc/p11-kit-unused.txt
-/doc/p11-kit.args
-/doc/p11-kit.hierarchy
-/doc/p11-kit.interfaces
-/doc/p11-kit.prerequisites
-/doc/p11-kit.signals
-/doc/p11-kit.types
-/doc/tmpl/
-/doc/version.xml
-/doc/xml/
-/doc/*.5
-/doc/*.8
+/doc/manual/html
+/doc/manual/p11-kit-decl-list.txt
+/doc/manual/p11-kit-decl.txt
+/doc/manual/p11-kit-undeclared.txt
+/doc/manual/p11-kit-undocumented.txt
+/doc/manual/p11-kit-unused.txt
+/doc/manual/p11-kit.args
+/doc/manual/p11-kit.hierarchy
+/doc/manual/p11-kit.interfaces
+/doc/manual/p11-kit.prerequisites
+/doc/manual/p11-kit.signals
+/doc/manual/p11-kit.types
+/doc/manual/tmpl/
+/doc/manual/version.xml
+/doc/manual/xml/
+/doc/manual/*.5
+/doc/manual/*.8
 
 /p11-kit/p11-kit.pc
 /p11-kit/p11-kit-1.pc
index e7d53f5707ab51b0f238c9f040b30e51c9dd9434..86cc58c99c840b9d1b3f05499a62bb07e9800c03 100644 (file)
@@ -55,7 +55,7 @@ endif
 if ENABLE_GTK_DOC
 upload-doc: all
        rsync -Hvax --exclude doc build \
-               doc/html/./ $(WEBHOST):$(WEBBASE)/doc/p11-kit/./
+               doc/manual/html/./ $(WEBHOST):$(WEBBASE)/doc/p11-kit/./
 endif
 
 upload-release: $(DIST_ARCHIVES)
index 33565da8fcd672f8b7243cde5b856810854e2ab4..22bfbafef191c08675e18eef9e96ae26f9f58dc6 100644 (file)
@@ -279,10 +279,10 @@ if test x$enable_doc = xyes; then
        if test -z "$XSLTPROC"; then
                AC_MSG_ERROR([the xsltproc command was not found and --enable-doc requested])
        fi
-       doc_status="yes (manual, gtk-doc reference)"
+       doc_status="yes (manual, reference)"
 else
        enable_doc=no
-       doc_status="no (no manual, reference)"
+       doc_status="no (no manual or reference)"
 fi
 
 AC_MSG_CHECKING([whether to build documentation])
@@ -433,7 +433,8 @@ AC_CONFIG_FILES([Makefile
        common/Makefile
        common/tests/Makefile
        doc/Makefile
-       doc/version.xml
+       doc/manual/Makefile
+       doc/manual/version.xml
        po/Makefile.in
        p11-kit/Makefile
        p11-kit/tests/Makefile
index b27980e07be20ead8dc9a22dc81314a66830c396..27b5b4711921082da5a15ea3027950bfdc09a66a 100644 (file)
@@ -1,132 +1,2 @@
-abs_top_builddir = @abs_top_builddir@
 
-NULL =
-
-# We require automake 1.6 at least.
-AUTOMAKE_OPTIONS = 1.6
-
-# The name of the module, e.g. 'glib'.
-DOC_MODULE=p11-kit
-
-# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
-
-# The directory containing the source code. Relative to $(srcdir).
-# gtk-doc will search all .c & .h files beneath here for inline comments
-# documenting the functions and macros.
-# e.g. DOC_SOURCE_DIR=../../../gtk
-DOC_SOURCE_DIR=../p11-kit
-
-# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS= --version
-
-# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS= --rebuild-types --deprecated-guards="P11_KIT_DISABLE_DEPRECATED"
-
-# Extra options to supply to gtkdoc-mkdb.
-# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml
-
-# Extra options to supply to gtkdoc-mktmpl
-# e.g. MKTMPL_OPTIONS=--only-section-tmpl
-MKTMPL_OPTIONS=
-
-# Extra options to supply to gtkdoc-fixref. Not normally needed.
-# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
-FIXXREF_OPTIONS=
-
-# Used for dependencies. The docs will be rebuilt if any of these change.
-# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
-# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
-HFILE_GLOB=$(top_srcdir)/p11-kit/*.h
-CFILE_GLOB=$(top_srcdir)/p11-kit/*.c
-
-# Header files to ignore when scanning.
-# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES= \
-       private.h \
-       pkcs11.h \
-       conf.h \
-       debug.h \
-       dict.h \
-       mock-module.h \
-       pkcs11.h \
-       pkcs11x.h \
-       private.h \
-       util.h \
-       array.h \
-       compat.h \
-       mock-module.h
-
-# Images to copy into HTML directory.
-# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
-HTML_IMAGES=
-
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
-# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=p11-kit-config.xml p11-kit-sharing.xml \
-       p11-kit-devel.xml \
-       p11-kit-trust.xml \
-       p11-kit.xml \
-       annotation-glossary.xml \
-       $(NULL)
-
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
-# These files must be listed here *and* in content_files
-# e.g. expand_content_files=running.sgml
-expand_content_files=
-
-# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
-# Only needed if you are using gtkdoc-scangobj to dynamically query widget
-# signals and properties.
-# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
-# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-INCLUDES=
-GTKDOC_LIBS=
-
-# This includes the standard gtk-doc make rules, copied by gtkdocize.
-include $(top_srcdir)/gtk-doc.make
-
-if ENABLE_GTK_DOC
-man8_MANS = p11-kit.8
-man5_MANS = pkcs11.conf.5
-
-XSLTPROC_FLAGS = \
-        --nonet \
-        --stringparam man.output.quietly 1 \
-        --stringparam funcsynopsis.style ansi \
-        --stringparam man.th.extra1.suppress 1 \
-        --stringparam man.authors.section.enabled 0 \
-        --stringparam man.copyright.section.enabled 0
-
-XSLTPROC_MAN = \
-       $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl
-
-.xml.5:
-       $(AM_V_GEN) $(XSLTPROC_MAN) $<
-.xml.8:
-       $(AM_V_GEN) $(XSLTPROC_MAN) $<
-
-else # ENABLE_GTK_DOC
-
-man5_MANS =
-man8_MANS =
-
-endif # ENABLE_GTK_DOC
-
-MAN_IN_FILES = \
-       $(man8_MANS:.8=.xml) \
-       $(man5_MANS:.5=.xml) \
-       $(NULL)
-
-CLEANFILES += \
-       $(man5_MANS) \
-       $(man8_MANS) \
-       $(NULL)
-
-EXTRA_DIST += \
-       $(MAN_IN_FILES) \
-       version.xml.in \
-       version.xml \
-       $(NULL)
+SUBDIRS = manual
diff --git a/doc/manual/Makefile.am b/doc/manual/Makefile.am
new file mode 100644 (file)
index 0000000..59c8624
--- /dev/null
@@ -0,0 +1,132 @@
+abs_top_builddir = @abs_top_builddir@
+
+NULL =
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=p11-kit
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=../../p11-kit
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS= --version
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS= --rebuild-types --deprecated-guards="P11_KIT_DISABLE_DEPRECATED"
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=$(top_srcdir)/p11-kit/*.h
+CFILE_GLOB=$(top_srcdir)/p11-kit/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES= \
+       private.h \
+       pkcs11.h \
+       conf.h \
+       debug.h \
+       dict.h \
+       mock-module.h \
+       pkcs11.h \
+       pkcs11x.h \
+       private.h \
+       util.h \
+       array.h \
+       compat.h \
+       mock-module.h
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=p11-kit-config.xml p11-kit-sharing.xml \
+       p11-kit-devel.xml \
+       p11-kit-trust.xml \
+       p11-kit.xml \
+       annotation-glossary.xml \
+       $(NULL)
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+expand_content_files=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES=
+GTKDOC_LIBS=
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+if ENABLE_GTK_DOC
+man8_MANS = p11-kit.8
+man5_MANS = pkcs11.conf.5
+
+XSLTPROC_FLAGS = \
+        --nonet \
+        --stringparam man.output.quietly 1 \
+        --stringparam funcsynopsis.style ansi \
+        --stringparam man.th.extra1.suppress 1 \
+        --stringparam man.authors.section.enabled 0 \
+        --stringparam man.copyright.section.enabled 0
+
+XSLTPROC_MAN = \
+       $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl
+
+.xml.5:
+       $(AM_V_GEN) $(XSLTPROC_MAN) $<
+.xml.8:
+       $(AM_V_GEN) $(XSLTPROC_MAN) $<
+
+else # ENABLE_GTK_DOC
+
+man5_MANS =
+man8_MANS =
+
+endif # ENABLE_GTK_DOC
+
+MAN_IN_FILES = \
+       $(man8_MANS:.8=.xml) \
+       $(man5_MANS:.5=.xml) \
+       $(NULL)
+
+CLEANFILES += \
+       $(man5_MANS) \
+       $(man8_MANS) \
+       $(NULL)
+
+EXTRA_DIST += \
+       $(MAN_IN_FILES) \
+       version.xml.in \
+       version.xml \
+       $(NULL)
similarity index 97%
rename from doc/p11-kit-trust.xml
rename to doc/manual/p11-kit-trust.xml
index aeec16d3b294f402b694b570edd37eed4d833b02..0e06446fd508ffdb87666912f2eab92b04151f52 100644 (file)
@@ -66,7 +66,7 @@ $ pkg-config --variable p11_system_certificates p11-kit-1
        the box with NSS. The trust policy module provides NSS style
        PKCS#11 trust objects for NSS to retrieve.</para>
 
-       <para>The module may be used to replace the
+       <para>The module may be used to replace the
        <literal>libnssckbi.so</literal> file via an distribution
        specific alternatives mechanism or otherwise.</para>
 
@@ -82,7 +82,7 @@ $ pkg-config --variable p11_system_certificates p11-kit-1
        <para>The trust policy module can be used as a source of trust
        information for glib-networking's <literal>gnutls-pkcs11</literal> backend.
        The module provides PKCS#11 trust assertion objects as expected.</para>
-       
+
        <para>The module should work by default if the <literal>gnutls-pkcs11</literal>
        backend is selected as the glib-networking TLS backend.</para>
 </section>
@@ -101,7 +101,7 @@ $ pkg-config --variable p11_system_certificates p11-kit-1
                from this module by adding a file to <literal>/etc/pkcs11/modules</literal>
                called <literal>p11-kit-trust.module</literal> containing a
                <literal>trust-policy:</literal> line.</para></listitem>
-               <listitem><para>Disable this module completely by 
+               <listitem><para>Disable this module completely by
                adding a file to <literal>/etc/pkcs11/modules</literal>
                called <literal>p11-kit-trust.module</literal> containing a
                <literal>enable-in:</literal> line.</para></listitem>
similarity index 99%
rename from doc/p11-kit.xml
rename to doc/manual/p11-kit.xml
index 95b1c3ebf8e7bfb3f04d840725f4c9df7d8525be..5242b1a8403be208291fdbd40f88c7877f14b4f5 100644 (file)
@@ -33,7 +33,7 @@
                <command>p11-kit list-modules</command>
        </cmdsynopsis>
        <cmdsynopsis>
-               <command>p11-kit extract</command> <arg choice="plain">--filter=&lt;what&gt;</arg> 
+               <command>p11-kit extract</command> <arg choice="plain">--filter=&lt;what&gt;</arg>
                        <arg choice="plain">--format=&lt;type&gt;</arg> /path/to/destination
        </cmdsynopsis>
 </refsynopsisdiv>
similarity index 100%
rename from doc/style.css
rename to doc/manual/style.css
similarity index 100%
rename from doc/version.xml.in
rename to doc/manual/version.xml.in