INSTALL file (was Re: [HACKERS] Re: HISTORY for 6.5.2) - Mailing list pgsql-docs

From Peter Eisentraut
Subject INSTALL file (was Re: [HACKERS] Re: HISTORY for 6.5.2)
Date
Msg-id Pine.LNX.4.10.9909212031480.1899-200000@peter-e.yi.org
Whole thread Raw
Responses RE: INSTALL file (was Re: [HACKERS] Re: HISTORY for 6.5.2)  (Vince Vielhaber <vev@michvhf.com>)
Re: INSTALL file (was Re: [HACKERS] Re: HISTORY for 6.5.2)  (Bruce Momjian <maillist@candle.pha.pa.us>)
Re: INSTALL file (was Re: [HACKERS] Re: HISTORY for 6.5.2)  (Bruce Momjian <pgman@candle.pha.pa.us>)
List pgsql-docs
On Sep 20, Bruce Momjian mentioned:

> I agree our INSTALL is very large.  Is there some way we can simplify
> the install process?

On the one hand a database server is probably not your everyday
./configure && make && make install program you get from freshmeat and you
do want to put some time into a proper installation. On the other hand the
INSTALL file is really way too long and makes for unpleasant reading.

Here are a couple of ideas.

* Chapter 2 "Ports" should be moved to the README file (has nothing to do
with the actual installation).

* Move the gory details of item 5 (flex) to a separate file (README.flex).

* Move the locale stuff into a separate file.

* Same with Kerberos

* Move the release notes at the end to CHANGELOG.

That should make the file somewhat smaller, then also it is really to
verbose at times and is formatted really oddly, at least on my system.

Okay, now I really went out of my way and redid the whole thing. You'll
find the result attached. This is merely an idea of what I would consider
simpler. I removed some inconsistencies, things that were unnecessary, too
complicated, etc. Okay, I removed a lot of stuff, but most of the stuff
people can really figure out themselves if they need them in the first
place. And I shrunk the thing to 25%.

Perhaps there should be a separate Install FAQ of the sort "My shell said
'export: Command not found.'" or "What's a shared library?" to move the
really annoying stuff out of people's ways.

Comments?

-- 
Peter Eisentraut - peter_e@gmx.net
http://yi.org/peter-e

pgsql-docs by date:

Previous
From: root
Date:
Subject: mathematical symbols
Next
From: Vince Vielhaber
Date:
Subject: RE: INSTALL file (was Re: [HACKERS] Re: HISTORY for 6.5.2)