diff options
author | bmah <bmah@FreeBSD.org> | 2002-06-20 21:19:49 +0000 |
---|---|---|
committer | bmah <bmah@FreeBSD.org> | 2002-06-20 21:19:49 +0000 |
commit | d0fe7ef0c80799f14a11f30e2a23335c2c83bfa2 (patch) | |
tree | e9b57d9b1c7a60bb2e7c1e6382106995f9ad1a26 /release/doc/share | |
parent | 3c1b590b1703814b73c679c7f60d34e347d29da9 (diff) | |
download | FreeBSD-src-d0fe7ef0c80799f14a11f30e2a23335c2c83bfa2.zip FreeBSD-src-d0fe7ef0c80799f14a11f30e2a23335c2c83bfa2.tar.gz |
Provide a way to keep out old ("historic") release notes from bloating
the size of the rendered release notes. By default, any element with
a role="historic" attribute won't get rendered in the output unless
the INCLUDE_HISTORIC Makefile variable is defined.
Diffstat (limited to 'release/doc/share')
-rw-r--r-- | release/doc/share/mk/doc.relnotes.mk | 17 | ||||
-rw-r--r-- | release/doc/share/sgml/release.dsl | 18 | ||||
-rw-r--r-- | release/doc/share/sgml/release.ent | 4 |
3 files changed, 39 insertions, 0 deletions
diff --git a/release/doc/share/mk/doc.relnotes.mk b/release/doc/share/mk/doc.relnotes.mk index 546ad9f..0335640 100644 --- a/release/doc/share/mk/doc.relnotes.mk +++ b/release/doc/share/mk/doc.relnotes.mk @@ -9,3 +9,20 @@ EXTRA_CATALOGS+= ${RELN_ROOT}/share/sgml/catalog # Use the appropriate architecture-dependent RELNOTESng stylesheet DSLHTML?= ${RELN_ROOT}/share/sgml/default.dsl DSLPRINT?= ${RELN_ROOT}/share/sgml/default.dsl + +# +# Tweakable Makefile variables +# +# INCLUDE_HISTORIC Used by relnotes document only. When set, +# causes all release notes entries to be printed, +# even those marked as "historic". If not set +# (the default), only print "non-historic" +# release note entries. To designate a release +# note entry as "historic", add a role="historic" +# attribute to the applicable element(s). +# +.if defined(INCLUDE_HISTORIC) +JADEFLAGS+= -iinclude.historic +.else +JADEFLAGS+= -ino.include.historic +.endif diff --git a/release/doc/share/sgml/release.dsl b/release/doc/share/sgml/release.dsl index ee37005..6bb5026 100644 --- a/release/doc/share/sgml/release.dsl +++ b/release/doc/share/sgml/release.dsl @@ -3,6 +3,8 @@ <!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [ <!ENTITY % output.html "IGNORE"> <!ENTITY % output.print "IGNORE"> +<!ENTITY % include.historic "IGNORE"> +<!ENTITY % no.include.historic "IGNORE"> <!ENTITY freebsd.dsl PUBLIC "-//FreeBSD//DOCUMENT DocBook Stylesheet//EN" CDATA DSSSL> ]> @@ -10,6 +12,14 @@ <style-specification use="docbook"> <style-specification-body> +; Configure behavior of this stylesheet +<![ %include.historic; [ + (define %include-historic% #t) +]]> +<![ %no.include.historic; [ + (define %include-historic% #f) +]]> + ; String manipulation functions (define (split-string-to-list STR) ;; return list of STR separated with char #\ or #\, @@ -45,9 +55,17 @@ ; Deal with conditional inclusion of text via entities. (default (let* ((arch (attribute-string (normalize "arch"))) + (role (attribute-string (normalize "role"))) (for-arch (entity-text "arch"))) (cond + ; If role=historic, and we're not printing historic things, then + ; don't output this element. + ((and (equal? role "historic") + (not %include-historic%)) + (empty-sosofo)) + + ; If arch= not specified, then print unconditionally. This clause ; handles the majority of cases. ((or (equal? arch #f) (equal? arch "")) diff --git a/release/doc/share/sgml/release.ent b/release/doc/share/sgml/release.ent index ca39172..055643e 100644 --- a/release/doc/share/sgml/release.ent +++ b/release/doc/share/sgml/release.ent @@ -18,6 +18,10 @@ edge. --> <!ENTITY release.prev.stable "4.5-RELEASE"> +<!-- The previous historical release. Used only to tell what was + the cutoff point for "historic" release notes. --> +<!ENTITY release.prev.historic "4.6-RELEASE"> + <!-- The next version to be released, usually used for snapshots. --> <!ENTITY release.next "5.0-RELEASE"> |