How To Build The FreeBSD Documentation Tree?
in [FreeBSD]
|
Prev: NYC LOCAL: Tuesday 2 February 2010 NYLUG Hack Workshop: Robert Menes on Smalltalk
Next: Hardwaresuggestions for ZFS Fileserver
From: Tim Daneliuk on 3 Feb 2010 00:46 Is it sufficient to do 'make buildworld' or do I have to go to /usr/doc and do a make of some kind there separately? Thanks, -- ---------------------------------------------------------------------------- Tim Daneliuk tundra(a)tundraware.com PGP Key: http://www.tundraware.com/PGP/
From: Tim Daneliuk on 3 Feb 2010 09:17 On 2/3/2010 3:43 AM, Chronos wrote: > Tim Daneliuk wrote: > >> Is it sufficient to do 'make buildworld' or do I have to go to >> /usr/doc and do a make of some kind there separately? > > http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/ and > http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/overview- > quick-start.html Thanks, I found this after I posted the original request. But ... here's what I'm still a little fuzzy on: - Do I have to issue an explicit 'make install' to get the stuff I built in /usr/doc to /usr/share/doc? - Does a buildworld invoke this documentation build process automatically? (I'm guessing not). - How do I get the "old" docs in /usr/src/share/doc to build and install? I've done it manually, but it seems as if buildworld/installworld isn't automatically doing this. TIA, ---------------------------------------------------------------------------- Tim Daneliuk tundra(a)tundraware.com PGP Key: http://www.tundraware.com/PGP/
From: Lowell Gilbert on 3 Feb 2010 10:38 Tim Daneliuk <tundra(a)tundraware.com> writes: > On 2/3/2010 3:43 AM, Chronos wrote: >> Tim Daneliuk wrote: >> >>> Is it sufficient to do 'make buildworld' or do I have to go to >>> /usr/doc and do a make of some kind there separately? >> >> http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/ and >> http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/overview- >> quick-start.html > > Thanks, I found this after I posted the original request. > > But ... here's what I'm still a little fuzzy on: > > - Do I have to issue an explicit 'make install' to get the stuff I built > in /usr/doc to /usr/share/doc? Yes. > - Does a buildworld invoke this documentation build process automatically? > (I'm guessing not). Correct. A number of ports are required to build the doc tree, so it can't be built on a bare system like a buildworld has to be capable of. > - How do I get the "old" docs in /usr/src/share/doc to build and install? > I've done it manually, but it seems as if buildworld/installworld isn't > automatically doing this. Then you've done something locally to stop it. -- Lowell Gilbert, embedded/networking software engineer http://be-well.ilk.org/~lowell/
From: Giorgos Keramidas on 3 Feb 2010 19:41 On Tue, 02 Feb 2010 23:46:06 -0600, Tim Daneliuk <tundra(a)tundraware.com> wrote: > Is it sufficient to do 'make buildworld' or do I have to go to /usr/doc and > do a make of some kind there separately? No, this is not sufficient. You need the documentation toolchain and the documentation sources. The required tools and the build process are described in the FreeBSD Documentation Primer for New Contributors: http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/ The main idea is that you need a recent checkout of the doc/ tree (you can use CVSup to obtain one). Then you can install the doc utils through the metaport textproc/docproj-jadetex, and run: $ cd /home/keramida/work/freebsd/doc $ make FORMATS="html html-split" $ sudo make FORMATS='html html-split' DOCDIR='/usr/doc' install This is most useful if you intend to start contributing *patches* to the documentation though (which you should feel free to do; we need all the help we can get). If you are just looking for a nice way to get recent snapshots of the HTML docs, you can grab them from the online copies. They are updated at least once a day. HTH, Giorgos
From: Tim Daneliuk on 4 Feb 2010 09:43
On 2/3/2010 6:41 PM, Giorgos Keramidas wrote: > On Tue, 02 Feb 2010 23:46:06 -0600, Tim Daneliuk <tundra(a)tundraware.com> wrote: >> Is it sufficient to do 'make buildworld' or do I have to go to /usr/doc and >> do a make of some kind there separately? > > No, this is not sufficient. You need the documentation toolchain and > the documentation sources. The required tools and the build process are > described in the FreeBSD Documentation Primer for New Contributors: > > http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/ > > The main idea is that you need a recent checkout of the doc/ tree (you > can use CVSup to obtain one). Then you can install the doc utils > through the metaport textproc/docproj-jadetex, and run: > > $ cd /home/keramida/work/freebsd/doc > $ make FORMATS="html html-split" > $ sudo make FORMATS='html html-split' DOCDIR='/usr/doc' install > > This is most useful if you intend to start contributing *patches* to the > documentation though (which you should feel free to do; we need all the > help we can get). > > If you are just looking for a nice way to get recent snapshots of the > HTML docs, you can grab them from the online copies. They are updated > at least once a day. > > HTH, > Giorgos > Thanks Giorgos, that's most helpful. The one thing I've not been able to determine (and I admit spending only an hour or so on this so far) is if I just do "make install" without the FORMATS variable defined, what actually gets produced? Thanks again! -- ---------------------------------------------------------------------------- Tim Daneliuk tundra(a)tundraware.com PGP Key: http://www.tundraware.com/PGP/ |