[nautilus-actions] docs/reference: fix reference HTML generation



commit d8344e1863886e633cff5d03ccc25cb0a654c4c0
Author: Pierre Wieser <pwieser trychlos org>
Date:   Thu Feb 16 10:59:21 2017 +0100

    docs/reference: fix reference HTML generation

 docs/README                      |   36 +++++++++++++++++++++++++++---------
 docs/reference/fma-compiling.xml |    4 ++--
 maintainer/run-autogen.sh        |    3 ++-
 3 files changed, 31 insertions(+), 12 deletions(-)
---
diff --git a/docs/README b/docs/README
index dac0d69..073fd14 100644
--- a/docs/README
+++ b/docs/README
@@ -1,13 +1,31 @@
 docs
 ----
-As of FileManager-Actions 3.4, the documentation is composed of two
-main parts:
-- the Reference Manual describes all features of the product, rather
-  targeting developers and packagers;
-- the FileManager-Actions Configuration Tool User's Manual.
+ As of FileManager-Actions 3.4, the documentation is composed of two
+ main parts:
 
-All the documentation, whether it targets users or developers, is made
-of architecture-independent files, and so default to be included in the
-distributed tarball.
+ - the Reference Manual describes all features of the product, rather
+   targeting developers and packagers;
 
-P. Wieser, last updated on sept. 2015
+ - the FileManager-Actions Configuration Tool User's Manual.
+
+ All the documentation, whether it targets users or developers, is made
+ of architecture-independent files, and so default to be included in the
+ distributed tarball.
+
+Build system rationale
+----------------------
+ As all the documentation is distributed, the following rules apply:
+
+ - default options do not build the documentation
+ 
+ - because the packager is able to install the documentation from the
+   distributed tarball, it is enough if only the maintainer is able to
+   build this documentation
+
+ - as a consequence, while the source build system must stay compatible
+   with the oldest targeted distribution, the documentation build system
+   may be more recent, as it will only be run on the maintainer
+   development machine
+
+-----------------------------------------------------------------------
+ P. Wieser, last updated on feb. 2017
diff --git a/docs/reference/fma-compiling.xml b/docs/reference/fma-compiling.xml
index 973a589..63180bc 100644
--- a/docs/reference/fma-compiling.xml
+++ b/docs/reference/fma-compiling.xml
@@ -162,7 +162,7 @@
         <group>
           <arg>--with-nautilus-extdir=DIR</arg>
           <!--
-          <arg>--with-nemo-extdir=DIR</arg>
+          <arg>with-nemo-extdir=DIR</arg>
           -->
           <arg>--with-default-io-provider=io-gconf|io-desktop</arg>
           <arg>--enable-html-manuals[=gdt|db2html]</arg>
@@ -174,7 +174,7 @@
     <formalpara>
       <title><systemitem>--with-nautilus-extdir=DIR</systemitem></title>
       <!--
-      <title><systemitem>--with-nemo-extdir=DIR</systemitem></title>
+      <title><systemitem>with-nemo-extdir=DIR</systemitem></title>
       -->
       <para>
         With this option, one may define an alternate directory where
diff --git a/maintainer/run-autogen.sh b/maintainer/run-autogen.sh
index 5c6d66b..e478d66 100755
--- a/maintainer/run-autogen.sh
+++ b/maintainer/run-autogen.sh
@@ -59,7 +59,8 @@
 # see: https://wiki.gnome.org/Projects/GnomeCommon/Migration
 
 if [ ! -f configure.ac ]; then
-       echo "> This script is only meant to be run from the top source directory." 1>&2
+       echo "> This script is a maintainer-only script." 1>&2
+       echo "> It is only meant to be run from the top source directory." 1>&2
        exit 1
 fi
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]