assorted documentation errors

From: Rich Morin <rdm(at)cfcl(dot)com>
To: pgsql-bugs(at)PostgreSQL(dot)org
Subject: assorted documentation errors
Date: 2001-08-06 22:14:44
Message-ID: p05100383b794c2c0a634@[192.168.168.205]
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-bugs

Your name : Rich Morin
Your email address : rdm(at)cfcl(dot)com

System Configuration
---------------------
Architecture (example: Intel Pentium) : Intel Pentium II

Operating System (example: Linux 2.0.26 ELF) : FreeBSD 4.2

PostgreSQL version (example: PostgreSQL-7.1.1): PostgreSQL-7.1.2

Compiler used (example: gcc 2.95.2) : gcc 2.95.2

Please enter a FULL description of your problem:
------------------------------------------------

I have been looking over the PostgreSQL manual pages and have noted a
number of formatting problems. Unfortunately, as the DocBook source
code does not seem to be in the distribution, I have no way of knowing
where these problems originated. In any case, here is a summary:

createdb.1, createlang.1, createuser.1, dropdb.1, droplang.1, etc.

In many places where code and output examples are being given, the
font used is proportional. If a monospace font were used, the code
would stand out better and the output would line up correctly.

droplang.1, dropuser.1, etc.

There is insufficient consistentcy to the NAME entries. For instance:

droplang - Remove a programming language from a Postgres database
dropuser - Drops (removes) a Postgres user

Why not settle on either "Removes/Drops" or "Remove/Drop"?

pg_restore.1

In the NAME entry, there is a missing space in "created bypg_dump".

alter_group.l

In the NAME entry, the comma should be a semi-colon: "group; remove".

fetch.l

In the NAME entry, there should be a comma: "rows, using".

Please describe a way to repeat the problem. Please try to provide a
concise reproducible example, if at all possible:
----------------------------------------------------------------------

Print the referenced manual pages, using "groff -man"

If you know how this problem might be fixed, list the solution below:
---------------------------------------------------------------------

Edit the original files and/or fix the conversion script.

--
email: rdm(at)cfcl(dot)com; phone: +1 650-873-7841
http://www.cfcl.com/rdm - home page, resume, etc.
http://www.cfcl.com/Meta/md_fb.html - The FreeBSD Browser
http://www.ptf.com/tdc - Prime Time Freeware's Darwin Collection

Responses

Browse pgsql-bugs by date

  From Date Subject
Next Message pgsql-bugs 2001-08-06 23:27:57 backend don't use index when querying by indexed column
Previous Message Trond Eivind =?iso-8859-1?q?Glomsr=F8d?= 2001-08-06 18:46:03 Re: HELP! BUG? pg_dump mucks up grant/revoke