README revision 76082
1-*- text -*- 2RELNOTESng README 3Bruce A. Mah <bmah@freebsd.org> 4$FreeBSD: head/release/doc/README 76082 2001-04-27 21:28:02Z bmah $ 5 6This is the top-level directory for RELNOTESng, a re-write of 7FreeBSD's *.TXT documentation files. They have been converted to 8DocBook, and versions of the documents can be now be built for various 9supported architectures. The output files can be rendered in any 10format supported by the FreeBSD Documentation Project (for example, 11ASCII text, PDF, PS, HTML). 12 13RELNOTESng requires that the FreeBSD doc/ sources are installed; it 14leverages off of much of the DocProj build infrastructure, including 15DocBook extensions and stylesheets. If the doc/ sources are not 16installed in /usr/src, their location should be specified with the 17DOC_PREFIX Makefile variable. RELNOTESng also requires the DocProj 18build tools, which can easily be installed with the textproc/docproj 19port in the Ports Collection. 20 21share/sgml/*.dsl 22 Architecture-dependent stylesheets. These stylesheets support 23 the arch= attribute on (all?) DocBook elements. Currently- 24 supported values are: i386, alpha. 25share/sgml/release.ent 26 Release information. Need to update the entry definitions in 27 this file when rolling new revisions; these should take effect 28 in all documents. 29 30*/relnotes/common/ 31 Directory for multi-architecture release notes files. 32*/relnotes/*/ 33 Directories for architecture-specific release notes files. 34 35*/hardware/common/ 36 Directory for multi-architecture hardware notes files. 37*/hardware/*/ 38 Directories for architecture-specific hardware notes files. 39 40*/installation/common/ 41 Directory for multi-architecture installation notes files. 42 Note that the FreeBSD DocProj build infrastructure does 43 not handle documents (or subdirectories) named "install" 44 well, so we call our document "installation" and do 45 a hack when it gets installed into a distribution to fix 46 this up. 47*/installation/*/ 48 Directories for architecture-specific release notes files. 49 50*/errata/ 51 Directory for errata document. 52 53*/readme/ 54 Directory for (introductory) document. 55 56All definition of the "current" version of FreeBSD is contained in the 57share/sgml/release.ent file; release engineers should peruse the 58contents of this file carefully when doing version number bumps. 59 60When creating content for the architecture-dependent files, authors 61should use the arch= attribute to elements that are specific to a 62particular machine architecture. The value of this attribute should 63be a single word that indicates for which architecture the current 64element will be included. For example: 65 66 <para arch="alpha">Alpha-specific text</para> 67 68The currently-supported architectures are i386 and alpha. As of this 69writing there is no mechanism for supporting multiple architectures 70(i.e. arch="alpha,ia64"), but with some work in the stylesheets this 71should be possible. 72 73When creating a translation, make a new directory under this 74directory with a language code (paralleling the DocProj directory 75structure). 76 77RELNOTESng is supported in the FreeBSD release-build process. For 78now, the building of RELNOTESng is enabled by RELNOTESNG=YES when 79building a release. Note that setting RELNOTESng requires that both 80NODOC and NOPORTS *not* be set, as RELNOTESng require parts of 81both. Eventually, RELNOTESNG will be made the default. 82 83Release builders can set which language gets built with the 84RELNOTESNG_LANG variable; note that this is different from the 85DOC_LANG variable because (at least intially) most languages 86will have localized DocProj files but not localized release notes. 87The default language, if none is specified, is en_US.ISO_8859-1. 88 89