From: | Oliver Jowett <oliver(at)opencloud(dot)com> |
---|---|
To: | Kris Jurka <books(at)ejurka(dot)com> |
Cc: | Peter Eisentraut <peter_e(at)gmx(dot)net>, pgsql-jdbc(at)postgresql(dot)org |
Subject: | Re: Patch to readd documentation |
Date: | 2004-01-26 01:17:42 |
Message-ID: | 40146AB6.2070701@opencloud.com |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | pgsql-jdbc |
Kris Jurka wrote:
>
> On Sat, 24 Jan 2004, Peter Eisentraut wrote:
>
>
>>Btw., creating a separate distribution for documentation is just a
>>perfect way to make sure the documentation never gets read or
>>maintained. If that is your plan then you might as well remove it.
>
>
> The way to make sure the documentation is read is to put it on a website,
> not have an xml document in subdirectory of the main package. The way to
> make sure the documentation is maintained is to make the build process as
> easy as possible.
Can we do a build target that just validates the doc source and doesn't
actually generate documentation from it? If I understand things
correctly, that'd make quick documentation changes easier in that you
don't need additional tools installed, but you can still check you
didn't irretrievably break things before checking in..
I find that most of the doc changes I make elsewhere are updates to
existing text to reflect code changes, rather than large rewrites .. so
actually generating and viewing the final documentation isn't so important.
-O
From | Date | Subject | |
---|---|---|---|
Next Message | Fischer Krisztián | 2004-01-26 11:47:20 | OutOfMemoryError - bug or human error? |
Previous Message | Peter Eisentraut | 2004-01-25 17:28:49 | Re: Patch to readd documentation |