Re: pg_dump docs

Started by Thomas Lockhartabout 25 years ago12 messages
#1Thomas Lockhart
lockhart@alumni.caltech.edu

Done. Do you know often the web-based version of the documentation get
updated?

Should be twice a day. afaik you can go to hub.org:~thomas/CURRENT and
run ./docbuild. Make sure your umask is set to 2 (so I can update files
after that) and you may want to detach the command and log it to a file
since it will take 5-10min to run.

- Thomas

#2Tom Lane
tgl@sss.pgh.pa.us
In reply to: Thomas Lockhart (#1)
Re: Re: pg_dump docs

Thomas Lockhart <lockhart@alumni.caltech.edu> writes:

Done. Do you know often the web-based version of the documentation get
updated?

Should be twice a day.

Where is this auto-updated copy hiding? The bookmark I have,
http://www.postgresql.org/docs/postgres/index.html
is pointing at files that haven't updated for months...

regards, tom lane

#3Thomas Lockhart
lockhart@alumni.caltech.edu
In reply to: Tom Lane (#2)
Re: Re: pg_dump docs

Should be twice a day.

Where is this auto-updated copy hiding? The bookmark I have,
http://www.postgresql.org/docs/postgres/index.html
is pointing at files that haven't updated for months...

Right. Last updated at the last release.

The developer's versions from the current tree are at

http://www.postgresql.org/devel-corner/docs/postgres

(and admin,programmer,tutorial,user)

I don't see a reference from the developer's corner web page, which
seems to point back to the released version instead.

- Thomas

#4Vince Vielhaber
vev@michvhf.com
In reply to: Thomas Lockhart (#3)
Re: Re: pg_dump docs

On Thu, 19 Oct 2000, Thomas Lockhart wrote:

Should be twice a day.

Where is this auto-updated copy hiding? The bookmark I have,
http://www.postgresql.org/docs/postgres/index.html
is pointing at files that haven't updated for months...

Right. Last updated at the last release.

The developer's versions from the current tree are at

http://www.postgresql.org/devel-corner/docs/postgres

(and admin,programmer,tutorial,user)

I don't see a reference from the developer's corner web page, which
seems to point back to the released version instead.

That's strange... I see it :) ...now

Vince.
--
==========================================================================
Vince Vielhaber -- KA8CSH email: vev@michvhf.com http://www.pop4.net
128K ISDN from $22.00/mo - 56K Dialup from $16.00/mo at Pop4 Networking
Online Campground Directory http://www.camping-usa.com
Online Giftshop Superstore http://www.cloudninegifts.com
==========================================================================

#5Thomas Lockhart
lockhart@alumni.caltech.edu
In reply to: Vince Vielhaber (#4)
Re: Re: pg_dump docs

I don't see a reference from the developer's corner web page, which
seems to point back to the released version instead.

That's strange... I see it :) ...now

Great! But I don't, maybe due to caching somewhere? Should I be seeing

http://www.postgresql.org/devel-corner/
-> Current documentation

pointing at

http://www.postgresql.org/devel-corner/docs/index.html

(afaik this index.html does not yet exist, but could point to the
various flavors of pages and tarballs) rather than

http://www.postgresql.org/docs/index.html

which is what I see now?

- Thomas

#6Vince Vielhaber
vev@michvhf.com
In reply to: Thomas Lockhart (#5)
Re: Re: pg_dump docs

On Thu, 19 Oct 2000, Thomas Lockhart wrote:

I don't see a reference from the developer's corner web page, which
seems to point back to the released version instead.

That's strange... I see it :) ...now

Great! But I don't, maybe due to caching somewhere? Should I be seeing

http://www.postgresql.org/devel-corner/
-> Current documentation

pointing at

http://www.postgresql.org/devel-corner/docs/index.html

(afaik this index.html does not yet exist, but could point to the
various flavors of pages and tarballs) rather than

http://www.postgresql.org/docs/index.html

which is what I see now?

I thought /docs/index.html was to be for the current docs. Since they're
not, what ARE they pointing to?? Anyway, I've now got it pointing to
devel-contrib/docs/index.html and created an index. If you ever need to
update the index, look at the script makeindex in that directory.

Vince.
--
==========================================================================
Vince Vielhaber -- KA8CSH email: vev@michvhf.com http://www.pop4.net
128K ISDN from $22.00/mo - 56K Dialup from $16.00/mo at Pop4 Networking
Online Campground Directory http://www.camping-usa.com
Online Giftshop Superstore http://www.cloudninegifts.com
==========================================================================

#7Vince Vielhaber
vev@michvhf.com
In reply to: Vince Vielhaber (#6)
Re: Re: pg_dump docs

On Fri, 20 Oct 2000, Thomas Lockhart wrote:

Vince Vielhaber wrote:

On Thu, 19 Oct 2000, Thomas Lockhart wrote:

I don't see a reference from the developer's corner web page, which
seems to point back to the released version instead.

That's strange... I see it :) ...now

Great! But I don't, maybe due to caching somewhere? Should I be seeing

http://www.postgresql.org/devel-corner/
-> Current documentation

pointing at

http://www.postgresql.org/devel-corner/docs/index.html

(afaik this index.html does not yet exist, but could point to the
various flavors of pages and tarballs) rather than

http://www.postgresql.org/docs/index.html

which is what I see now?

I thought /docs/index.html was to be for the current docs. Since they're
not, what ARE they pointing to?? Anyway, I've now got it pointing to
devel-contrib/docs/index.html and created an index. If you ever need to
update the index, look at the script makeindex in that directory.

docs/index.html *are* the "current docs". They correspond to the current
released version, which would be 7.0.x (though it is possible that no
one updated them for 7.0.2).

For developers (-hackers developers, not application developers using
the current release), the "current docs" correspond to the docs built
nightly (actually twice a day), which reflect the current development
tree.

I see the problem. You're not of BSD and I was thinking you were. I'm
guessing Marc is catching on right now. To me, "current" means the
docs that correspond to the current (or development) code. The release
I refer to is either stable or (more appropriately) "release" docs.

Either way, I think I have things figured out now.

Vince.
--
==========================================================================
Vince Vielhaber -- KA8CSH email: vev@michvhf.com http://www.pop4.net
128K ISDN from $22.00/mo - 56K Dialup from $16.00/mo at Pop4 Networking
Online Campground Directory http://www.camping-usa.com
Online Giftshop Superstore http://www.cloudninegifts.com
==========================================================================

#8Thomas Lockhart
lockhart@alumni.caltech.edu
In reply to: Vince Vielhaber (#6)
Re: Re: pg_dump docs

Vince Vielhaber wrote:

On Thu, 19 Oct 2000, Thomas Lockhart wrote:

I don't see a reference from the developer's corner web page, which
seems to point back to the released version instead.

That's strange... I see it :) ...now

Great! But I don't, maybe due to caching somewhere? Should I be seeing

http://www.postgresql.org/devel-corner/
-> Current documentation

pointing at

http://www.postgresql.org/devel-corner/docs/index.html

(afaik this index.html does not yet exist, but could point to the
various flavors of pages and tarballs) rather than

http://www.postgresql.org/docs/index.html

which is what I see now?

I thought /docs/index.html was to be for the current docs. Since they're
not, what ARE they pointing to?? Anyway, I've now got it pointing to
devel-contrib/docs/index.html and created an index. If you ever need to
update the index, look at the script makeindex in that directory.

docs/index.html *are* the "current docs". They correspond to the current
released version, which would be 7.0.x (though it is possible that no
one updated them for 7.0.2).

For developers (-hackers developers, not application developers using
the current release), the "current docs" correspond to the docs built
nightly (actually twice a day), which reflect the current development
tree.

- Thomas

#9Philip Warner
pjw@rhyme.com.au
In reply to: Vince Vielhaber (#6)
Re: Re: pg_dump docs

At 11:13 19/10/00 -0400, Vince Vielhaber wrote:

I thought /docs/index.html was to be for the current docs. Since they're
not, what ARE they pointing to?? Anyway, I've now got it pointing to
devel-contrib/docs/index.html and created an index. If you ever need to
update the index, look at the script makeindex in that directory.

I looks like all the HTML links on
http://www.postgresql.org/devel-corner/docs/index.html seem to be broken.

----------------------------------------------------------------
Philip Warner | __---_____
Albatross Consulting Pty. Ltd. |----/ - \
(A.B.N. 75 008 659 498) | /(@) ______---_
Tel: (+61) 0500 83 82 81 | _________ \
Fax: (+61) 0500 83 82 82 | ___________ |
Http://www.rhyme.com.au | / \|
| --________--
PGP key available upon request, | /
and from pgp5.ai.mit.edu:11371 |/

#10Vince Vielhaber
vev@michvhf.com
In reply to: Philip Warner (#9)
Re: Re: pg_dump docs

On Fri, 20 Oct 2000, Philip Warner wrote:

At 11:13 19/10/00 -0400, Vince Vielhaber wrote:

I thought /docs/index.html was to be for the current docs. Since they're
not, what ARE they pointing to?? Anyway, I've now got it pointing to
devel-contrib/docs/index.html and created an index. If you ever need to
update the index, look at the script makeindex in that directory.

I looks like all the HTML links on
http://www.postgresql.org/devel-corner/docs/index.html seem to be broken.

oops! Fixed.

Vince.
--
==========================================================================
Vince Vielhaber -- KA8CSH email: vev@michvhf.com http://www.pop4.net
128K ISDN from $22.00/mo - 56K Dialup from $16.00/mo at Pop4 Networking
Online Campground Directory http://www.camping-usa.com
Online Giftshop Superstore http://www.cloudninegifts.com
==========================================================================

#11Thomas Lockhart
lockhart@alumni.caltech.edu
In reply to: Vince Vielhaber (#6)
Re: Re: pg_dump docs

[Not to list]

Back on list; thanks though for protecting me from ridicule ;)

For developers (-hackers developers, not application developers using
the current release), the "current docs" correspond to the docs built
nightly (actually twice a day), which reflect the current development
tree.

If http://www.postgresql.org/devel-corner/docs/user/ is supposed to be
based on CVS, then I must have done something wrong; the new pg_restore
entry has not appeared (it's now > 24 hours old).
Any hints would be appreciated.

Ah, the build has been failing for at least the last few days due to
small problems in new content. Since I receive ~700 logs of doc builds
each year (well, that is the annual rate but I've only stepped up to
twice daily since ~April), I get sloppy about looking through them
carefully, and instead tend to look for the *length* of the log as a
measure of success while rarely examining the end of the log to see how
it actually went. In this case I missed the failure.

btw, the build log is updated and posted at

http://www.postgresql.org/devel-corner/docs/docbuild.log

Vince, could we get a cross reference to this on the developer's page?

The current problem is in using underscores in the "id" field of header
tags; this is an illegal character in this context per DocBook (a
feature not at all obvious, but which can be seen by omission in our
other docs).

pg_restore.sgml also had quite a few ^M's at the end of lines; I've got
a utility to clean those up so I applied those fixes also.

While tracking down another problem with replicated ID fields in
runtime.sgml, I caught a duplicated section and removed the apparently
older version.

I've also applied a couple of fixes suggested by Laser Henry.

Things now build without errors on my local machine, and should do the
same on postgresql.org.

- Thomas

#12Vince Vielhaber
vev@michvhf.com
In reply to: Thomas Lockhart (#11)
Re: Re: pg_dump docs

On Fri, 20 Oct 2000, Thomas Lockhart wrote:

Ah, the build has been failing for at least the last few days due to
small problems in new content. Since I receive ~700 logs of doc builds
each year (well, that is the annual rate but I've only stepped up to
twice daily since ~April), I get sloppy about looking through them
carefully, and instead tend to look for the *length* of the log as a
measure of success while rarely examining the end of the log to see how
it actually went. In this case I missed the failure.

btw, the build log is updated and posted at

http://www.postgresql.org/devel-corner/docs/docbuild.log

Vince, could we get a cross reference to this on the developer's page?

I was gonna ask you if you wanted that. Anyway it's now there. And
before anyone says it, yes I know about the duplicate link. :)

Vince.
--
==========================================================================
Vince Vielhaber -- KA8CSH email: vev@michvhf.com http://www.pop4.net
128K ISDN from $22.00/mo - 56K Dialup from $16.00/mo at Pop4 Networking
Online Campground Directory http://www.camping-usa.com
Online Giftshop Superstore http://www.cloudninegifts.com
==========================================================================