database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-11-07 19:06:32 +03:00
Code Activity

Update documentation on may/can/might:

Browse Source 
Standard English uses "may", "can", and "might" in different ways:

        may - permission, "You may borrow my rake."

        can - ability, "I can lift that log."

        might - possibility, "It might rain today."

Unfortunately, in conversational English, their use is often mixed, as
in, "You may use this variable to do X", when in fact, "can" is a better
choice.  Similarly, "It may crash" is better stated, "It might crash".

Also update two error messages mentioned in the documenation to match.
This commit is contained in:
Bruce Momjian
2007-01-31 20:56:20 +00:00
parent 67a1ae9f05
commit a134ee3379
70 changed files with 729 additions and 731 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/src/sgml/docguide.sgml
View File

@@ -1,4 +1,4 @@
<!-- $PostgreSQL: pgsql/doc/src/sgml/docguide.sgml,v 1.68 2007/01/31 15:23:28 teodor Exp $ -->
<!-- $PostgreSQL: pgsql/doc/src/sgml/docguide.sgml,v 1.69 2007/01/31 20:56:17 momjian Exp $ -->
<appendix id="docguide">
<title>Documentation</title>
@@ -79,7 +79,7 @@
<para>
The following tools are used to process the documentation. Some
may be optional, as noted.
might be optional, as noted.
<variablelist>
<varlistentry>
@@ -168,7 +168,7 @@
<para>
We have documented experience with several installation methods for
the various tools that are needed to process the documentation.
These will be described below. There may be some other packaged
These will be described below. There might be some other packaged
distributions for these tools. Please report package status to the
documentation mailing list, and we will include that information
here.
@@ -673,7 +673,7 @@ save_size.pdfjadetex = 10000
It appears that current versions of the <productname>PostgreSQL</productname> documentation
trigger some bug in or exceed the size limit of OpenJade. If the
build process of the <acronym>RTF</acronym> version hangs for a
long time and the output file still has size 0, then you may have
long time and the output file still has size 0, then you might have
hit that problem. (But keep in mind that a normal build takes 5
to 10 minutes, so don't abort too soon.)
</para>
@@ -1010,7 +1010,7 @@ save_size.pdfjadetex = 10000
<para>
The <productname>PostgreSQL</productname> distribution includes a
parsed DTD definitions file <filename>reference.ced</filename>.
You may find that when using <productname>PSGML</productname>, a
You might find that when using <productname>PSGML</productname>, a
comfortable way of working with these separate files of book
parts is to insert a proper <literal>DOCTYPE</literal>
declaration while you're editing them. If you are working on
@@ -1073,7 +1073,7 @@ save_size.pdfjadetex = 10000
<para>
Reference pages that describe executable commands should contain
the following sections, in this order. Sections that do not apply
may be omitted. Additional top-level sections should only be used
can be omitted. Additional top-level sections should only be used
in special circumstances; often that information belongs in the
<quote>Usage</quote> section.
@@ -1114,7 +1114,7 @@ save_size.pdfjadetex = 10000
<listitem>
<para>
A list describing each command-line option. If there are a
lot of options, subsections may be used.
lot of options, subsections can be used.
</para>
</listitem>
</varlistentry>