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

Update the 12.0R release documentation following the recent move

Browse source 
from the base repository with changes provided by hrs@, and further
tweaks from myself.

Of note:
- Consolidate duplicated logic throughout the Makefiles and shared
  logic, and move files to more sane locations where they may be
  shared by other parts of the build tools.
- Update location of several entity files.
- In the top-level Makefile, only include the hardware page if the
  MAN4PAGES knob is set.  This is done to prevent build failures on
  the website until the webupdate script and wrapper are updated,
  which will require some more thought. [1]

This fixes the 'reldoc' target in release/Makefile in head, found
to be broken a few days ago.

[1] Changes from myself.

Patch provided by:	hrs
Sponsored by:	The FreeBSD Foundation
This commit is contained in:
Glen Barber 2017-12-07 19:58:47 +00:00
parent f6be0f5d1b
commit 0aa859afda
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=51264
9 changed files with 48 additions and 154 deletions
en_US.ISO8859-1/htdocs/releases/12.0R
MakefileMakefile.inc
errata
Makefile
hardware
Makefilehardware.xml
readme
Makefile
relnotes
Makefile
share/misc
dev.archlist.txtman2hwnotes.pl

65
en_US.ISO8859-1/htdocs/releases/12.0R/Makefile
View file

@ -19,6 +19,12 @@ DOCS= index.xml \
DATA= docbook.css
SUBDIR= errata readme relnotes
.if defined(MAN4DIR) && !empty(MAN4DIR)
SUBDIR+= hardware
.endif
# PGP-signed checksums
_BIGIRON?= amd64 \
@ -55,63 +61,4 @@ _ARM?= BANANAPI \
. endfor
.endfor
_hardware?= hardware
# The path used on build-web is 'src/share/man/man4'.
.if !defined(MAN4DIR) || empty(MAN4DIR)
. if exists(${DOC_PREFIX}/../src/share/man/man4)
MAN4DIR= ${DOC_PREFIX}/../src/share/man/man4
. elif exists(${DOC_PREFIX}/../share/man/man4)
MAN4DIR= ${DOC_PREFIX}/../share/man/man4
. elif exists(${DOC_PREFIX}/../man/man4)
MAN4DIR= ${DOC_PREFIX}/../man/man4
. elif exists(${DOC_PREFIX}/../man4)
MAN4DIR= ${DOC_PREFIX}/../man4
. else
. warning "MAN4DIR not found. Unable to build hardware.html"
_hardware= # empty
. endif
.endif
D= errata
D+= ${_hardware}
D+= readme
D+= relnotes
MAN4PAGES?= ${MAN4DIR}/*.4 ${MAN4DIR}/man4.*/*.4
ARCHLIST?= ${.CURDIR}/../../share/misc/dev.archlist.txt
CLEANFILES+= dev-auto.ent \
index.html \
schedule.html
MAN2HWNOTES_CMD=${.CURDIR}/../../share/misc/man2hwnotes.pl
.if defined(HWNOTES_MI)
MAN2HWNOTES_FLAGS=
.else
MAN2HWNOTES_FLAGS= -c
.endif
dev-auto.ent:
${PERL} ${MAN2HWNOTES_CMD} ${MAN2HWNOTES_FLAGS} -a ${ARCHLIST} -o ${.TARGET}.tmp ${MAN4PAGES}
${MV} ${.TARGET}.tmp ${.TARGET}
.if make(clean)
beforeclean:
SUBDIR+= ${D}
.include "${DOC_PREFIX}/share/mk/doc.subdir.mk"
.endif
beforeinstall:
.for _SD in ${D}
. if (${_SD:Mhardware} != "")
${MAKE} -B -C ${.CURDIR} dev-auto.ent
. endif
${MAKE} -C ${_SD} DOCINSTALLDIR=${DOCINSTALLDIR} all
.endfor
afterinstall:
.for _SD in ${D}
${MAKE} -C ${_SD} DOCINSTALLDIR=${DOCINSTALLDIR} install
.endfor
.include "${DOC_PREFIX}/share/mk/web.site.mk"

12
en_US.ISO8859-1/htdocs/releases/12.0R/Makefile.inc Normal file
View file

@ -0,0 +1,12 @@
# $FreeBSD$
.if !defined(_HTDOCS_RELEASES_12_0R_INC)
_HTDOCS_RELEASES_12_0R_INC=1
DOC_PREFIX?= ${.CURDIR}/../../../../..
WEBDIR?= /data/releases/12.0R
.if defined(DESTDIR)
DESTDIR:= ${DESTDIR}/${WEBDIR}
.else
DESTDIR= ${HOME}/public_html/${WEBDIR}
.endif
DOCBOOK_DEPS_DISABLE= YES
.endif

24
en_US.ISO8859-1/htdocs/releases/12.0R/errata/Makefile
View file

@ -1,34 +1,12 @@
# $FreeBSD$
.if exists(../Makefile.conf)
.include "../Makefile.conf"
.endif
.if exists(../Makefile.inc)
.include "../Makefile.inc"
.endif
DOC_PREFIX?= ${.CURDIR}/../../../../..
RELN_ROOT?= ${.CURDIR}/..
DOC?= errata
FORMATS?= html
FORMATS?= html txt
INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED=
JADEFLAGS+= -V %generate-article-toc%
SRCS?= errata.xml
DATA+= ${DOC}.html
CLEANFILES+= ${DOC}.html \
${DOC}.txt \
catalog-cwd.xml \
autogen.ent \
${DOC}.parsed.*
install: ${DOC}.html
mkdir -p ${DOCINSTALLDIR}
${INSTALL_DOCS} ${DATA} ${DOCINSTALLDIR}
.include "${DOC_PREFIX}/share/mk/doc.project.mk"

38
en_US.ISO8859-1/htdocs/releases/12.0R/hardware/Makefile
View file

@ -1,34 +1,32 @@
# $FreeBSD$
.if exists(../Makefile.conf)
.include "../Makefile.conf"
.endif
.if exists(../Makefile.inc)
.include "../Makefile.inc"
.endif
DOC_PREFIX?= ${.CURDIR}/../../../../..
RELN_ROOT?= ${.CURDIR}/..
# The path used on build-web is 'src/share/man/man4'.
.if make(all) && (!defined(MAN4DIR) || empty(MAN4DIR) || !exists(${MAN4DIR}))
. warning "MAN4DIR not found. Unable to build hardware.html"
.endif
JADEFLAGS+= -V %generate-article-toc%
MAN4PAGES?= ${MAN4DIR}/*.4 ${MAN4DIR}/man4.*/*.4
ARCHLIST?= ${DOC_PREFIX}/share/misc/dev.archlist.txt
DOC?= hardware
MAN2HWNOTES_CMD=${DOC_PREFIX}/share/misc/man2hwnotes.pl
.if defined(HWNOTES_MI)
MAN2HWNOTES_FLAGS=
.else
MAN2HWNOTES_FLAGS= -c
.endif
DOC= hardware
FORMATS?= html
INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED=
SRCS?= hardware.xml
DATA+= ${DOC}.html
CLEANFILES+= ${DOC}.html \
${DOC}.txt \
catalog-cwd.xml \
autogen.ent \
${DOC}.parsed.*
install: ${DOC}.html
mkdir -p ${DOCINSTALLDIR}
${INSTALL_DOCS} ${DATA} ${DOCINSTALLDIR}
hardware.parsed.xml: dev-auto.ent
dev-auto.ent:
${PERL} ${MAN2HWNOTES_CMD} ${MAN2HWNOTES_FLAGS} -a ${ARCHLIST} -o ${.TARGET} ${MAN4PAGES} || (rm -f ${.TARGET})
CLEANFILES+= dev-auto.ent
.include "${DOC_PREFIX}/share/mk/doc.project.mk"

15
en_US.ISO8859-1/htdocs/releases/12.0R/hardware/hardware.xml
View file

@ -1,16 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook XML V5.0-Based Extension//EN"
"../../../../../share/xml/freebsd50.dtd" [
<!ENTITY % release PUBLIC "-//FreeBSD//ENTITIES Release Specification//EN" "../share/xml/release.ent">
"http://www.FreeBSD.org/XML/share/xml/freebsd50.dtd" [
<!ENTITY % release PUBLIC "-//FreeBSD//ENTITIES Release Specification//EN"
"../share/xml/release.ent">
%release;
<!ENTITY % sponsor PUBLIC "-//FreeBSD//ENTITIES Sponsor Specification//EN" "../share/xml/sponsor.ent">
<!ENTITY % sponsor PUBLIC "-//FreeBSD//ENTITIES Sponsor Specification//EN"
"../share/xml/sponsor.ent">
%sponsor;
<!ENTITY % vendor PUBLIC "-//FreeBSD//ENTITIES Vendor Specification//EN" "../share/xml/vendor.ent">
<!ENTITY % vendor PUBLIC "-//FreeBSD//ENTITIES Vendor Specification//EN"
"../share/xml/vendor.ent">
%vendor;
<!ENTITY security SYSTEM "../share/xml/security.xml">
<!ENTITY errata SYSTEM "../share/xml/errata.xml">
<!-- <!ENTITY % devauto PUBLIC "-//FreeBSD//ENTITIES Auto Generated Device Lists//EN" "../share/xml/dev-auto.ent"> -->
<!ENTITY % devauto PUBLIC "-//FreeBSD//ENTITIES Auto Generated Device Lists//EN" "../dev-auto.ent">
<!ENTITY % devauto PUBLIC "-//FreeBSD//ENTITIES Auto Generated Device Lists//EN"
"http://www.FreeBSD.org/XML/cwd/dev-auto.ent">
%devauto;
]>
<article xmlns="http://docbook.org/ns/docbook"

24
en_US.ISO8859-1/htdocs/releases/12.0R/readme/Makefile
View file

@ -1,34 +1,12 @@
# $FreeBSD$
.if exists(../Makefile.conf)
.include "../Makefile.conf"
.endif
.if exists(../Makefile.inc)
.include "../Makefile.inc"
.endif
DOC_PREFIX?= ${.CURDIR}/../../../../..
RELN_ROOT?= ${.CURDIR}/..
DOC= readme
FORMATS?= html
FORMATS?= html txt
INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED=
JADEFLAGS+= -V %generate-article-toc%
SRCS?= readme.xml
DATA+= ${DOC}.html
CLEANFILES+= ${DOC}.html \
${DOC}.txt \
catalog-cwd.xml \
autogen.ent \
${DOC}.parsed.*
install: ${DOC}.html
mkdir -p ${DOCINSTALLDIR}
${INSTALL_DOCS} ${DATA} ${DOCINSTALLDIR}
.include "${DOC_PREFIX}/share/mk/doc.project.mk"

24
en_US.ISO8859-1/htdocs/releases/12.0R/relnotes/Makefile
View file

@ -1,34 +1,12 @@
# $FreeBSD$
.if exists(../Makefile.conf)
.include "../Makefile.conf"
.endif
.if exists(../Makefile.inc)
.include "../Makefile.inc"
.endif
DOC_PREFIX?= ${.CURDIR}/../../../../..
RELN_ROOT?= ${.CURDIR}/..
DOC= relnotes
FORMATS?= html
FORMATS?= html txt
INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED=
JADEFLAGS+= -V %generate-article-toc%
SRCS?= relnotes.xml
DATA+= ${DOC}.html
CLEANFILES+= ${DOC}.html \
${DOC}.txt \
catalog-cwd.xml \
autogen.ent \
${DOC}.parsed.*
install: ${DOC}.html
mkdir -p ${DOCINSTALLDIR}
${INSTALL_DOCS} ${DATA} ${DOCINSTALLDIR}
.include "${DOC_PREFIX}/share/mk/doc.project.mk"

0
en_US.ISO8859-1/htdocs/share/misc/dev.archlist.txt → share/misc/dev.archlist.txt
View file

0
en_US.ISO8859-1/htdocs/share/misc/man2hwnotes.pl → share/misc/man2hwnotes.pl
View file