about summary refs log tree commit diff
path: root/doc/manual
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manual')
-rw-r--r--doc/manual/Makefile.am16
-rw-r--r--doc/manual/manual.xml57
-rw-r--r--doc/manual/nix-env.xml4
-rw-r--r--doc/manual/nix-instantiate.xml4
-rw-r--r--doc/manual/nix-store.xml4
-rw-r--r--doc/manual/opt-common-syn.xml4
-rw-r--r--doc/manual/opt-common.xml4
-rw-r--r--doc/manual/writing-nix-expressions.xml2
8 files changed, 43 insertions, 52 deletions
diff --git a/doc/manual/Makefile.am b/doc/manual/Makefile.am
index e577be8c6f96..8b084f0637dc 100644
--- a/doc/manual/Makefile.am
+++ b/doc/manual/Makefile.am
@@ -1,4 +1,4 @@
-ENV = SGML_CATALOG_FILES=$(docbookcatalog):$(docbookebnfcatalog)
+ENV = SGML_CATALOG_FILES=$(docbookcatalog)
 
 XMLLINT = $(ENV) $(xmllint) $(xmlflags) --catalogs
 XSLTPROC = $(ENV) $(xsltproc) $(xmlflags) --catalogs \
@@ -20,18 +20,18 @@ SOURCES = manual.xml introduction.xml installation.xml \
  troubleshooting.xml bugs.xml opt-common.xml opt-common-syn.xml \
  quick-start.xml nix-lang-ref.xml style.css images
 
-manual.is-valid: $(SOURCES) version.xml
-	$(XMLLINT) --noout --valid manual.xml
+manual.is-valid: $(SOURCES) version.txt
+	$(XMLLINT) --xinclude $< | $(XMLLINT) --noout --valid -
 	touch $@
 
-version.xml:
-	echo -n $(VERSION) > version.xml
+version.txt:
+	echo -n $(VERSION) > version.txt
 
 man $(MANS): $(SOURCES) manual.is-valid
-	$(XSLTPROC) $(docbookxsl)/manpages/docbook.xsl manual.xml
+	$(XSLTPROC) --xinclude $(docbookxsl)/manpages/docbook.xsl manual.xml
 
 manual.html: $(SOURCES) manual.is-valid images
-	$(XSLTPROC) --output manual.html $(docbookxsl)/html/docbook.xsl manual.xml
+	$(XSLTPROC) --xinclude --output manual.html $(docbookxsl)/html/docbook.xsl manual.xml
 
 all-local: manual.html
 
@@ -50,7 +50,7 @@ images:
 	cp $(docbookxsl)/images/callouts/*.png images/callouts
 	chmod +w -R images
 
-KEEP = manual.html manual.is-valid version.xml $(MANS)
+KEEP = manual.html manual.is-valid version.txt $(MANS)
 
 EXTRA_DIST = $(SOURCES) $(FIGURES) $(KEEP)
 
diff --git a/doc/manual/manual.xml b/doc/manual/manual.xml
index 645afa5e6c91..5bdb7b324be8 100644
--- a/doc/manual/manual.xml
+++ b/doc/manual/manual.xml
@@ -3,31 +3,14 @@
     PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
     "http://www.docbook.org/xml/4.3/docbook-xml-4.3.zip"
 [
-<!ENTITY introduction SYSTEM "introduction.xml">
-<!ENTITY quick-start SYSTEM "quick-start.xml">
-<!ENTITY installation SYSTEM "installation.xml">
-<!ENTITY package-management SYSTEM "package-management.xml">
-<!ENTITY writing-nix-expressions SYSTEM "writing-nix-expressions.xml">
-<!ENTITY build-farm SYSTEM "build-farm.xml">
-<!ENTITY opt-common SYSTEM "opt-common.xml">
-<!ENTITY opt-common-syn SYSTEM "opt-common-syn.xml">
-<!ENTITY nix-env SYSTEM "nix-env.xml">
-<!ENTITY nix-store SYSTEM "nix-store.xml">
-<!ENTITY nix-instantiate SYSTEM "nix-instantiate.xml">
-<!ENTITY nix-collect-garbage SYSTEM "nix-collect-garbage.xml">
-<!ENTITY nix-push SYSTEM "nix-push.xml">
-<!ENTITY nix-pull SYSTEM "nix-pull.xml">
-<!ENTITY nix-prefetch-url SYSTEM "nix-prefetch-url.xml">
-<!-- <!ENTITY nix-lang-ref SYSTEM "nix-lang-ref.xml"> -->
-<!ENTITY troubleshooting SYSTEM "troubleshooting.xml">
-<!ENTITY bugs SYSTEM "bugs.xml">
-<!ENTITY version SYSTEM "version.xml">
 ]>
 
 <book>
   <title>Nix User's Guide</title>
 
-  <subtitle>Draft (Version &version;)</subtitle>
+  <subtitle>Draft (Version <xi:include
+  xmlns:xi="http://www.w3.org/2001/XInclude"
+  href="version.txt" parse="text" />)</subtitle>
   
   <bookinfo>
     <author>
@@ -40,49 +23,49 @@
       <holder>Eelco Dolstra</holder>
     </copyright>
   </bookinfo>
-
-  &introduction;
-  &quick-start;
-  &installation;
-  &package-management;
-  &writing-nix-expressions;
-  &build-farm;
+  
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="introduction.xml" />
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="quick-start.xml" />
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="installation.xml" />
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="package-management.xml" />
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="writing-nix-expressions.xml" />
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="build-farm.xml" />
 
   <appendix>
     <title>Command Reference</title>
     <sect1>
       <title>nix-env</title>
-      &nix-env;
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nix-env.xml" />
     </sect1>
     <sect1>
       <title>nix-store</title>
-      &nix-store;
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nix-store.xml" />
     </sect1>
     <sect1>
       <title>nix-instantiate</title>
-      &nix-instantiate;
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nix-instantiate.xml" />
     </sect1>
     <sect1>
       <title>nix-collect-garbage</title>
-      &nix-collect-garbage;
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nix-collect-garbage.xml" />
     </sect1>
     <sect1>
       <title>nix-push</title>
-      &nix-push;
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nix-push.xml" />
     </sect1>
     <sect1>
       <title>nix-pull</title>
-      &nix-pull;
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nix-pull.xml" />
     </sect1>
     <sect1>
       <title>nix-prefetch-url</title>
-      &nix-prefetch-url;
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nix-prefetch-url.xml" />
     </sect1>
   </appendix>
 
-<!--  &nix-lang-ref; -->
+  <!--  &nix-lang-ref; -->
 
-  &troubleshooting;
-  &bugs;
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="troubleshooting.xml" />
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="bugs.xml" />
 
 </book>
diff --git a/doc/manual/nix-env.xml b/doc/manual/nix-env.xml
index 35107115a881..b830cd5eae9f 100644
--- a/doc/manual/nix-env.xml
+++ b/doc/manual/nix-env.xml
@@ -7,7 +7,7 @@
   <refsynopsisdiv>
     <cmdsynopsis>
       <command>nix-env</command>
-      &opt-common-syn;
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="opt-common-syn.xml#xpointer(/nop/*)" />
       <arg>
         <group choice='req'>
           <arg choice='plain'><option>--file</option></arg>
@@ -79,7 +79,7 @@
 
     <variablelist>
 
-      &opt-common;
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="opt-common.xml#xpointer(/nop/*)" />
 
       <varlistentry>
         <term><option>--file</option> / <option>-f</option></term>
diff --git a/doc/manual/nix-instantiate.xml b/doc/manual/nix-instantiate.xml
index dc72ab83bcd2..ec26eaa71379 100644
--- a/doc/manual/nix-instantiate.xml
+++ b/doc/manual/nix-instantiate.xml
@@ -7,7 +7,7 @@
   <refsynopsisdiv>
     <cmdsynopsis>
       <command>nix-instantiate</command>
-      &opt-common-syn;
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="opt-common-syn.xml#xpointer(/nop/*)" />
       <group choice='opt'>
         <arg choice='plain'><option>--parse-only</option></arg>
         <arg choice='plain'><option>--eval-only</option></arg>
@@ -41,7 +41,7 @@
 
     <variablelist>
 
-      &opt-common;
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="opt-common.xml#xpointer(/nop/*)" />
 
       <varlistentry>
         <term><option>--parse-only</option></term>
diff --git a/doc/manual/nix-store.xml b/doc/manual/nix-store.xml
index 9592396c38ed..1955a9b68acc 100644
--- a/doc/manual/nix-store.xml
+++ b/doc/manual/nix-store.xml
@@ -7,7 +7,7 @@
   <refsynopsisdiv>
     <cmdsynopsis>
       <command>nix-store</command>
-      &opt-common-syn;
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="opt-common-syn.xml#xpointer(/nop/*)" />
       <arg choice='plain'><replaceable>operation</replaceable></arg>
       <arg rep='repeat'><replaceable>options</replaceable></arg>
       <arg rep='repeat'><replaceable>arguments</replaceable></arg>
@@ -46,7 +46,7 @@
 
     <variablelist>
 
-      &opt-common;
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="opt-common.xml#xpointer(/nop/*)" />
 
     </variablelist>
 
diff --git a/doc/manual/opt-common-syn.xml b/doc/manual/opt-common-syn.xml
index 50f8f043dbbb..85740ba79702 100644
--- a/doc/manual/opt-common-syn.xml
+++ b/doc/manual/opt-common-syn.xml
@@ -1,3 +1,5 @@
+<nop>
+  
 <arg><option>--help</option></arg>
 <arg><option>--version</option></arg>
 <arg rep='repeat'><option>--verbose</option></arg>
@@ -17,3 +19,5 @@
 <arg><option>-K</option></arg>
 <arg><option>--fallback</option></arg>
 <arg><option>--readonly-mode</option></arg>
+
+</nop>
diff --git a/doc/manual/opt-common.xml b/doc/manual/opt-common.xml
index 7650d62e51ae..b0e581ff9075 100644
--- a/doc/manual/opt-common.xml
+++ b/doc/manual/opt-common.xml
@@ -1,3 +1,5 @@
+<nop>
+
 <varlistentry>
   <term><option>--help</option></term>
   <listitem>
@@ -182,3 +184,5 @@
     </para>
   </listitem>
 </varlistentry>
+
+</nop>
\ No newline at end of file
diff --git a/doc/manual/writing-nix-expressions.xml b/doc/manual/writing-nix-expressions.xml
index 28b70b786154..a465177f30f6 100644
--- a/doc/manual/writing-nix-expressions.xml
+++ b/doc/manual/writing-nix-expressions.xml
@@ -383,7 +383,7 @@ some fragments of
     that can be built by Nix (since when we fill in the arguments of
     the function, what we get is its body, which is the call to
     <varname>stdenv.mkDerivation</varname> in <xref
-    linkend='ex-hello-nix ' />).</para>
+    linkend='ex-hello-nix' />).</para>
 
   </callout>
generated by cgit-pink 1.4.1 (git 2.44.2) at 2024-12-19T11ยท13+0000