os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add infrastructure necessary to build the release notes with the web

Browse source 
site.  This is currently conditional on BUILD_RELNOTES being set,
which it isn't by default.  See the README for more information.

Discussed with:	bmah
This commit is contained in:
Dima Dorfman 2001-05-25 05:08:03 +00:00
parent 7c9d3b090a
commit 043f0bdcc7
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/www/; revision=9492
3 changed files with 72 additions and 1 deletions

5
en/Makefile
View file

@ -1,4 +1,4 @@
# $FreeBSD: www/en/Makefile,v 1.64 2001/04/22 17:34:53 wosch Exp $
# $FreeBSD: www/en/Makefile,v 1.65 2001/04/25 22:51:43 wosch Exp $
.if exists(Makefile.conf)
.include "Makefile.conf"
.endif
@ -48,6 +48,9 @@ SUBDIR+= conspectus
SUBDIR+= ports
SUBDIR+= doc
.endif
.if defined(BUILD_RELNOTES)
SUBDIR+= relnotes
.endif
# These *must* be listed after the "doc" subdir, as they create symlinks
# in to it.

29
en/relnotes/Makefile Normal file
View file

@ -0,0 +1,29 @@
#
# Web site build hooks for the release notes. Also see the README file.
#
# The variable RELNOTES (I couldn't think of a better name) is a poor
# man's list. Its semantics are very similar to that of MLINKS (see
# bsd.man.mk). The first word is the directory under which that set
# of relnotes should appear on the web site. The second word is the
# path to that relnotes set.
#
# $FreeBSD$
#
RELNOTES= CURRENT ${.CURDIR}/../../../src/release/doc
all install clean obj:
@set ${RELNOTES}; \
while :; do \
case $$# in \
0) break;; \
1) echo "bad \$$RELNOTES value"; false; break;; \
esac; \
webname=$$1; shift; realpath=$$1; shift; \
(unset DESTDIR || true; \
cd $$realpath && ${MAKE} \
FORMATS=html\ html-split \
DOCDIR=${DESTDIR}/data/${.CURDIR:T}/$$webname \
DIRPRFX=${.CURDIR:T}/$$webname/ \
${.TARGET}); \
done;

39
en/relnotes/README Normal file
View file

@ -0,0 +1,39 @@
Web site hooks for the release notes (-*- text -*-).
$FreeBSD$
To enable building the release notes with the web site, edit Makefile
in this directory and set the RELNOTES variable, then set
BUILD_RELNOTES when you build the web site as you would, say,
ENGLISH_ONLY. The RELNOTES variable a list; the first word is the
"name" of these release notes, and the second word is the path to the
root of the release notes set. The semantics are similar to those of
MLINKS in bsd.man.mk. It would be nice if the list ($RELNOTES) could
be set on the command line a la BUILD_RELNOTES instead of having to be
changed in the Makefile, but that would require modifications to
web.site.mk to teach it to propagate the RELNOTES variable when
running make for SUBDIRs.
For example, if you want to build the release notes for -CURRENT and
4-STABLE, and they are checked out in /usr/relnotes/current and
/usr/relnotes/4stable, respectively, you might use the following:
RELNOTES= CURRENT /usr/relnotes/current
RELNOTES+= 4STABLE /usr/relnotes/4stable
Note that you shouldn't simply use 'STABLE' as a name, since there may
be multiple -STABLE branches. Also note that at the time of this
writing, the release notes are still kept as flat files in RELENG_4,
so the above is for demonstration purposes only.
Obviously if you're going to do this, you're going to have to make
sure the release notes are updated along with the rest of the www/ and
doc/ hierarchies.
It would be nice if all the mirrors used the same "names"; freefall
would be the ideal place to set the precedent, but unfortunately it's
not building the release notes yet. If you're a mirror that wants to
set this up, please send e-mail to the freebsd-doc list asking what
you should use, and be prepared to change when freefall catches up.
If you have any questions, please e-mail the freebsd-doc list.