How to build FreeBSD doc web pages?

[Craig Rodrigues]

On Sun, Feb 24, 2013 at 3:30 PM, Giorgos Keramidas <keramida at freebsd.org>wrote:

> On 2013-02-24 13:35, Craig Rodrigues <rodrigc at FreeBSD.org> wrote:
>
> The makefile glue for building the website assumes that DESTDIR is also
> set to something.  Try installing with:
>
>   cd ~rodrigc/public_html/doc2/doc
>   cd en_US.ISO8859-1/htdocs
>
>   env DESTDIR="$HOME/public_html/doc1" \
>     make install
>
> Setting DESTDIR during 'make install' for htdocs/ will automatically
> also set DOCDIR to $DESTDIR/data/doc so you don't have to specify it
> too.
>
> To speed up checks for the 'make install' run, it may also be useful
> to set ENLISH_ONLY=yes, so you skip all the translations at first.
>
> What you did ended up installing the Handbook's index.html over the
> doc/en_US.ISO8859-1/htdocs/index.xsl output.
>


Ah OK, thanks for the tip.
Also looking at Glen Barber's script ~gjb/bin/docbuild.sh helped
me understand a lot.  Would it be appropriate to add an
example to the fdp primer such as the one below?

That would have improved my understanding of how to do this.

It looks like this:

http://people.freebsd.org/~rodrigc/doc2/doc/en_US.ISO8859-1/books/fdp-primer/the-website-install.html

--
Craig
-------------- next part --------------
Index: doc/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml
===================================================================
--- doc/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml	(revision 41038)
+++ doc/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml	(working copy)
@@ -151,6 +151,19 @@
 	  root.</para>
 
 	<screen>&prompt.root; <userinput><command>env</command> <makevar>DESTDIR</makevar>=<replaceable>/usr/local/www</replaceable> <command>make</command> <maketarget>install</maketarget></userinput></screen>
+        <tip>
+	  <para>While modifying documentation, you may wish to build
+            and install only a subset of the full documentation in
+            order to to preview your changes.  For example, the
+            following command will build and install only the English
+            language web pages.</para>
+	  <screen>&prompt.root; <userinput><command>cd</command> <replaceable>/usr/build/en_US.ISO8859-1/htdocs</replaceable></userinput>
+&prompt.root; <command>env</command> <makevar>GEN_INDEX</makevar>=<replaceable>yes</replaceable> <makevar>DESTDIR</makevar>=<replaceable>/usr/local/www</replaceable> \
+    <command>make</command> \
+    <makevar>ENGLISH_ONLY</makevar>=<replaceable>yes</replaceable> \
+    <makevar>WEB_ONLY</makevar>=<replaceable>yes</replaceable> \
+    <maketarget>all</maketarget> <maketarget>install</maketarget> </screen>
+        </tip>
       </step>
 
       <step>