Date: Wed, 14 Mar 2001 21:20:35 +0000 From: Nik Clayton <nik@freebsd.org> To: doc@freebsd.org Subject: http://www.freebsd.org/docs/, /FAQ/, /handbook/, and others Message-ID: <20010314212034.A45244@canyon.nothing-going-on.org>
next in thread | raw e-mail | index | archive | help
--+pHx0qQiF2pBVqBT
Content-Type: multipart/mixed; boundary="IJpNTDwzlM2Ie8A6"
Content-Disposition: inline
--IJpNTDwzlM2Ie8A6
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
In re the discussion that sprang up pro and con the docs/ directory in
the website, and the complaint that we then had multiple copies of
documentation in the installed web tree, and the use of symlinks to
directories, symlinks to files, and redirects in the web server
configuration. . .
=2E . . the attached patch shows how the existing top level FAQ/ and
handbook/ directories in the web site can be resolved. The tutorials/
directory is a little more work but follows the same pattern.
With this we can:
1. Have a single rooted point for the documentation in the web tree,
consistent with the doc/ hierarchy. As things currently stand
that root point is http://www.freebsd.org/docs/ -- that may or may
not be the best place for it.
2. Retain the legacy handbook/ and FAQ/ URLs, without needing to=20
install multiple copies of the documentation in the web tree, and
without needing to resort to Alias or Redirect entries in the=20
webserver config file which (a) require you to run a webserver to
properly test the site, and (b) are typically not maintained by
the website mirrors.
The patch uses symlinks, but since these are links to files (note: *not*
directories, which drew the most ire a few weeks ago) these could easily
be made hardlinks instead.
Comments?
N
--=20
FreeBSD: The Power to Serve http://www.freebsd.org/
FreeBSD Documentation Project http://www.freebsd.org/docproj/
--- 15B8 3FFC DDB4 34B0 AA5F 94B7 93A8 0764 2C37 E375 ---
--IJpNTDwzlM2Ie8A6
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename=diff
Content-Transfer-Encoding: quoted-printable
Index: Makefile
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /home/ncvs/www/en/Makefile,v
retrieving revision 1.61
diff -u -r1.61 Makefile
--- Makefile 2001/02/25 12:00:49 1.61
+++ Makefile 2001/03/14 21:08:13
@@ -32,6 +32,7 @@
SUBDIR=3D security
SUBDIR+=3D commercial
SUBDIR+=3D docproj
+SUBDIR+=3D docs
SUBDIR+=3D news
SUBDIR+=3D alpha
SUBDIR+=3D internal
@@ -48,6 +49,12 @@
SUBDIR+=3D ports
.endif
=20
+# These *must* be listed after the "docs" subdir, as they create symlinks
+# in to it.
+SUBDIR+=3D FAQ=20
+SUBDIR+=3D handbook
+SUBDIR+=3D tutorials
+
# Non-SGML
SUBDIR+=3D gifs
SUBDIR+=3D cgi
@@ -58,16 +65,10 @@
=20
.if !defined(ENGLISH_ONLY) || empty(ENGLISH_ONLY)
.for DIR in ${WEB_LANG}
-SUBDIR+=3D ../${DIR}
+#SUBDIR+=3D ../${DIR}
.endfor
.endif
=20
-.if !defined(WEB_ONLY) || empty(WEB_ONLY)
-# Extern
-SUBDIR+=3D tutorials
-
-DOCSUBDIR=3D FAQ handbook
-.endif
SGMLOPTS+=3D -links -hdr ${.CURDIR}/doc.hdr -ftr ${.CURDIR}/doc.ftr
=20
WEBDIR=3D data
Index: FAQ/Makefile
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /home/ncvs/www/en/FAQ/Makefile,v
retrieving revision 1.4
diff -u -r1.4 Makefile
--- FAQ/Makefile 1999/09/15 20:37:03 1.4
+++ FAQ/Makefile 2001/03/14 21:04:22
@@ -4,8 +4,23 @@
# Build the FreeBSD FAQ *outside* of the www tree, and install it
# in to the right place as necessary.
=20
-all install clean:
- (cd ../../../doc/en_US.ISO_8859-1/books/faq && ${MAKE} 'FORMATS=3Dhtml-sp=
lit html' DESTDIR=3D${DESTDIR}/data/FAQ ${.TARGET})
-.if make(install)
- (cd ${DESTDIR}/data/FAQ; ln -sf index.html FAQ.html)
+.if exists(../Makefile.conf)
+.include "../Makefile.conf"
.endif
+.if exists(../Makefile.inc)
+.include "../Makefile.inc"
+.endif
+
+# At build time, we have to link to the doc/ directory at the same level
+# as the www/ tree.
+all:
+ ln -fs ${.CURDIR}/../../../doc/en_US.ISO_8859-1/books/faq/*.html .
+
+# At install time the www/en/docs/ directory has been populated, so we can
+# link in to there instead.
+install:
+ [ -d ${DOCINSTALLDIR} ] || mkdir ${DOCINSTALLDIR}
+ (cd ${DOCINSTALLDIR} && ln -fs ../docs/en_US.ISO_8859-1/books/faq/*.html =
${DOCINSTALLDIR})
+
+.include "${WEB_PREFIX}/share/mk/web.site.mk"
+
Index: docs/Makefile
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /home/ncvs/www/en/docs/Makefile,v
retrieving revision 1.3
diff -u -r1.3 Makefile
--- docs/Makefile 2001/02/24 18:04:10 1.3
+++ docs/Makefile 2001/03/14 20:47:05
@@ -10,4 +10,4 @@
#
=20
all install clean:
- (cd ../../../doc/en_US.ISO_8859-1 && unset DESTDIR || ${MAKE} FORMATS=3Dh=
tml-split DOCDIR=3D${DESTDIR}/data/docs ${.TARGET})
+ (unset DESTDIR || true; cd ${.CURDIR}/../../../doc/en_US.ISO_8859-1 && ${=
MAKE} FORMATS=3Dhtml-split DOCDIR=3D${DESTDIR}/data/docs ${.TARGET})
Index: handbook/Makefile
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /home/ncvs/www/en/handbook/Makefile,v
retrieving revision 1.5
diff -u -r1.5 Makefile
--- handbook/Makefile 1999/09/15 20:37:10 1.5
+++ handbook/Makefile 2001/03/14 21:04:39
@@ -1,18 +1,24 @@
#
-# $FreeBSD: www/en/handbook/Makefile,v 1.5 1999/09/15 20:37:10 wosch Exp $
+# $FreeBSD: www/en/FAQ/Makefile,v 1.4 1999/09/15 20:37:03 wosch Exp $
#
-# Build the FreeBSD Handbook *outside* of the www tree, and install it
-# in to the right place as necessary.
-#
-# The Handbook is no longer completely self contained in=20
-# doc/en_US.ISO_8859-1/books/handbook, (it requires support files outside =
of=20
-# this directory) and it is much simpler to build it outside the web tree=
=20
-# than it is to make a nest of symlinks to try and build it inside the tre=
e.
-#
-# This assumes that you have the www/ and doc/ trees checked out beside
-# one another -- this was always the case anyway, so there are no extra
-# requirements here.
-#
+
+.if exists(../Makefile.conf)
+.include "../Makefile.conf"
+.endif
+.if exists(../Makefile.inc)
+.include "../Makefile.inc"
+.endif
+
+# At build time, we have to link to the doc/ directory at the same level
+# as the www/ tree.
+all:
+ ln -fs ${.CURDIR}/../../../doc/en_US.ISO_8859-1/books/handbook/*.html .
+
+# At install time the ../docs/ directory has been populated, so we can
+# link in to there instead.
+install:
+ [ -d ${DOCINSTALLDIR} ] || mkdir ${DOCINSTALLDIR}
+ (cd ${DOCINSTALLDIR} && ln -fs ../docs/en_US.ISO_8859-1/books/handbook/*.=
html ${DOCINSTALLDIR})
+
+.include "${WEB_PREFIX}/share/mk/web.site.mk"
=20
-all install clean:
- (cd ../../../doc/en_US.ISO_8859-1/books/handbook && ${MAKE} FORMATS=3Dhtm=
l-split DESTDIR=3D${DESTDIR}/data/handbook ${.TARGET})
--IJpNTDwzlM2Ie8A6--
--+pHx0qQiF2pBVqBT
Content-Type: application/pgp-signature
Content-Disposition: inline
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.4 (FreeBSD)
Comment: For info see http://www.gnupg.org
iEYEARECAAYFAjqv4KEACgkQk6gHZCw343XiqwCaApRyndPHHPd/Z8t7JF7AvVQ3
+yMAnRtAcqdCgYf+oWjInwXyl1HwMWqF
=OCW1
-----END PGP SIGNATURE-----
--+pHx0qQiF2pBVqBT--
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010314212034.A45244>