pg_xlogdump docs

Started by Bruce Momjianalmost 13 years ago4 messagesdocs
Jump to latest
#1Bruce Momjian
bruce@momjian.us

I just noticed that pg_xlogdump uses an underscore in the file name,
pg_xlogdump.sgml, unlike every other extension. Should this be fixed?

--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ It's impossible for everything to be true. +

--
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs

#2Alvaro Herrera
alvherre@2ndquadrant.com
In reply to: Bruce Momjian (#1)
Re: pg_xlogdump docs

Bruce Momjian wrote:

I just noticed that pg_xlogdump uses an underscore in the file name,
pg_xlogdump.sgml, unlike every other extension. Should this be fixed?

I did mess about with hyphens vs. underscores vs. nothing at all. Most
seem to use no char, so "pgrowlocks.sgml" for example, but that
convention seemed ugly for filenames so I went with the underscore.
Note that the SGML ID does not have anything, so the URL is similar to
others:
http://www.postgresql.org/docs/devel/static/pgxlogdump.html

We do have other files that use underscores, anyway.

--
Álvaro Herrera http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services

--
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs

#3Bruce Momjian
bruce@momjian.us
In reply to: Alvaro Herrera (#2)
Re: pg_xlogdump docs

On Fri, May 3, 2013 at 07:36:09PM -0400, Alvaro Herrera wrote:

Bruce Momjian wrote:

I just noticed that pg_xlogdump uses an underscore in the file name,
pg_xlogdump.sgml, unlike every other extension. Should this be fixed?

I did mess about with hyphens vs. underscores vs. nothing at all. Most
seem to use no char, so "pgrowlocks.sgml" for example, but that
convention seemed ugly for filenames so I went with the underscore.
Note that the SGML ID does not have anything, so the URL is similar to
others:
http://www.postgresql.org/docs/devel/static/pgxlogdump.html

We do have other files that use underscores, anyway.

Well, we have only four:

generate_history.pl information_schema.sgml mk_feature_tables.pl
pg_xlogdump.sgml

Two are Perl scripts. I agree the lack of an underscore makes it look
ugly, but if we are going to improve it, I think we should all of them
or none of them.

--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com

+ It's impossible for everything to be true. +

--
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs

#4Alvaro Herrera
alvherre@2ndquadrant.com
In reply to: Bruce Momjian (#3)
Re: pg_xlogdump docs

Bruce Momjian wrote:

On Fri, May 3, 2013 at 07:36:09PM -0400, Alvaro Herrera wrote:

We do have other files that use underscores, anyway.

Well, we have only four:

generate_history.pl information_schema.sgml mk_feature_tables.pl
pg_xlogdump.sgml

Two are Perl scripts.

There are lots more in ref/ though.

I agree the lack of an underscore makes it look ugly, but if we are
going to improve it, I think we should all of them or none of them.

I think renaming the whole bunch of old files is out of the question. I
am not opposed to renaming the new file if you think it's worth it.

--
Álvaro Herrera http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Training & Services

--
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs