diff options
| author | Peter Eisentraut | 2017-10-09 01:44:17 +0000 |
|---|---|---|
| committer | Peter Eisentraut | 2017-10-17 19:10:33 +0000 |
| commit | c29c578908dc0271eeb13a4014e54bff07a29c05 (patch) | |
| tree | 1aa03fb6f1864719f2f23d4b0b9d5e2865764082 /doc/src/sgml/ref/pg_resetwal.sgml | |
| parent | 6ecabead4b5993c42745f2802d857b1a79f48bf9 (diff) | |
Don't use SGML empty tags
For DocBook XML compatibility, don't use SGML empty tags (</>) anymore,
replace by the full tag name. Add a warning option to catch future
occurrences.
Alexander Lakhin, Jürgen Purtz
Diffstat (limited to 'doc/src/sgml/ref/pg_resetwal.sgml')
| -rw-r--r-- | doc/src/sgml/ref/pg_resetwal.sgml | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/doc/src/sgml/ref/pg_resetwal.sgml b/doc/src/sgml/ref/pg_resetwal.sgml index defaf170dc6..c8e5790a8e7 100644 --- a/doc/src/sgml/ref/pg_resetwal.sgml +++ b/doc/src/sgml/ref/pg_resetwal.sgml @@ -34,7 +34,7 @@ PostgreSQL documentation <para> <command>pg_resetwal</command> clears the write-ahead log (WAL) and optionally resets some other control information stored in the - <filename>pg_control</> file. This function is sometimes needed + <filename>pg_control</filename> file. This function is sometimes needed if these files have become corrupted. It should be used only as a last resort, when the server will not start due to such corruption. </para> @@ -43,7 +43,7 @@ PostgreSQL documentation After running this command, it should be possible to start the server, but bear in mind that the database might contain inconsistent data due to partially-committed transactions. You should immediately dump your data, - run <command>initdb</>, and reload. After reload, check for + run <command>initdb</command>, and reload. After reload, check for inconsistencies and repair as needed. </para> @@ -52,21 +52,21 @@ PostgreSQL documentation it requires read/write access to the data directory. For safety reasons, you must specify the data directory on the command line. <command>pg_resetwal</command> does not use the environment variable - <envar>PGDATA</>. + <envar>PGDATA</envar>. </para> <para> If <command>pg_resetwal</command> complains that it cannot determine - valid data for <filename>pg_control</>, you can force it to proceed anyway - by specifying the <option>-f</> (force) option. In this case plausible + valid data for <filename>pg_control</filename>, you can force it to proceed anyway + by specifying the <option>-f</option> (force) option. In this case plausible values will be substituted for the missing data. Most of the fields can be expected to match, but manual assistance might be needed for the next OID, next transaction ID and epoch, next multitransaction ID and offset, and WAL starting address fields. These fields can be set using the options discussed below. If you are not able to determine correct values for all - these fields, <option>-f</> can still be used, but + these fields, <option>-f</option> can still be used, but the recovered database must be treated with even more suspicion than - usual: an immediate dump and reload is imperative. <emphasis>Do not</> + usual: an immediate dump and reload is imperative. <emphasis>Do not</emphasis> execute any data-modifying operations in the database before you dump, as any such action is likely to make the corruption worse. </para> @@ -81,7 +81,7 @@ PostgreSQL documentation <listitem> <para> Force <command>pg_resetwal</command> to proceed even if it cannot determine - valid data for <filename>pg_control</>, as explained above. + valid data for <filename>pg_control</filename>, as explained above. </para> </listitem> </varlistentry> @@ -90,9 +90,9 @@ PostgreSQL documentation <term><option>-n</option></term> <listitem> <para> - The <option>-n</> (no operation) option instructs + The <option>-n</option> (no operation) option instructs <command>pg_resetwal</command> to print the values reconstructed from - <filename>pg_control</> and values about to be changed, and then exit + <filename>pg_control</filename> and values about to be changed, and then exit without modifying anything. This is mainly a debugging tool, but can be useful as a sanity check before allowing <command>pg_resetwal</command> to proceed for real. @@ -116,7 +116,7 @@ PostgreSQL documentation <para> The following options are only needed when <command>pg_resetwal</command> is unable to determine appropriate values - by reading <filename>pg_control</>. Safe values can be determined as + by reading <filename>pg_control</filename>. Safe values can be determined as described below. For values that take numeric arguments, hexadecimal values can be specified by using the prefix <literal>0x</literal>. </para> @@ -134,7 +134,7 @@ PostgreSQL documentation A safe value for the oldest transaction ID for which the commit time can be retrieved (first part) can be determined by looking for the numerically smallest file name in the directory - <filename>pg_commit_ts</> under the data directory. Conversely, a safe + <filename>pg_commit_ts</filename> under the data directory. Conversely, a safe value for the newest transaction ID for which the commit time can be retrieved (second part) can be determined by looking for the numerically greatest file name in the same directory. The file names are in @@ -155,8 +155,8 @@ PostgreSQL documentation except in the field that is set by <command>pg_resetwal</command>, so any value will work so far as the database itself is concerned. You might need to adjust this value to ensure that replication - systems such as <application>Slony-I</> and - <application>Skytools</> work correctly — + systems such as <application>Slony-I</application> and + <application>Skytools</application> work correctly — if so, an appropriate value should be obtainable from the state of the downstream replicated database. </para> @@ -173,22 +173,22 @@ PostgreSQL documentation <para> The WAL starting address should be larger than any WAL segment file name currently existing in - the directory <filename>pg_wal</> under the data directory. + the directory <filename>pg_wal</filename> under the data directory. These names are also in hexadecimal and have three parts. The first - part is the <quote>timeline ID</> and should usually be kept the same. - For example, if <filename>00000001000000320000004A</> is the - largest entry in <filename>pg_wal</>, use <literal>-l 00000001000000320000004B</> or higher. + part is the <quote>timeline ID</quote> and should usually be kept the same. + For example, if <filename>00000001000000320000004A</filename> is the + largest entry in <filename>pg_wal</filename>, use <literal>-l 00000001000000320000004B</literal> or higher. </para> <note> <para> <command>pg_resetwal</command> itself looks at the files in - <filename>pg_wal</> and chooses a default <option>-l</> setting + <filename>pg_wal</filename> and chooses a default <option>-l</option> setting beyond the last existing file name. Therefore, manual adjustment of - <option>-l</> should only be needed if you are aware of WAL segment - files that are not currently present in <filename>pg_wal</>, such as + <option>-l</option> should only be needed if you are aware of WAL segment + files that are not currently present in <filename>pg_wal</filename>, such as entries in an offline archive; or if the contents of - <filename>pg_wal</> have been lost entirely. + <filename>pg_wal</filename> have been lost entirely. </para> </note> </listitem> @@ -204,10 +204,10 @@ PostgreSQL documentation <para> A safe value for the next multitransaction ID (first part) can be determined by looking for the numerically largest file name in the - directory <filename>pg_multixact/offsets</> under the data directory, + directory <filename>pg_multixact/offsets</filename> under the data directory, adding one, and then multiplying by 65536 (0x10000). Conversely, a safe value for the oldest multitransaction ID (second part of - <option>-m</>) can be determined by looking for the numerically smallest + <option>-m</option>) can be determined by looking for the numerically smallest file name in the same directory and multiplying by 65536. The file names are in hexadecimal, so the easiest way to do this is to specify the option value in hexadecimal and append four zeroes. @@ -239,7 +239,7 @@ PostgreSQL documentation <para> A safe value can be determined by looking for the numerically largest - file name in the directory <filename>pg_multixact/members</> under the + file name in the directory <filename>pg_multixact/members</filename> under the data directory, adding one, and then multiplying by 52352 (0xCC80). The file names are in hexadecimal. There is no simple recipe such as the ones for other options of appending zeroes. @@ -256,12 +256,12 @@ PostgreSQL documentation <para> A safe value can be determined by looking for the numerically largest - file name in the directory <filename>pg_xact</> under the data directory, + file name in the directory <filename>pg_xact</filename> under the data directory, adding one, and then multiplying by 1048576 (0x100000). Note that the file names are in hexadecimal. It is usually easiest to specify the option value in - hexadecimal too. For example, if <filename>0011</> is the largest entry - in <filename>pg_xact</>, <literal>-x 0x1200000</> will work (five + hexadecimal too. For example, if <filename>0011</filename> is the largest entry + in <filename>pg_xact</filename>, <literal>-x 0x1200000</literal> will work (five trailing zeroes provide the proper multiplier). </para> </listitem> |
