From owner-p4-projects Wed Sep 18 20:28:38 2002 Delivered-To: p4-projects@freebsd.org Received: by hub.freebsd.org (Postfix, from userid 32767) id C74C237B404; Wed, 18 Sep 2002 20:28:36 -0700 (PDT) Delivered-To: perforce@freebsd.org Received: from mx1.FreeBSD.org (mx1.FreeBSD.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 79B9337B401 for ; Wed, 18 Sep 2002 20:28:36 -0700 (PDT) Received: from holly.calldei.com (adsl-208-191-149-232.dsl.hstntx.swbell.net [208.191.149.232]) by mx1.FreeBSD.org (Postfix) with ESMTP id E1AB143E65 for ; Wed, 18 Sep 2002 20:28:35 -0700 (PDT) (envelope-from chris@holly.dyndns.org) Received: by holly.calldei.com (Postfix, from userid 1001) id AC33AC35; Wed, 18 Sep 2002 22:27:03 -0500 (CDT) Date: Wed, 18 Sep 2002 22:27:03 -0500 From: Chris Costello To: Perforce Change Reviews Subject: Re: PERFORCE change 17681 for review Message-ID: <20020919032702.GA27220@holly.calldei.com> Reply-To: chris@FreeBSD.org References: <200209182353.g8INrCwv014736@freefall.freebsd.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <200209182353.g8INrCwv014736@freefall.freebsd.org> User-Agent: Mutt/1.4i Sender: owner-p4-projects@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.ORG On Wednesday, September 18, 2002, Chris Costello wrote: > Here are a few points that should be made about this document: > o all relabel entry points are scattered, not under the right heading > o there were a few other grammar errors that have yet to be corrected > o every single entry point requires at least 26 lines of metadata > o Data is formatted in a suboptimal layout due to DocBook limitations > o on the current version, we're looking at hastily-written summaries > o catching-up needs to be done; this document is out of date > o Best thing to do after that is to mostly re-write each description > o over the next few weeks, I'll be carrying out those changes > o over the next few months, I'll decide whether or not I would like to > keep this document in the DocBook format, or possibly move it out As an alternative, I'm thinking about using the traditional ms(7) doc. format and sticking it in /usr/share/doc/papers, or possibly waiting for the DocBook XML bits to get adapted and create a custom stylesheet (.mac -> .docbook) to help clean up the markup, which is really quite messy IMHO. -- Chris Costello FreeBSD Project http://www.FreeBSD.org/ TrustedBSD Project http://www.TrustedBSD.org/ To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe p4-projects" in the body of the message