From owner-freebsd-doc@FreeBSD.ORG Tue Nov 21 17:44:40 2006 Return-Path: X-Original-To: freebsd-doc@freebsd.org Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 8A8CA16A767; Tue, 21 Nov 2006 17:44:40 +0000 (UTC) (envelope-from chris@hitnet.RWTH-Aachen.DE) Received: from mta-2.ms.rz.rwth-aachen.de (mta-2.ms.rz.RWTH-Aachen.DE [134.130.7.73]) by mx1.FreeBSD.org (Postfix) with ESMTP id 6C76A43D6E; Tue, 21 Nov 2006 17:43:56 +0000 (GMT) (envelope-from chris@hitnet.RWTH-Aachen.DE) Received: from circe ([134.130.3.36]) by mta-2.ms.rz.RWTH-Aachen.de (Sun Java System Messaging Server 6.2-7.05 (built Sep 5 2006)) with ESMTP id <0J9300L7CD9UK780@mta-2.ms.rz.RWTH-Aachen.de>; Tue, 21 Nov 2006 18:44:18 +0100 (CET) Received: from talos.rz.RWTH-Aachen.DE ([134.130.3.22]) by circe (MailMonitor for SMTP v1.2.2 ) ; Tue, 21 Nov 2006 18:44:17 +0100 (MET) Received: from bigboss.hitnet.rwth-aachen.de (bigspace.hitnet.RWTH-Aachen.DE [137.226.181.2]) by smarthost.rwth-aachen.de (8.13.8/8.13.1/1) with ESMTP id kALHiH4M005206; Tue, 21 Nov 2006 18:44:17 +0100 Received: from haakonia.hitnet.rwth-aachen.de ([137.226.181.92]) by bigboss.hitnet.rwth-aachen.de with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA:32) (Exim 4.50) id 1GmZfN-00078h-PN; Tue, 21 Nov 2006 18:44:17 +0100 Received: by haakonia.hitnet.rwth-aachen.de (Postfix, from userid 1001) id 4084D3F41B; Tue, 21 Nov 2006 18:44:17 +0100 (CET) Date: Tue, 21 Nov 2006 18:44:17 +0100 From: Christian Brueffer In-reply-to: <20061121040153.GA17933@tomcat.kitchenlab.org> To: "Bruce A. Mah" Message-id: <20061121174416.GB4192@haakonia.hitnet.RWTH-Aachen.DE> MIME-version: 1.0 Content-type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary=EuxKj2iCbKjpUGkD Content-disposition: inline X-Operating-System: FreeBSD 6.2-PRERELEASE X-PGP-Key: http://people.FreeBSD.org/~brueffer/brueffer.key.asc X-PGP-Fingerprint: A5C8 2099 19FF AACA F41B B29B 6C76 178C A0ED 982D References: <20061121040153.GA17933@tomcat.kitchenlab.org> User-Agent: Mutt/1.5.11 Cc: freebsd-doc@freebsd.org Subject: Re: RFC: Release notes rearrangement X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 21 Nov 2006 17:44:40 -0000 --EuxKj2iCbKjpUGkD Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Mon, Nov 20, 2006 at 08:01:53PM -0800, Bruce A. Mah wrote: [...] >=20 > To address these problems I'd like to collapse all of the MD documents > into a single set of MI documents. For paragraphs (sections, > whatever) that only apply to given architectures, we'd simply add > in-line text indicating this, something like: >=20 > [i386] Some sentence applying only to i386. >=20 Hmm, what I like about the current notes is that if I'm only interested in on arch, I just get the stuff that concerns this specific arch. From what you describe here it sounds like this: [i386] Some sentence applying only to i386. [amd64] Some sentence applying only to amd64. [arm] Some sentence applying only to arm. [sparc64] Some sentence applying only to sparc64. [i386] Some sentence applying only to i386. Of course many items are general, but I think we want to avoid clutter like this. Do you have something in mind for this? Maybe put all the arch specific stuff in special arch sections below all the generic stuff? OTOH, maybe I've just completely misunderstood you :-) > (As a point of reference, the main part of the release notes on HEAD, > new.sgml, contains 353 elements, of which 27 have MD "arch=3D" > properties So more than 90% of the paragraphs in the release notes > are common to all architectures anyway.) >=20 > I want to start first with the release notes because this change would > be the most straight-forward for that document. The hardware list is > similar, although it has MD sections of text that would need to be > organized into some reasonable document structure. I think that the > install guide really needs to be rewritten; I actually have some work > from a few years ago in this direction that gave me the idea for MI > release documentation in the first place. >=20 > Comments? >=20 Apart from the comment above, this sounds like a good idea. - Christian --=20 Christian Brueffer chris@unixpages.org brueffer@FreeBSD.org GPG Key: http://people.freebsd.org/~brueffer/brueffer.key.asc GPG Fingerprint: A5C8 2099 19FF AACA F41B B29B 6C76 178C A0ED 982D --EuxKj2iCbKjpUGkD Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.5 (FreeBSD) iD8DBQFFYzrwbHYXjKDtmC0RAhDhAJ97Xdl14g8Q7QtfVrr0TXUTo8BJ/wCgvrdS MsV9bKST5G2w78H2Ps/CgjE= =jpMV -----END PGP SIGNATURE----- --EuxKj2iCbKjpUGkD--