diff options
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/gin.sgml | 28 | ||||
| -rw-r--r-- | doc/src/sgml/indexam.sgml | 26 | ||||
| -rw-r--r-- | doc/src/sgml/libpq.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/spgist.sgml | 2 | ||||
| -rw-r--r-- | doc/src/sgml/sslinfo.sgml | 6 |
5 files changed, 33 insertions, 33 deletions
diff --git a/doc/src/sgml/gin.sgml b/doc/src/sgml/gin.sgml index d63d8af4405..95d6278d288 100644 --- a/doc/src/sgml/gin.sgml +++ b/doc/src/sgml/gin.sgml @@ -223,9 +223,9 @@ <para> <literal>pmatch</literal> is an output argument for use when partial match is supported. To use it, <function>extractQuery</function> must allocate - an array of <literal>*nkeys</literal> booleans and store its address at - <literal>*pmatch</literal>. Each element of the array should be set to TRUE - if the corresponding key requires partial match, FALSE if not. + an array of <literal>*nkeys</literal> bools and store its address at + <literal>*pmatch</literal>. Each element of the array should be set to true + if the corresponding key requires partial match, false if not. If <literal>*pmatch</literal> is set to <symbol>NULL</symbol> then GIN assumes partial match is not required. The variable is initialized to <symbol>NULL</symbol> before call, so this argument can simply be ignored by operator classes that do @@ -267,7 +267,7 @@ Datum queryKeys[], bool nullFlags[])</function></term> <listitem> <para> - Returns TRUE if an indexed item satisfies the query operator with + Returns true if an indexed item satisfies the query operator with strategy number <literal>n</literal> (or might satisfy it, if the recheck indication is returned). This function does not have direct access to the indexed item's value, since <acronym>GIN</acronym> does not @@ -277,8 +277,8 @@ <literal>nkeys</literal>, which is the same as the number of keys previously returned by <function>extractQuery</function> for this <literal>query</literal> datum. Each element of the - <literal>check</literal> array is TRUE if the indexed item contains the - corresponding query key, i.e., if (check[i] == TRUE) the i-th key of the + <literal>check</literal> array is true if the indexed item contains the + corresponding query key, i.e., if (check[i] == true) the i-th key of the <function>extractQuery</function> result array is present in the indexed item. The original <literal>query</literal> datum is passed in case the <function>consistent</function> method needs to consult it, @@ -291,7 +291,7 @@ <para> When <function>extractQuery</function> returns a null key in <literal>queryKeys[]</literal>, the corresponding <literal>check[]</literal> element - is TRUE if the indexed item contains a null key; that is, the + is true if the indexed item contains a null key; that is, the semantics of <literal>check[]</literal> are like <literal>IS NOT DISTINCT FROM</literal>. The <function>consistent</function> function can examine the corresponding <literal>nullFlags[]</literal> element if it needs to tell @@ -299,13 +299,13 @@ </para> <para> - On success, <literal>*recheck</literal> should be set to TRUE if the heap - tuple needs to be rechecked against the query operator, or FALSE if - the index test is exact. That is, a FALSE return value guarantees - that the heap tuple does not match the query; a TRUE return value with - <literal>*recheck</literal> set to FALSE guarantees that the heap tuple does - match the query; and a TRUE return value with - <literal>*recheck</literal> set to TRUE means that the heap tuple might match + On success, <literal>*recheck</literal> should be set to true if the heap + tuple needs to be rechecked against the query operator, or false if + the index test is exact. That is, a false return value guarantees + that the heap tuple does not match the query; a true return value with + <literal>*recheck</literal> set to false guarantees that the heap tuple does + match the query; and a true return value with + <literal>*recheck</literal> set to true means that the heap tuple might match the query, so it needs to be fetched and rechecked by evaluating the query operator directly against the originally indexed item. </para> diff --git a/doc/src/sgml/indexam.sgml b/doc/src/sgml/indexam.sgml index b06ffcdbffe..a94b188f22d 100644 --- a/doc/src/sgml/indexam.sgml +++ b/doc/src/sgml/indexam.sgml @@ -280,9 +280,9 @@ aminsert (Relation indexRelation, <para> The function's Boolean result value is significant only when <literal>checkUnique</literal> is <literal>UNIQUE_CHECK_PARTIAL</literal>. - In this case a TRUE result means the new entry is known unique, whereas - FALSE means it might be non-unique (and a deferred uniqueness check must - be scheduled). For other cases a constant FALSE result is recommended. + In this case a true result means the new entry is known unique, whereas + false means it might be non-unique (and a deferred uniqueness check must + be scheduled). For other cases a constant false result is recommended. </para> <para> @@ -368,8 +368,8 @@ amcanreturn (Relation indexRelation, int attno); linkend="indexes-index-only-scans"><firstterm>index-only scans</firstterm></link> on the given column, by returning the indexed column values for an index entry in the form of an <structname>IndexTuple</structname>. The attribute number - is 1-based, i.e. the first column's attno is 1. Returns TRUE if supported, - else FALSE. If the access method does not support index-only scans at all, + is 1-based, i.e. the first column's attno is 1. Returns true if supported, + else false. If the access method does not support index-only scans at all, the <structfield>amcanreturn</structfield> field in its <structname>IndexAmRoutine</structname> struct can be set to NULL. </para> @@ -532,15 +532,15 @@ amgettuple (IndexScanDesc scan, ScanDirection direction); </programlisting> Fetch the next tuple in the given scan, moving in the given - direction (forward or backward in the index). Returns TRUE if a tuple was - obtained, FALSE if no matching tuples remain. In the TRUE case the tuple + direction (forward or backward in the index). Returns true if a tuple was + obtained, false if no matching tuples remain. In the true case the tuple TID is stored into the <literal>scan</literal> structure. Note that <quote>success</quote> means only that the index contains an entry that matches the scan keys, not that the tuple necessarily still exists in the heap or will pass the caller's snapshot test. On success, <function>amgettuple</function> - must also set <literal>scan->xs_recheck</literal> to TRUE or FALSE. - FALSE means it is certain that the index entry matches the scan keys. - TRUE means this is not certain, and the conditions represented by the + must also set <literal>scan->xs_recheck</literal> to true or false. + False means it is certain that the index entry matches the scan keys. + true means this is not certain, and the conditions represented by the scan keys must be rechecked against the heap tuple after fetching it. This provision supports <quote>lossy</quote> index operators. Note that rechecking will extend only to the scan conditions; a partial @@ -550,7 +550,7 @@ amgettuple (IndexScanDesc scan, <para> If the index supports <link linkend="indexes-index-only-scans">index-only - scans</link> (i.e., <function>amcanreturn</function> returns TRUE for it), + scans</link> (i.e., <function>amcanreturn</function> returns true for it), then on success the AM must also check <literal>scan->xs_want_itup</literal>, and if that is true it must return the originally indexed data for the index entry. The data can be returned in the form of an @@ -1082,8 +1082,8 @@ amparallelrescan (IndexScanDesc scan); constraint is deferrable. <productname>PostgreSQL</productname> will use this mode to insert each row's index entry. The access method must allow duplicate entries into the index, and report any - potential duplicates by returning FALSE from <function>aminsert</function>. - For each row for which FALSE is returned, a deferred recheck will + potential duplicates by returning false from <function>aminsert</function>. + For each row for which false is returned, a deferred recheck will be scheduled. </para> diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 9f468b7fdc9..694921f2126 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -6970,12 +6970,12 @@ myEventProc(PGEventId evtId, void *evtInfo, void *passThrough) break; } - /* unknown event ID, just return TRUE. */ + /* unknown event ID, just return true. */ default: break; } - return TRUE; /* event processing succeeded */ + return true; /* event processing succeeded */ } ]]> </programlisting> diff --git a/doc/src/sgml/spgist.sgml b/doc/src/sgml/spgist.sgml index 1b5f654a1b9..c56a3544833 100644 --- a/doc/src/sgml/spgist.sgml +++ b/doc/src/sgml/spgist.sgml @@ -794,7 +794,7 @@ typedef struct spgLeafConsistentOut trees, in which each level of the tree includes a prefix that is short enough to fit on a page, and the final leaf level includes a suffix also short enough to fit on a page. The operator class should set - <structfield>longValuesOK</structfield> to TRUE only if it is prepared to arrange for + <structfield>longValuesOK</structfield> to true only if it is prepared to arrange for this to happen. Otherwise, the <acronym>SP-GiST</acronym> core will reject any request to index a value that is too large to fit on an index page. diff --git a/doc/src/sgml/sslinfo.sgml b/doc/src/sgml/sslinfo.sgml index 308e3e03a48..cda09aaafd2 100644 --- a/doc/src/sgml/sslinfo.sgml +++ b/doc/src/sgml/sslinfo.sgml @@ -32,7 +32,7 @@ </term> <listitem> <para> - Returns TRUE if current connection to server uses SSL, and FALSE + Returns true if current connection to server uses SSL, and false otherwise. </para> </listitem> @@ -77,8 +77,8 @@ </term> <listitem> <para> - Returns TRUE if current client has presented a valid SSL client - certificate to the server, and FALSE otherwise. (The server + Returns true if current client has presented a valid SSL client + certificate to the server, and false otherwise. (The server might or might not be configured to require a client certificate.) </para> </listitem> |