From owner-freebsd-doc@FreeBSD.ORG Wed Sep 17 15:09:29 2003 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id AACB016A4C1; Wed, 17 Sep 2003 15:09:29 -0700 (PDT) Received: from shaft.techsupport.co.uk (shaft.techsupport.co.uk [212.250.77.214]) by mx1.FreeBSD.org (Postfix) with ESMTP id 14CD743F3F; Wed, 17 Sep 2003 15:09:28 -0700 (PDT) (envelope-from setantae@submonkey.net) Received: from pc3-cdif2-5-cust222.cdif.cable.ntl.com ([81.101.152.222] helo=shrike.submonkey.net ident=mailnull) by shaft.techsupport.co.uk with esmtp (TLSv1:DHE-RSA-AES256-SHA:256) (Exim 4.22) id 19zkUI-000Ery-9E; Wed, 17 Sep 2003 23:09:26 +0100 Received: from setantae by shrike.submonkey.net with local (Exim 4.22) id 19zkUG-00021c-3P; Wed, 17 Sep 2003 23:09:24 +0100 Date: Wed, 17 Sep 2003 23:09:24 +0100 From: Ceri Davies To: doc@FreeBSD.org Message-ID: <20030917220923.GA7765@submonkey.net> Mail-Followup-To: Ceri Davies , doc@FreeBSD.org References: <200309120920.h8C9KGZ8091585@freefall.freebsd.org> <20030912093107.GH635@unixpages.org> <20030912093846.GK76802@submonkey.net> <20030912103331.GA388@FreeBSD.org> <20030912111813.GA75659@submonkey.net> <20030912141126.GC1068@daemon.li> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="PmA2V3Z32TCmWXqI" Content-Disposition: inline In-Reply-To: <20030912141126.GC1068@daemon.li> X-PGP: finger ceri@FreeBSD.org User-Agent: Mutt/1.5.4i Sender: Ceri Davies cc: Ceri Davies Subject: Re: docs/56729: [patch] artciles/pr-guidelines: explain meaning of MFC X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 17 Sep 2003 22:09:29 -0000 --PmA2V3Z32TCmWXqI Content-Type: multipart/mixed; boundary="ZGiS0Q5IWpPtfppv" Content-Disposition: inline --ZGiS0Q5IWpPtfppv Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Fri, Sep 12, 2003 at 04:11:26PM +0200, Josef El-Rayes wrote: > Ceri Davies wrote: > > Yeah, those are the lines I was thinking along. > > My reference to "relevant elements" was that there are very likely > > elements or similar already, which we can make use of. >=20 > i wanted to start collecting some terms for glossary as some questions > arose: >=20 > i am wondering on how to realize this. should it be more of an index, > with a crosslink to the place where it gets explained or like this: >=20 > MFC: ...merge from current, action... read handbook.. >=20 > with a short explanation and a link when there is a place where it gets > explainend more detailed. >=20 > should there be a certain "treshhold" like, only use freebsd specific > terms or not trivial terms or should we include every term like "unix, > ports, packages..."? See the attached patch. I have started out with only including FreeBSD specific terms in the freebsd-glossary.sgml. There's no reason why we couldn't then have another file containing generic computing terms (but personally, I'm not sure that is necessary), although the build would need to be tweaked a bit. I've also included a change to the handbook build that will allow you to build in the glossary by running "make GLOSSARY=3Dyes", but which is off by default. Note that there are not many entries at the moment; once this is committed then people can feel free to add stuff to it - I've chosen the current entr= ies to illustrate the docbook way of GlossSeeAlso, GlossSee, etc, elements. Any thoughts? Ceri PS. I can see a problem already with the link to the FAQ not working when built with an article, but I'm not sure of the best way to fix it. --=20 User: DO YOU ACCEPT JESUS CHRIST AS YOUR PERSONAL LORD AND SAVIOR? Iniaes: Sure, I can accept all forms of payment. -- www.chatterboxchallenge.com --ZGiS0Q5IWpPtfppv Content-Type: text/plain; charset=us-ascii Content-Disposition: attachment; filename="glossary.diff" Content-Transfer-Encoding: quoted-printable Index: doc/en_US.ISO8859-1/books/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/dcvs/doc/en_US.ISO8859-1/books/handbook/Makefile,v retrieving revision 1.66 diff -u -r1.66 Makefile --- doc/en_US.ISO8859-1/books/handbook/Makefile 15 Aug 2003 12:28:17 -0000 = 1.66 +++ doc/en_US.ISO8859-1/books/handbook/Makefile 17 Sep 2003 21:28:01 -0000 @@ -31,6 +31,7 @@ FORMATS?=3D html-split =20 HAS_INDEX=3D true +GLOSSARY?=3D =20 INSTALL_COMPRESSED?=3D gz INSTALL_ONLY_COMPRESSED?=3D @@ -172,6 +173,9 @@ CHAPTERS?=3D ${SRCS:M*chapter.sgml} =20 SGMLFLAGS+=3D ${CHAPTERS:S/\/chapter.sgml//:S/^/-i chap./} +.if defined(GLOSSARY) && !empty(GLOSSARY) +SGMLFLAGS+=3D -i chap.freebsd-glossary +.endif =20 # XXX The Handbook build currently overflows some internal, hardcoded=20 # limits in pdftex. Until we split the Handbook up, build the PDF=20 Index: doc/en_US.ISO8859-1/books/handbook/book.sgml =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/dcvs/doc/en_US.ISO8859-1/books/handbook/book.sgml,v retrieving revision 1.141 diff -u -r1.141 book.sgml --- doc/en_US.ISO8859-1/books/handbook/book.sgml 5 Sep 2003 21:30:20 -0000 = 1.141 +++ doc/en_US.ISO8859-1/books/handbook/book.sgml 17 Sep 2003 21:28:01 -0000 @@ -54,6 +54,7 @@ + =20 %pgpkeys; ]> @@ -236,6 +237,7 @@ + &chap.colophon; =20 Index: doc/en_US.ISO8859-1/share/sgml/bookinfo.ent =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/dcvs/doc/en_US.ISO8859-1/share/sgml/bookinfo.ent,v retrieving revision 1.3 diff -u -r1.3 bookinfo.ent --- doc/en_US.ISO8859-1/share/sgml/bookinfo.ent 17 Jun 2003 19:32:40 -0000 = 1.3 +++ doc/en_US.ISO8859-1/share/sgml/bookinfo.ent 17 Sep 2003 21:28:01 -0000 @@ -12,3 +12,5 @@ =20 + + Index: doc/en_US.ISO8859-1/share/sgml/glossary/freebsd-glossary.sgml =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: doc/en_US.ISO8859-1/share/sgml/glossary/freebsd-glossary.sgml diff -N doc/en_US.ISO8859-1/share/sgml/glossary/freebsd-glossary.sgml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ doc/en_US.ISO8859-1/share/sgml/glossary/freebsd-glossary.sgml 17 Sep 20= 03 21:28:01 -0000 @@ -0,0 +1,64 @@ + + + + &os; Glossary + This glossary contains terms and acronyms specific to &os;. + + + B + + + Bikeshed Building + + A phenomenon whereby many people will give an opinion on + an uncomplicated topic, whilst a complex topic receives little + or no discussion. See the + FAQ for + the origin of the term. + + + + + + M + + + Merge From Current + MFC + + To merge functionality or a patch from the -CURRENT + branch to another, most often -STABLE. + + + + + Merge From Stable + MFS + + In the normal course of FreeBSD development, a change will + be committed to the -CURRENT branch for testing before being + merged to -STABLE. On rare occassions, a change will go into + -STABLE first and then be merged to -CURRENT. + + + + + + MFC + + + + + MFS + + + + + + + --ZGiS0Q5IWpPtfppv-- --PmA2V3Z32TCmWXqI Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.3 (FreeBSD) iD8DBQE/aNuTocfcwTS3JF8RAmsNAJ9usjbqNjQsf0wBAzD19yiwh7kb+wCfX3d8 UIw5vgze9pc8ZhIh+BBmDiE= =01jI -----END PGP SIGNATURE----- --PmA2V3Z32TCmWXqI--