Re: Added documentation about caching, reliability

From: Bruce Momjian <pgman(at)candle(dot)pha(dot)pa(dot)us>
To: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>
Cc: PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>, PostgreSQL-documentation <pgsql-docs(at)postgresql(dot)org>
Subject: Re: Added documentation about caching, reliability
Date: 2005-09-29 02:30:40
Message-ID: 200509290230.j8T2Ue812994@candle.pha.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

Alvaro Herrera wrote:
> On Wed, Sep 28, 2005 at 10:08:02PM -0400, Bruce Momjian wrote:
>
> > The chapter sections are:
> >
> > Table of Contents
> > 26.1. Write-Ahead Logging (WAL)
> > 26.2. Benefits of WAL
> > 26.3. WAL Configuration
> > 26.4. WAL Internals
> >
> > Are you suggesting we spell out Write-Ahead Logging for all section
> > titles?
>
> Is it considered good style to use acronyms in titles? I wouldn't do it.
>
> Maybe it could be left as
>
> 26.1. Write-Ahead Logging
> 26.2. Benefits of Write-Ahead Logging

I modified 26.2 as you suggested.

> 26.3. WAL Configuration
> 26.4. WAL Internals
>
> because the former two talk about WAL in a general manner, while the
> latter two are about our implementation. I also wouldn't expand the
> acronym in a title.

I think we do need to show the acronym in the title if use that acronym
in later titles.

--
Bruce Momjian | http://candle.pha.pa.us
pgman(at)candle(dot)pha(dot)pa(dot)us | (610) 359-1001
+ If your life is a hard drive, | 13 Roberts Road
+ Christ can be your backup. | Newtown Square, Pennsylvania 19073

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Peter Eisentraut 2005-09-29 06:38:47 Re: Added documentation about caching, reliability
Previous Message Alvaro Herrera 2005-09-29 02:23:49 Re: Added documentation about caching, reliability

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 2005-09-29 02:33:41 Re: [PATCHES] Proposed patch for sequence-renaming problems
Previous Message Alvaro Herrera 2005-09-29 02:23:49 Re: Added documentation about caching, reliability