Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit5e6f9a9

Browse files
committed
Doc: various fixups
* Use <symbol> tags for CONNECTION_* #definesWe were using an inconsistent mix of <literal> and sometimes <function>tags.* Use <application> tag for libpqThere was a mix of <literal> and <productname>Also fix a whitespace issue.None of these seem critical enough mistakes to backpatch.Author: Noboru Saito <noborusai@gmail.com>Discussion:https://postgr.es/m/CAAM3qnJtv5YbjpwDfVOYN2gZ9zGSLFM1UGJgptSXmwfifOZJFQ@mail.gmail.com
1 parentd010cc6 commit5e6f9a9

File tree

2 files changed

+17
-18
lines changed

2 files changed

+17
-18
lines changed

‎doc/src/sgml/libpq.sgml

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ PostgresPollingStatusType PQconnectPoll(PGconn *conn);
378378
<para>
379379
At any time during connection, the status of the connection can be
380380
checked by calling <xref linkend="libpq-PQstatus"/>. If this call returns <symbol>CONNECTION_BAD</symbol>, then the
381-
connection procedure has failed; if the call returns <function>CONNECTION_OK</function>, then the
381+
connection procedure has failed; if the call returns <symbol>CONNECTION_OK</symbol>, then the
382382
connection is ready. Both of these states are equally detectable
383383
from the return value of <function>PQconnectPoll</function>, described above. Other states might also occur
384384
during (and only during) an asynchronous connection procedure. These
@@ -1922,7 +1922,7 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
19221922
<term><literal>sslkeylogfile</literal></term>
19231923
<listitem>
19241924
<para>
1925-
This parameter specifies the location where <literal>libpq</literal>
1925+
This parameter specifies the location where <application>libpq</application>
19261926
will log keys used in this SSL context. This is useful for debugging
19271927
<productname>PostgreSQL</productname> protocol interactions or client
19281928
connections using network inspection tools like
@@ -1956,7 +1956,7 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
19561956
<literal>Enter PEM pass phrase:</literal>
19571957
prompt that <productname>OpenSSL</productname> will emit by default
19581958
when an encrypted client certificate key is provided to
1959-
<literal>libpq</literal>.
1959+
<application>libpq</application>.
19601960
</para>
19611961
<para>
19621962
If the key is not encrypted this parameter is ignored. The parameter
@@ -2811,14 +2811,14 @@ ConnStatusType PQstatus(const PGconn *conn);
28112811
<para>
28122812
The status can be one of a number of values. However, only two of
28132813
these are seen outside of an asynchronous connection procedure:
2814-
<literal>CONNECTION_OK</literal> and
2815-
<literal>CONNECTION_BAD</literal>. A good connection to the database
2816-
has the status <literal>CONNECTION_OK</literal>. A failed
2814+
<symbol>CONNECTION_OK</symbol> and
2815+
<symbol>CONNECTION_BAD</symbol>. A good connection to the database
2816+
has the status <symbol>CONNECTION_OK</symbol>. A failed
28172817
connection attempt is signaled by status
2818-
<literal>CONNECTION_BAD</literal>. Ordinarily, an OK status will
2818+
<symbol>CONNECTION_BAD</symbol>. Ordinarily, an OK status will
28192819
remain so until <xref linkend="libpq-PQfinish"/>, but a communications
28202820
failure might result in the status changing to
2821-
<literal>CONNECTION_BAD</literal> prematurely. In that case the
2821+
<symbol>CONNECTION_BAD</symbol> prematurely. In that case the
28222822
application could try to recover by calling
28232823
<xref linkend="libpq-PQreset"/>.
28242824
</para>
@@ -6628,7 +6628,7 @@ PostgresPollingStatusType PQcancelPoll(PGcancelConn *cancelConn);
66286628
checked by calling <xref linkend="libpq-PQcancelStatus"/>.
66296629
If this call returns <symbol>CONNECTION_BAD</symbol>, then
66306630
the cancel procedure has failed; if the call returns
6631-
<function>CONNECTION_OK</function>, then cancel request was
6631+
<symbol>CONNECTION_OK</symbol>, then cancel request was
66326632
successfully dispatched.
66336633
Both of these states are equally detectable from the return value of
66346634
<function>PQcancelPoll</function>, described above.
@@ -6750,15 +6750,15 @@ ConnStatusType PQcancelStatus(const PGcancelConn *cancelConn);
67506750
<para>
67516751
The status can be one of a number of values. However, only three of
67526752
these are seen outside of an asynchronous cancel procedure:
6753-
<literal>CONNECTION_ALLOCATED</literal>,
6754-
<literal>CONNECTION_OK</literal> and
6755-
<literal>CONNECTION_BAD</literal>. The initial state of a
6753+
<symbol>CONNECTION_ALLOCATED</symbol>,
6754+
<symbol>CONNECTION_OK</symbol> and
6755+
<symbol>CONNECTION_BAD</symbol>. The initial state of a
67566756
<function>PGcancelConn</function> that's successfully created using
6757-
<xref linkend="libpq-PQcancelCreate"/> is <literal>CONNECTION_ALLOCATED</literal>.
6757+
<xref linkend="libpq-PQcancelCreate"/> is <symbol>CONNECTION_ALLOCATED</symbol>.
67586758
A cancel request that was successfully dispatched
6759-
has the status <literal>CONNECTION_OK</literal>. A failed
6759+
has the status <symbol>CONNECTION_OK</symbol>. A failed
67606760
cancel attempt is signaled by status
6761-
<literal>CONNECTION_BAD</literal>. An OK status will
6761+
<symbol>CONNECTION_BAD</symbol>. An OK status will
67626762
remain so until <xref linkend="libpq-PQcancelFinish"/> or
67636763
<xref linkend="libpq-PQcancelReset"/> is called.
67646764
</para>
@@ -8283,7 +8283,7 @@ size_t PQresultMemorySize(const PGresult *res);
82838283

82848284
<listitem>
82858285
<para>
8286-
Return the version of <productname>libpq</productname> that is being used.
8286+
Return the version of <application>libpq</application> that is being used.
82878287
<synopsis>
82888288
int PQlibVersion(void);
82898289
</synopsis>
@@ -8534,7 +8534,7 @@ typedef struct
85348534
<parameter>evtInfo</parameter> pointer should be cast to a
85358535
<structname>PGEventRegister *</structname>. This structure contains a
85368536
<structname>PGconn</structname> that should be in the
8537-
<literal>CONNECTION_OK</literal> status; guaranteed if one calls
8537+
<symbol>CONNECTION_OK</symbol> status; guaranteed if one calls
85388538
<xref linkend="libpq-PQregisterEventProc"/> right after obtaining a good
85398539
<structname>PGconn</structname>. When returning a failure code, all
85408540
cleanup must be performed as no <literal>PGEVT_CONNDESTROY</literal>

‎doc/src/sgml/logicaldecoding.sgml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -898,7 +898,6 @@ typedef void (*LogicalDecodeMessageCB) (struct LogicalDecodingContext *ctx,
898898
callback might also error out due to simultaneous rollback of
899899
this very same transaction. In that case, the logical decoding of this
900900
aborted transaction is stopped gracefully.
901-
902901
The <parameter>prefix</parameter> is arbitrary null-terminated prefix
903902
which can be used for identifying interesting messages for the current
904903
plugin. And finally the <parameter>message</parameter> parameter holds

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp