Re: blatantly a bug in the documentation

From: "Merlin Moncure" <mmoncure(at)gmail(dot)com>
To: "Tom Lane" <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: "Dave Page" <dpage(at)pgadmin(dot)org>, "Robert Treat" <xzilla(at)users(dot)sourceforge(dot)net>, pgsql-hackers(at)postgresql(dot)org, "Magnus Hagander" <magnus(at)hagander(dot)net>, "Andrew Dunstan" <andrew(at)dunslane(dot)net>, "Alvaro Herrera" <alvherre(at)commandprompt(dot)com>, "A(dot) Kretschmer" <andreas(dot)kretschmer(at)schollglas(dot)com>
Subject: Re: blatantly a bug in the documentation
Date: 2008-11-25 14:16:19
Message-ID: b42b73150811250616x45fa2076yfbd1026dcd9ee9c7@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Tue, Nov 25, 2008 at 8:23 AM, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:
> "Dave Page" <dpage(at)pgadmin(dot)org> writes:
>> I'm in favour of including it by default (at initdb), so it's there
>> for new users to play with on any fresh install - however, there is
>> only a point to that if all the documentation examples are based on
>> that database to allow copy-paste-play.
>
> You would also have to assume that all the examples are non-destructive,
> and that no one ever extends an example in a destructive way. This
> seems like a non-starter. Better to provide the sample database in a
> form in which it can be easily dropped/reloaded. I'm envisioning that
> there's a source file in $sharedir and we tell people
>
> createdb example
> psql -f $sharedir/example.sql example

There's good precedent for that...SQL Server for example does something similar:
http://msdn.microsoft.com/en-us/library/aa276825(SQL.80).aspx

It's a good learning tool and would really raise the value of the documentation.

merlin

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Andrew Dunstan 2008-11-25 14:17:42 Re: blatantly a bug in the documentation
Previous Message Tom Lane 2008-11-25 14:03:52 Re: Brittleness in regression test setup