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

Commit415dc20

Browse files
committed
docs: ulink all references to RFC's
Make sure that the first mentions of RFC's are ulinked to their ietf.orgentry, and subsequent ones are marked as acronyms. This makes referencesto RFC's consistent across the documentation.Author: Daniel GustafssonDiscussion:https://www.postgresql.org/message-id/2C697878-4D01-4F06-8312-2FEDE931E973%40yesql.se
1 parent0a4db67 commit415dc20

File tree

12 files changed

+39
-27
lines changed

12 files changed

+39
-27
lines changed

‎doc/src/sgml/catalogs.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1598,7 +1598,7 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
15981598
</synopsis>
15991599
where <replaceable>salt</replaceable>, <replaceable>StoredKey</replaceable> and
16001600
<replaceable>ServerKey</replaceable> are in Base64 encoded format. This format is
1601-
the same as that specified by RFC 5803.
1601+
the same as that specified by<ulink url="https://tools.ietf.org/html/rfc5803">RFC 5803</ulink>.
16021602
</para>
16031603

16041604
<para>

‎doc/src/sgml/charset.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2663,7 +2663,7 @@ RESET client_encoding;
26632663
</varlistentry>
26642664

26652665
<varlistentry>
2666-
<term>RFC 3629</term>
2666+
<term><ulink url="https://tools.ietf.org/html/rfc3629">RFC 3629</ulink></term>
26672667

26682668
<listitem>
26692669
<para>

‎doc/src/sgml/client-auth.sgml

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -948,7 +948,8 @@ omicron bryanh guest1
948948
<listitem>
949949
<para>
950950
<link linkend="auth-ident">Ident authentication</link>, which
951-
relies on an <quote>Identification Protocol</quote> (RFC 1413)
951+
relies on an <quote>Identification Protocol</quote>
952+
(<ulink url="https://tools.ietf.org/html/rfc1413">RFC 1413</ulink>)
952953
service on the client's machine. (On local Unix-socket connections,
953954
this is treated as peer authentication.)
954955
</para>
@@ -1198,7 +1199,8 @@ omicron bryanh guest1
11981199

11991200
<para>
12001201
<productname>GSSAPI</productname> is an industry-standard protocol
1201-
for secure authentication defined in RFC 2743.
1202+
for secure authentication defined in
1203+
<ulink url="https://tools.ietf.org/html/rfc2743">RFC 2743</ulink>.
12021204

12031205
<productname>PostgreSQL</productname>
12041206
supports <productname>GSSAPI</productname> for use as either an encrypted,
@@ -1503,7 +1505,8 @@ omicron bryanh guest1
15031505

15041506
<para>
15051507
The <quote>Identification Protocol</quote> is described in
1506-
RFC 1413. Virtually every Unix-like
1508+
<ulink url="https://tools.ietf.org/html/rfc1413">RFC 1413</ulink>.
1509+
Virtually every Unix-like
15071510
operating system ships with an ident server that listens on TCP
15081511
port 113 by default. The basic functionality of an ident server
15091512
is to answer questions like <quote>What user initiated the
@@ -1671,8 +1674,8 @@ omicron bryanh guest1
16711674
<para>
16721675
Set to 1 to make the connection between PostgreSQL and the LDAP server
16731676
use TLS encryption. This uses the <literal>StartTLS</literal>
1674-
operation perRFC 4513. See also the <literal>ldapscheme</literal>
1675-
option for an alternative.
1677+
operation per<ulink url="https://tools.ietf.org/html/rfc4513">RFC 4513</ulink>.
1678+
See also the <literal>ldapscheme</literal>option for an alternative.
16761679
</para>
16771680
</listitem>
16781681
</varlistentry>
@@ -1766,7 +1769,8 @@ omicron bryanh guest1
17661769
<term><literal>ldapurl</literal></term>
17671770
<listitem>
17681771
<para>
1769-
An RFC 4516 LDAP URL. This is an alternative way to write some of the
1772+
An <ulink url="https://tools.ietf.org/html/rfc4516">RFC 4516</ulink>
1773+
LDAP URL. This is an alternative way to write some of the
17701774
other LDAP options in a more compact and standard form. The format is
17711775
<synopsis>
17721776
ldap[s]://<replaceable>host</replaceable>[:<replaceable>port</replaceable>]/<replaceable>basedn</replaceable>[?[<replaceable>attribute</replaceable>][?[<replaceable>scope</replaceable>][?[<replaceable>filter</replaceable>]]]]
@@ -1827,7 +1831,8 @@ ldap[s]://<replaceable>host</replaceable>[:<replaceable>port</replaceable>]/<rep
18271831
If <productname>PostgreSQL</productname> was compiled with
18281832
<productname>OpenLDAP</productname> as the LDAP client library, the
18291833
<literal>ldapserver</literal> setting may be omitted. In that case, a
1830-
list of host names and ports is looked up via RFC 2782 DNS SRV records.
1834+
list of host names and ports is looked up via
1835+
<ulink url="https://tools.ietf.org/html/rfc2782">RFC 2782</ulink> DNS SRV records.
18311836
The name <literal>_ldap._tcp.DOMAIN</literal> is looked up, where
18321837
<literal>DOMAIN</literal> is extracted from <literal>ldapbasedn</literal>.
18331838
</para>

‎doc/src/sgml/datatype.sgml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2384,7 +2384,8 @@ TIMESTAMP WITH TIME ZONE '2004-10-19 10:23:54+02'
23842384
ISO 8601 specifies the use of uppercase letter <literal>T</literal> to separate
23852385
the date and time. <productname>PostgreSQL</productname> accepts that format on
23862386
input, but on output it uses a space rather than <literal>T</literal>, as shown
2387-
above. This is for readability and for consistency with RFC 3339 as
2387+
above. This is for readability and for consistency with
2388+
<ulink url="https://tools.ietf.org/html/rfc3339">RFC 3339</ulink> as
23882389
well as some other database systems.
23892390
</para>
23902391
</note>
@@ -4247,7 +4248,8 @@ SELECT to_tsvector( 'postgraduate' ), to_tsquery( 'postgres:*' );
42474248

42484249
<para>
42494250
The data type <type>uuid</type> stores Universally Unique Identifiers
4250-
(UUID) as defined by RFC 4122, ISO/IEC 9834-8:2005, and related standards.
4251+
(UUID) as defined by <ulink url="https://tools.ietf.org/html/rfc4122">RFC 4122</ulink>,
4252+
ISO/IEC 9834-8:2005, and related standards.
42514253
(Some systems refer to this data type as a globally unique identifier, or
42524254
GUID,<indexterm><primary>GUID</primary></indexterm> instead.) This
42534255
identifier is a 128-bit quantity that is generated by an algorithm chosen

‎doc/src/sgml/ecpg.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3226,7 +3226,7 @@ int PGTYPEStimestamp_fmt_asc(timestamp *ts, char *output, int str_len, char *fmt
32263226
<literal>%z</literal> - is replaced by the time zone offset from
32273227
UTC; a leading plus sign stands for east of UTC, a minus sign for
32283228
west of UTC, hours and minutes follow with two digits each and no
3229-
delimiter between them (common form for RFC 822 date headers).
3229+
delimiter between them (common form for<ulink url="https://tools.ietf.org/html/rfc822">RFC 822</ulink> date headers).
32303230
</para>
32313231
</listitem>
32323232
<listitem>

‎doc/src/sgml/func.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4449,7 +4449,7 @@ SELECT format('Testing %3$s, %2$s, %s', 'one', 'two', 'three');
44494449
<para>
44504450
The <literal>base64</literal> format is that
44514451
of <ulink url="https://tools.ietf.org/html/rfc2045#section-6.8">RFC
4452-
2045 Section 6.8</ulink>. As per the RFC, encoded lines are
4452+
2045 Section 6.8</ulink>. As per the<acronym>RFC</acronym>, encoded lines are
44534453
broken at 76 characters. However instead of the MIME CRLF
44544454
end-of-line marker, only a newline is used for end-of-line.
44554455
The <function>decode</function> function ignores carriage-return,

‎doc/src/sgml/json.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
</para>
6262

6363
<para>
64-
RFC 7159 specifies that JSON strings should be encoded in UTF8.
64+
<acronym>RFC</acronym> 7159 specifies that JSON strings should be encoded in UTF8.
6565
It is therefore not possible for the JSON
6666
types to conform rigidly to the JSON specification unless the database
6767
encoding is UTF8. Attempts to directly include characters that
@@ -71,7 +71,7 @@
7171
</para>
7272

7373
<para>
74-
RFC 7159 permits JSON strings to contain Unicode escape sequences
74+
<acronym>RFC</acronym> 7159 permits JSON strings to contain Unicode escape sequences
7575
denoted by <literal>\u<replaceable>XXXX</replaceable></literal>. In the input
7676
function for the <type>json</type> type, Unicode escapes are allowed
7777
regardless of the database encoding, and are checked only for syntactic

‎doc/src/sgml/libpq.sgml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7462,8 +7462,9 @@ user=admin
74627462
<literal>ldap://</literal> will be recognized as an LDAP URL and an
74637463
LDAP query will be performed. The result must be a list of
74647464
<literal>keyword = value</literal> pairs which will be used to set
7465-
connection options. The URL must conform to RFC 1959 and be of the
7466-
form
7465+
connection options. The URL must conform to
7466+
<ulink url="https://tools.ietf.org/html/rfc1959">RFC 1959</ulink>
7467+
and be of the form
74677468
<synopsis>
74687469
ldap://[<replaceable>hostname</replaceable>[:<replaceable>port</replaceable>]]/<replaceable>search_base</replaceable>?<replaceable>attribute</replaceable>?<replaceable>search_scope</replaceable>?<replaceable>filter</replaceable>
74697470
</synopsis>

‎doc/src/sgml/pgcrypto.sgml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,8 @@ gen_salt(type text [, iter_count integer ]) returns text
437437
<title>PGP Encryption Functions</title>
438438

439439
<para>
440-
The functions here implement the encryption part of the OpenPGP (RFC 4880)
440+
The functions here implement the encryption part of the OpenPGP
441+
(<ulink url="https://tools.ietf.org/html/rfc4880">RFC 4880</ulink>)
441442
standard. Supported are both symmetric-key and public-key encryption.
442443
</para>
443444

@@ -806,7 +807,7 @@ Applies to: pgp_sym_encrypt, pgp_pub_encrypt
806807
<para>
807808
Whether to convert <literal>\n</literal> into <literal>\r\n</literal> when
808809
encrypting and <literal>\r\n</literal> to <literal>\n</literal> when
809-
decrypting. RFC 4880 specifies that text data should be stored using
810+
decrypting.<acronym>RFC</acronym> 4880 specifies that text data should be stored using
810811
<literal>\r\n</literal> line-feeds. Use this to get fully RFC-compliant
811812
behavior.
812813
</para>
@@ -823,7 +824,7 @@ Applies to: pgp_sym_encrypt, pgp_pub_encrypt, pgp_sym_decrypt, pgp_pub_decrypt
823824
<para>
824825
Do not protect data with SHA-1. The only good reason to use this
825826
option is to achieve compatibility with ancient PGP products, predating
826-
the addition of SHA-1 protected packets to RFC 4880.
827+
the addition of SHA-1 protected packets to<acronym>RFC</acronym> 4880.
827828
Recent gnupg.org and pgp.com software supports it fine.
828829
</para>
829830
<literallayout>

‎doc/src/sgml/protocol.sgml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1501,7 +1501,8 @@ SELCT 1/0;<!-- this typo is intentional -->
15011501
is willing or unwilling to perform <acronym>GSSAPI</acronym> encryption,
15021502
respectively. The frontend might close the connection at this point
15031503
if it is dissatisfied with the response. To continue after
1504-
<literal>G</literal>, using the GSSAPI C bindings as discussed in RFC2744
1504+
<literal>G</literal>, using the GSSAPI C bindings as discussed in
1505+
<ulink url="https://tools.ietf.org/html/rfc2744">RFC 2744</ulink>
15051506
or equivalent, perform a <acronym>GSSAPI</acronym> initialization by
15061507
calling <function>gss_init_sec_context()</function> in a loop and sending
15071508
the result to the server, starting with an empty input and then with each
@@ -1616,7 +1617,8 @@ ErrorMessage.
16161617
The implemented SASL mechanisms at the moment
16171618
are <literal>SCRAM-SHA-256</literal> and its variant with channel
16181619
binding <literal>SCRAM-SHA-256-PLUS</literal>. They are described in
1619-
detail in RFC 7677 and RFC 5802.
1620+
detail in <ulink url="https://tools.ietf.org/html/rfc7677">RFC 7677</ulink>
1621+
and <ulink url="https://tools.ietf.org/html/rfc5802">RFC 5802</ulink>.
16201622
</para>
16211623

16221624
<para>

‎doc/src/sgml/textsearch.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2218,9 +2218,9 @@ LIMIT 10;
22182218

22192219
<para>
22202220
<literal>email</literal> does not support all valid email characters as
2221-
defined by RFC 5322. Specifically, the only non-alphanumeric
2222-
characters supported for email user names are period, dash, and
2223-
underscore.
2221+
defined by<ulink url="https://tools.ietf.org/html/rfc5322">RFC 5322</ulink>.
2222+
Specifically, the only non-alphanumeric characters supported for
2223+
email user names are period, dash, andunderscore.
22242224
</para>
22252225
</note>
22262226

‎doc/src/sgml/uuid-ossp.sgml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@
2828
<para>
2929
<xref linkend="uuid-ossp-functions"/> shows the functions available to
3030
generate UUIDs.
31-
The relevant standards ITU-T Rec. X.667, ISO/IEC 9834-8:2005, and RFC
32-
4122 specify four algorithms for generating UUIDs, identified by the
31+
The relevant standards ITU-T Rec. X.667, ISO/IEC 9834-8:2005, and
32+
<ulink url="https://tools.ietf.org/html/rfc4122">RFC 4122</ulink>
33+
specify four algorithms for generating UUIDs, identified by the
3334
version numbers 1, 3, 4, and 5. (There is no version 2 algorithm.)
3435
Each of these algorithms could be suitable for a different set of
3536
applications.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp