From owner-cvs-all Mon Apr 2 22:11:29 2001 Delivered-To: cvs-all@freebsd.org Received: from snarf.osdn.com (snarf.osdn.com [209.192.217.153]) by hub.freebsd.org (Postfix) with ESMTP id 84EAE37B719; Mon, 2 Apr 2001 22:11:21 -0700 (PDT) (envelope-from jim@FreeBSD.org) Received: from guinness.osdn.com (root@localhost [127.0.0.1]) by snarf.osdn.com (8.11.3/8.11.3) with ESMTP id f335BKt53521; Tue, 3 Apr 2001 01:11:20 -0400 (EDT) (envelope-from jim@FreeBSD.org) Received: by guinness.osdn.com (Postfix, from userid 1000) id 42490100; Tue, 3 Apr 2001 01:11:18 -0400 (EDT) Date: Tue, 3 Apr 2001 01:11:17 -0400 From: Jim Mock To: Dima Dorfman 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 Message-ID: <20010403011117.A2616@guinness.osdn.com> Reply-To: jim@FreeBSD.org References: <20010402211043.A84692@dragon.nuxi.com> <20010403045455.0A3A93E09@bazooka.unixfreak.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.3.17i In-Reply-To: <20010403045455.0A3A93E09@bazooka.unixfreak.org>; from dima@unixfreak.org on Mon, Apr 02, 2001 at 09:54:54PM -0700 Sender: owner-cvs-all@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.ORG On Mon, 02 Apr 2001 at 21:54:54 -0700, Dima Dorfman wrote: > "David O'Brien" writes: > > On Mon, Apr 02, 2001 at 11:25:13PM -0400, Jim Mock wrote: > > > > Log: DocBook police: replace tabs with spaces in the spirit of > > > > rev. 1.150. > > > > > > Erm, maybe I missed something, but since when do we use spaces for > > > 8 spaces instead of a tab? > > > > Agreed. Would someone please pick and convention and publish it?? > > I never know what to do when I add to our docs. > > 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). 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). 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. - jim -- - jim mock - O|S|D|N - open source development network - - http://www.freebsdzine.org/ - jim@freebsdzine.org - jim@FreeBSD.org - To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe cvs-all" in the body of the message