summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore34
-rw-r--r--Makefile.am2
-rw-r--r--configure.ac7
-rw-r--r--doc/Makefile.am132
-rw-r--r--doc/manual/Makefile.am132
-rw-r--r--doc/manual/annotation-glossary.xml (renamed from doc/annotation-glossary.xml)0
-rw-r--r--doc/manual/docbook-params.xsl (renamed from doc/docbook-params.xsl)0
-rw-r--r--doc/manual/p11-kit-config.xml (renamed from doc/p11-kit-config.xml)0
-rw-r--r--doc/manual/p11-kit-devel.xml (renamed from doc/p11-kit-devel.xml)0
-rw-r--r--doc/manual/p11-kit-docs.sgml (renamed from doc/p11-kit-docs.sgml)0
-rw-r--r--doc/manual/p11-kit-overrides.txt (renamed from doc/p11-kit-overrides.txt)0
-rw-r--r--doc/manual/p11-kit-sections.txt (renamed from doc/p11-kit-sections.txt)0
-rw-r--r--doc/manual/p11-kit-sharing.xml (renamed from doc/p11-kit-sharing.xml)0
-rw-r--r--doc/manual/p11-kit-trust.xml (renamed from doc/p11-kit-trust.xml)6
-rw-r--r--doc/manual/p11-kit.xml (renamed from doc/p11-kit.xml)2
-rw-r--r--doc/manual/pkcs11.conf.xml (renamed from doc/pkcs11.conf.xml)0
-rw-r--r--doc/manual/style.css (renamed from doc/style.css)0
-rw-r--r--doc/manual/version.xml.in (renamed from doc/version.xml.in)0
18 files changed, 159 insertions, 156 deletions
diff --git a/.gitignore b/.gitignore
index ee5c6b3..506249e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -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
diff --git a/Makefile.am b/Makefile.am
index e7d53f5..86cc58c 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -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)
diff --git a/configure.ac b/configure.ac
index 33565da..22bfbaf 100644
--- a/configure.ac
+++ b/configure.ac
@@ -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
diff --git a/doc/Makefile.am b/doc/Makefile.am
index b27980e..27b5b47 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -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
index 0000000..59c8624
--- /dev/null
+++ b/doc/manual/Makefile.am
@@ -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)
diff --git a/doc/annotation-glossary.xml b/doc/manual/annotation-glossary.xml
index 4a0f8a6..4a0f8a6 100644
--- a/doc/annotation-glossary.xml
+++ b/doc/manual/annotation-glossary.xml
diff --git a/doc/docbook-params.xsl b/doc/manual/docbook-params.xsl
index 5d8591a..5d8591a 100644
--- a/doc/docbook-params.xsl
+++ b/doc/manual/docbook-params.xsl
diff --git a/doc/p11-kit-config.xml b/doc/manual/p11-kit-config.xml
index ca07769..ca07769 100644
--- a/doc/p11-kit-config.xml
+++ b/doc/manual/p11-kit-config.xml
diff --git a/doc/p11-kit-devel.xml b/doc/manual/p11-kit-devel.xml
index bbe6c0a..bbe6c0a 100644
--- a/doc/p11-kit-devel.xml
+++ b/doc/manual/p11-kit-devel.xml
diff --git a/doc/p11-kit-docs.sgml b/doc/manual/p11-kit-docs.sgml
index 0397169..0397169 100644
--- a/doc/p11-kit-docs.sgml
+++ b/doc/manual/p11-kit-docs.sgml
diff --git a/doc/p11-kit-overrides.txt b/doc/manual/p11-kit-overrides.txt
index e69de29..e69de29 100644
--- a/doc/p11-kit-overrides.txt
+++ b/doc/manual/p11-kit-overrides.txt
diff --git a/doc/p11-kit-sections.txt b/doc/manual/p11-kit-sections.txt
index dc85f2d..dc85f2d 100644
--- a/doc/p11-kit-sections.txt
+++ b/doc/manual/p11-kit-sections.txt
diff --git a/doc/p11-kit-sharing.xml b/doc/manual/p11-kit-sharing.xml
index a1c19a7..a1c19a7 100644
--- a/doc/p11-kit-sharing.xml
+++ b/doc/manual/p11-kit-sharing.xml
diff --git a/doc/p11-kit-trust.xml b/doc/manual/p11-kit-trust.xml
index aeec16d..0e06446 100644
--- a/doc/p11-kit-trust.xml
+++ b/doc/manual/p11-kit-trust.xml
@@ -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>
diff --git a/doc/p11-kit.xml b/doc/manual/p11-kit.xml
index 95b1c3e..5242b1a 100644
--- a/doc/p11-kit.xml
+++ b/doc/manual/p11-kit.xml
@@ -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>
diff --git a/doc/pkcs11.conf.xml b/doc/manual/pkcs11.conf.xml
index 3146f60..3146f60 100644
--- a/doc/pkcs11.conf.xml
+++ b/doc/manual/pkcs11.conf.xml
diff --git a/doc/style.css b/doc/manual/style.css
index 3d0f951..3d0f951 100644
--- a/doc/style.css
+++ b/doc/manual/style.css
diff --git a/doc/version.xml.in b/doc/manual/version.xml.in
index 27323da..27323da 100644
--- a/doc/version.xml.in
+++ b/doc/manual/version.xml.in