Date: Tue, 03 Apr 2001 09:22:30 -0700 (PDT) From: John Baldwin <jhb@FreeBSD.org> To: Dima Dorfman <dima@unixfreak.org> Cc: cvs-all@FreeBSD.org, cvs-committers@FreeBSD.org, Jim Mock <jim@FreeBSD.org>, obrien@FreeBSD.org Subject: Re: cvs commit: doc/en_US.ISO_8859-1/books/faq book.sgml Message-ID: <XFMail.010403092230.jhb@FreeBSD.org> In-Reply-To: <20010403045455.0A3A93E09@bazooka.unixfreak.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On 03-Apr-01 Dima Dorfman wrote:
> "David O'Brien" <obrien@FreeBSD.org> 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''.
man 9 style.
For code we use this style, and I think it should apply to docs as well.
It is consistent after all:
Do not add whitespace at the end of a line, and only use tabs followed by
spaces to form the indentation. Do not use more spaces than a tab will
produce and do not use spaces in front of tabs.
--
John Baldwin <jhb@FreeBSD.org> -- http://www.FreeBSD.org/~jhb/
PGP Key: http://www.Baldwin.cx/~john/pgpkey.asc
"Power Users Use the Power to Serve!" - http://www.FreeBSD.org/
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?XFMail.010403092230.jhb>