From owner-cvs-all Mon Apr 2 22:35:41 2001 Delivered-To: cvs-all@freebsd.org Received: from bazooka.unixfreak.org (bazooka.unixfreak.org [63.198.170.138]) by hub.freebsd.org (Postfix) with ESMTP id A079837B71D; Mon, 2 Apr 2001 22:35:35 -0700 (PDT) (envelope-from dima@unixfreak.org) Received: from spike.unixfreak.org (spike [63.198.170.139]) by bazooka.unixfreak.org (Postfix) with ESMTP id 3F0003E09; Mon, 2 Apr 2001 22:35:35 -0700 (PDT) To: jim@FreeBSD.org Cc: obrien@FreeBSD.org, cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org Subject: Re: cvs commit: doc/en_US.ISO_8859-1/books/faq book.sgml In-Reply-To: <20010403011117.A2616@guinness.osdn.com>; from jim@FreeBSD.org on "Tue, 3 Apr 2001 01:11:17 -0400" Date: Mon, 02 Apr 2001 22:35:35 -0700 From: Dima Dorfman Message-Id: <20010403053535.3F0003E09@bazooka.unixfreak.org> Sender: owner-cvs-all@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.ORG Jim Mock writes: > On Mon, 02 Apr 2001 at 21:54:54 -0700, Dima Dorfman wrote: > > AFAIK, the convention is that you use what the rest (or majority) of > > the file you're editing uses. This is the policy I've seen advocated > > for src/, and it seems to make sense for doc/, too. At the moment, I > > don't think there's anything to document; different documents use > > different conventions. E.g., the Handbook is tab-indented, but the > > FAQ is space-indented. I don't know which one's ``right'' and which > > one's ``wrong''. > > Ok, I've always used tabs (even in the FAQ), and the handbook, as you > pointed out, reflects this. I started to clean up the FAQ probably > about a year ago, but didn't get much further than the preface before I > got distracted by something else (the markup in the FAQ was pretty > mangled back then -- I haven't looked at it enough lately to comment on > it's current state). Mark Ovens did some cleanup a little while ago. I haven't looked at the diffs, but as far as I can tell it isn't terribly ugly right now (although I'll admit to not knowing what constitutes ``ugly'' by SGML standards). Personally, I'd rather have consistency than beauty, since the latter is just personal preference; that's the theory behind this commit. > Personally, I prefer tabs because vim converts the 8 spaces to a tab > for me and it's much easier to not have to go back and change them to > spaces, but that's another matter entirely (I really don't want to get > into an editor battle here). FWIW, I don't care. Emacs adapts nicely to either one (no editor battles for me, either, please :-). > Either way, we should definitely put something in the Doc Project primer > about this. I could've swore there was a style section there already, > but briefly looking now I don't see one. There's a style section in the FDP primer: 10. Writing style 10.1. Style guide 10.1.1. Letter case 10.1.2. Indentation 10.1.3. Tag style 10.1.4. White space changes However, it doesn't talk about whether 8-space indents should get converted to tabs. Nik? Comments? Dima Dorfman dima@unixfreak.org To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe cvs-all" in the body of the message