Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit a134ee3

Browse files
committed
Update documentation on may/can/might:
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.
1 parent 67a1ae9 commit a134ee3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+729
-731
lines changed

doc/src/sgml/advanced.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/advanced.sgml,v 1.52 2006/10/21 23:12:57 tgl Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/advanced.sgml,v 1.53 2007/01/31 20:56:16 momjian Exp $ -->
22

33
<chapter id="tutorial-advanced">
44
<title>Advanced Features</title>
@@ -57,7 +57,7 @@ SELECT * FROM myview;
5757
<para>
5858
Making liberal use of views is a key aspect of good SQL database
5959
design. Views allow you to encapsulate the details of the
60-
structure of your tables, which may change as your application
60+
structure of your tables, which might change as your application
6161
evolves, behind consistent interfaces.
6262
</para>
6363

@@ -250,7 +250,7 @@ COMMIT;
250250
<note>
251251
<para>
252252
Some client libraries issue <command>BEGIN</> and <command>COMMIT</>
253-
commands automatically, so that you may get the effect of transaction
253+
commands automatically, so that you might get the effect of transaction
254254
blocks without asking. Check the documentation for the interface
255255
you are using.
256256
</para>

doc/src/sgml/arch-dev.sgml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/arch-dev.sgml,v 2.28 2006/09/16 00:30:11 momjian Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/arch-dev.sgml,v 2.29 2007/01/31 20:56:16 momjian Exp $ -->
22

33
<chapter id="overview">
44
<title>Overview of PostgreSQL Internals</title>
@@ -272,7 +272,7 @@
272272
similar to the raw parse tree in most places, but it has many differences
273273
in detail. For example, a <structname>FuncCall</> node in the
274274
parse tree represents something that looks syntactically like a function
275-
call. This may be transformed to either a <structname>FuncExpr</>
275+
call. This might be transformed to either a <structname>FuncExpr</>
276276
or <structname>Aggref</> node depending on whether the referenced
277277
name turns out to be an ordinary function or an aggregate function.
278278
Also, information about the actual data types of columns and expression
@@ -342,7 +342,7 @@
342342
<note>
343343
<para>
344344
In some situations, examining each possible way in which a query
345-
may be executed would take an excessive amount of time and memory
345+
can be executed would take an excessive amount of time and memory
346346
space. In particular, this occurs when executing queries
347347
involving large numbers of join operations. In order to determine
348348
a reasonable (not optimal) query plan in a reasonable amount of
@@ -414,7 +414,7 @@
414414
scanned in parallel, and matching rows are combined to form
415415
join rows. This kind of join is more
416416
attractive because each relation has to be scanned only once.
417-
The required sorting may be achieved either by an explicit sort
417+
The required sorting might be achieved either by an explicit sort
418418
step, or by scanning the relation in the proper order using an
419419
index on the join key.
420420
</para>
@@ -502,7 +502,7 @@
502502
</para>
503503

504504
<para>
505-
Complex queries may involve many levels of plan nodes, but the general
505+
Complex queries can involve many levels of plan nodes, but the general
506506
approach is the same: each node computes and returns its next output
507507
row each time it is called. Each node is also responsible for applying
508508
any selection or projection expressions that were assigned to it by
@@ -518,7 +518,7 @@
518518
into the target table specified for the <command>INSERT</>. (A simple
519519
<command>INSERT ... VALUES</> command creates a trivial plan tree
520520
consisting of a single <literal>Result</> node, which computes just one
521-
result row. But <command>INSERT ... SELECT</> may demand the full power
521+
result row. But <command>INSERT ... SELECT</> can demand the full power
522522
of the executor mechanism.) For <command>UPDATE</>, the planner arranges
523523
that each computed row includes all the updated column values, plus
524524
the <firstterm>TID</> (tuple ID, or row ID) of the original target row;

doc/src/sgml/array.sgml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/array.sgml,v 1.54 2007/01/31 04:12:01 momjian Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/array.sgml,v 1.55 2007/01/31 20:56:16 momjian Exp $ -->
22

33
<sect1 id="arrays">
44
<title>Arrays</title>
@@ -63,7 +63,7 @@ CREATE TABLE tictactoe (
6363
</para>
6464

6565
<para>
66-
An alternative syntax, which conforms to the SQL standard, may
66+
An alternative syntax, which conforms to the SQL standard, can
6767
be used for one-dimensional arrays.
6868
<structfield>pay_by_quarter</structfield> could have been defined
6969
as:
@@ -88,7 +88,7 @@ CREATE TABLE tictactoe (
8888
To write an array value as a literal constant, enclose the element
8989
values within curly braces and separate them by commas. (If you
9090
know C, this is not unlike the C syntax for initializing
91-
structures.) You may put double quotes around any element value,
91+
structures.) You can put double quotes around any element value,
9292
and must do so if it contains commas or curly braces. (More
9393
details appear below.) Thus, the general format of an array
9494
constant is the following:
@@ -155,7 +155,7 @@ SELECT * FROM sal_emp;
155155
</para>
156156

157157
<para>
158-
The <literal>ARRAY</> constructor syntax may also be used:
158+
The <literal>ARRAY</> constructor syntax can also be used:
159159
<programlisting>
160160
INSERT INTO sal_emp
161161
VALUES ('Bill',
@@ -333,7 +333,7 @@ UPDATE sal_emp SET pay_by_quarter = ARRAY[25000,25000,27000,27000]
333333
WHERE name = 'Carol';
334334
</programlisting>
335335

336-
An array may also be updated at a single element:
336+
An array can also be updated at a single element:
337337

338338
<programlisting>
339339
UPDATE sal_emp SET pay_by_quarter[4] = 15000
@@ -453,7 +453,7 @@ SELECT array_dims(ARRAY[1,2] || ARRAY[[3,4],[5,6]]);
453453

454454
Note that the concatenation operator discussed above is preferred over
455455
direct use of these functions. In fact, the functions exist primarily for use
456-
in implementing the concatenation operator. However, they may be directly
456+
in implementing the concatenation operator. However, they might be directly
457457
useful in the creation of user-defined aggregates. Some examples:
458458

459459
<programlisting>
@@ -525,7 +525,7 @@ SELECT * FROM sal_emp WHERE 10000 = ALL (pay_by_quarter);
525525
<tip>
526526
<para>
527527
Arrays are not sets; searching for specific array elements
528-
may be a sign of database misdesign. Consider
528+
can be a sign of database misdesign. Consider
529529
using a separate table with a row for each item that would be an
530530
array element. This will be easier to search, and is likely to
531531
scale up better to large numbers of elements.
@@ -592,7 +592,7 @@ SELECT f1[1][-2][3] AS e1, f1[1][-1][5] AS e2
592592
or backslashes disables this and allows the literal string value
593593
<quote>NULL</> to be entered. Also, for backwards compatibility with
594594
pre-8.2 versions of <productname>PostgreSQL</>, the <xref
595-
linkend="guc-array-nulls"> configuration parameter may be turned
595+
linkend="guc-array-nulls"> configuration parameter might be turned
596596
<literal>off</> to suppress recognition of <literal>NULL</> as a NULL.
597597
</para>
598598

@@ -611,8 +611,8 @@ SELECT f1[1][-2][3] AS e1, f1[1][-1][5] AS e2
611611
</para>
612612

613613
<para>
614-
You may write whitespace before a left brace or after a right
615-
brace. You may also write whitespace before or after any individual item
614+
You can write whitespace before a left brace or after a right
615+
brace. You can also write whitespace before or after any individual item
616616
string. In all of these cases the whitespace will be ignored. However,
617617
whitespace within double-quoted elements, or surrounded on both sides by
618618
non-whitespace characters of an element, is not ignored.

doc/src/sgml/backup.sgml

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/backup.sgml,v 2.95 2006/12/01 03:29:15 tgl Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/backup.sgml,v 2.96 2007/01/31 20:56:16 momjian Exp $ -->
22

33
<chapter id="backup">
44
<title>Backup and Restore</title>
@@ -124,7 +124,7 @@ psql <replaceable class="parameter">dbname</replaceable> &lt; <replaceable class
124124

125125
<para>
126126
By default, the <application>psql</> script will continue to
127-
execute after an SQL error is encountered. You may wish to use the
127+
execute after an SQL error is encountered. You might wish to use the
128128
following command at the top of the script to alter that
129129
behaviour and have <application>psql</application> exit with an
130130
exit status of 3 if an SQL error occurs:
@@ -138,7 +138,7 @@ psql <replaceable class="parameter">dbname</replaceable> &lt; <replaceable class
138138
passing the <option>-1</> or <option>--single-transaction</>
139139
command-line options to <application>psql</>. When using this
140140
mode, be aware that even the smallest of errors can rollback a
141-
restore that has already run for many hours. However, that may
141+
restore that has already run for many hours. However, that might
142142
still be preferable to manually cleaning up a complex database
143143
after a partially restored dump.
144144
</para>
@@ -325,7 +325,7 @@ tar -cf backup.tar /usr/local/pgsql/data
325325
<listitem>
326326
<para>
327327
If you have dug into the details of the file system layout of the
328-
database, you may be tempted to try to back up or restore only certain
328+
database, you might be tempted to try to back up or restore only certain
329329
individual tables or databases from their respective files or
330330
directories. This will <emphasis>not</> work because the
331331
information contained in these files contains only half the
@@ -360,7 +360,7 @@ tar -cf backup.tar /usr/local/pgsql/data
360360
</para>
361361

362362
<para>
363-
If your database is spread across multiple file systems, there may not
363+
If your database is spread across multiple file systems, there might not
364364
be any way to obtain exactly-simultaneous frozen snapshots of all
365365
the volumes. For example, if your data files and WAL log are on different
366366
disks, or if tablespaces are on different file systems, it might
@@ -437,7 +437,7 @@ tar -cf backup.tar /usr/local/pgsql/data
437437
Since we can string together an indefinitely long sequence of WAL files
438438
for replay, continuous backup can be achieved simply by continuing to archive
439439
the WAL files. This is particularly valuable for large databases, where
440-
it may not be convenient to take a full backup frequently.
440+
it might not be convenient to take a full backup frequently.
441441
</para>
442442
</listitem>
443443
<listitem>
@@ -465,7 +465,7 @@ tar -cf backup.tar /usr/local/pgsql/data
465465
<para>
466466
As with the plain file-system-backup technique, this method can only
467467
support restoration of an entire database cluster, not a subset.
468-
Also, it requires a lot of archival storage: the base backup may be bulky,
468+
Also, it requires a lot of archival storage: the base backup might be bulky,
469469
and a busy system will generate many megabytes of WAL traffic that
470470
have to be archived. Still, it is the preferred backup technique in
471471
many situations where high reliability is needed.
@@ -534,7 +534,7 @@ archive_command = 'cp -i %p /mnt/server/archivedir/%f &lt;/dev/null'
534534
</programlisting>
535535
which will copy archivable WAL segments to the directory
536536
<filename>/mnt/server/archivedir</>. (This is an example, not a
537-
recommendation, and may not work on all platforms.)
537+
recommendation, and might not work on all platforms.)
538538
</para>
539539

540540
<para>
@@ -601,7 +601,7 @@ archive_command = 'test ! -f .../%f &amp;&amp; cp %p .../%f'
601601

602602
<para>
603603
In writing your archive command, you should assume that the file names to
604-
be archived may be up to 64 characters long and may contain any
604+
be archived can be up to 64 characters long and can contain any
605605
combination of ASCII letters, digits, and dots. It is not necessary to
606606
remember the original relative path (<literal>%p</>) but it is necessary to
607607
remember the file name (<literal>%f</>).
@@ -614,7 +614,7 @@ archive_command = 'test ! -f .../%f &amp;&amp; cp %p .../%f'
614614
<filename>postgresql.conf</>, <filename>pg_hba.conf</> and
615615
<filename>pg_ident.conf</>), since those are edited manually rather
616616
than through SQL operations.
617-
You may wish to keep the configuration files in a location that will
617+
You might wish to keep the configuration files in a location that will
618618
be backed up by your regular file system backup procedures. See
619619
<xref linkend="runtime-config-file-locations"> for how to relocate the
620620
configuration files.
@@ -732,7 +732,7 @@ SELECT pg_stop_backup();
732732
between <function>pg_start_backup</> and the start of the actual backup,
733733
nor between the end of the backup and <function>pg_stop_backup</>; a
734734
few minutes' delay won't hurt anything. (However, if you normally run the
735-
server with <varname>full_page_writes</> disabled, you may notice a drop
735+
server with <varname>full_page_writes</> disabled, you might notice a drop
736736
in performance between <function>pg_start_backup</> and
737737
<function>pg_stop_backup</>, since <varname>full_page_writes</> is
738738
effectively forced on during backup mode.) You must ensure that these
@@ -750,7 +750,7 @@ SELECT pg_stop_backup();
750750
</para>
751751

752752
<para>
753-
You may, however, omit from the backup dump the files within the
753+
You can, however, omit from the backup dump the files within the
754754
<filename>pg_xlog/</> subdirectory of the cluster directory. This
755755
slight complication is worthwhile because it reduces the risk
756756
of mistakes when restoring. This is easy to arrange if
@@ -775,7 +775,7 @@ SELECT pg_stop_backup();
775775
the file system backup and the WAL segment files used during the
776776
backup (as specified in the backup history file), all archived WAL
777777
segments with names numerically less are no longer needed to recover
778-
the file system backup and may be deleted. However, you should
778+
the file system backup and can be deleted. However, you should
779779
consider keeping several backup sets to be absolutely certain that
780780
you can recover your data.
781781
</para>
@@ -842,7 +842,7 @@ SELECT pg_stop_backup();
842842
require that you have enough free space on your system to hold two
843843
copies of your existing database. If you do not have enough space,
844844
you need at the least to copy the contents of the <filename>pg_xlog</>
845-
subdirectory of the cluster data directory, as it may contain logs which
845+
subdirectory of the cluster data directory, as it might contain logs which
846846
were not archived before the system went down.
847847
</para>
848848
</listitem>
@@ -881,7 +881,7 @@ SELECT pg_stop_backup();
881881
<listitem>
882882
<para>
883883
Create a recovery command file <filename>recovery.conf</> in the cluster
884-
data directory (see <xref linkend="recovery-config-settings">). You may
884+
data directory (see <xref linkend="recovery-config-settings">). You might
885885
also want to temporarily modify <filename>pg_hba.conf</> to prevent
886886
ordinary users from connecting until you are sure the recovery has worked.
887887
</para>
@@ -917,7 +917,7 @@ SELECT pg_stop_backup();
917917
<filename>recovery.conf</> is the <varname>restore_command</>,
918918
which tells <productname>PostgreSQL</> how to get back archived
919919
WAL file segments. Like the <varname>archive_command</>, this is
920-
a shell command string. It may contain <literal>%f</>, which is
920+
a shell command string. It can contain <literal>%f</>, which is
921921
replaced by the name of the desired log file, and <literal>%p</>,
922922
which is replaced by the path name to copy the log file to.
923923
(The path name is relative to the working directory of the server,
@@ -1228,8 +1228,8 @@ restore_command = 'copy /mnt/server/archivedir/%f "%p"' # Windows
12281228
It should also be noted that the default <acronym>WAL</acronym>
12291229
format is fairly bulky since it includes many disk page snapshots.
12301230
These page snapshots are designed to support crash recovery, since
1231-
we may need to fix partially-written disk pages. Depending on
1232-
your system hardware and software, the risk of partial writes may
1231+
we might need to fix partially-written disk pages. Depending on
1232+
your system hardware and software, the risk of partial writes might
12331233
be small enough to ignore, in which case you can significantly
12341234
reduce the total volume of archived logs by turning off page
12351235
snapshots using the <xref linkend="guc-full-page-writes">
@@ -1238,7 +1238,7 @@ restore_command = 'copy /mnt/server/archivedir/%f "%p"' # Windows
12381238
use of the logs for PITR operations. An area for future
12391239
development is to compress archived WAL data by removing
12401240
unnecessary page copies even when <varname>full_page_writes</> is
1241-
on. In the meantime, administrators may wish to reduce the number
1241+
on. In the meantime, administrators might wish to reduce the number
12421242
of page snapshots included in WAL by increasing the checkpoint
12431243
interval parameters as much as feasible.
12441244
</para>
@@ -1522,15 +1522,15 @@ if (!triggered)
15221522
connectivity between the two and the viability of the primary. It is
15231523
also possible to use a third system (called a witness server) to avoid
15241524
some problems of inappropriate failover, but the additional complexity
1525-
may not be worthwhile unless it is set-up with sufficient care and
1525+
might not be worthwhile unless it is set-up with sufficient care and
15261526
rigorous testing.
15271527
</para>
15281528

15291529
<para>
15301530
Once failover to the standby occurs, we have only a
15311531
single server in operation. This is known as a degenerate state.
15321532
The former standby is now the primary, but the former primary is down
1533-
and may stay down. To return to normal operation we must
1533+
and might stay down. To return to normal operation we must
15341534
fully recreate a standby server,
15351535
either on the former primary system when it comes up, or on a third,
15361536
possibly new, system. Once complete the primary and standby can be
@@ -1662,7 +1662,7 @@ if (!triggered)
16621662
It is recommended that you use the <application>pg_dump</> and
16631663
<application>pg_dumpall</> programs from the newer version of
16641664
<productname>PostgreSQL</>, to take advantage of any enhancements
1665-
that may have been made in these programs. Current releases of the
1665+
that might have been made in these programs. Current releases of the
16661666
dump programs can read data from any server version back to 7.0.
16671667
</para>
16681668

@@ -1716,7 +1716,7 @@ psql -f backup postgres
17161716
<note>
17171717
<para>
17181718
When you <quote>move the old installation out of the way</quote>
1719-
it may no longer be perfectly usable. Some of the executable programs
1719+
it might no longer be perfectly usable. Some of the executable programs
17201720
contain absolute paths to various installed programs and data files.
17211721
This is usually not a big problem but if you plan on using two
17221722
installations in parallel for a while you should assign them

doc/src/sgml/bki.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/bki.sgml,v 1.19 2006/09/16 00:30:11 momjian Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/bki.sgml,v 1.20 2007/01/31 20:56:16 momjian Exp $ -->
22

33
<chapter id="bki">
44
<title><acronym>BKI</acronym> Backend Interface</title>
@@ -29,7 +29,7 @@
2929
</para>
3030

3131
<para>
32-
Related information may be found in the documentation for
32+
Related information can be found in the documentation for
3333
<application>initdb</application>.
3434
</para>
3535

0 commit comments

Comments
 (0)