Skip to content

Commit c677f2b

Browse files
author
Amit Kapila
committed
Doc: Use <structfield> markup for sequence fields.
Following commit 980a855, update documentation to use <structfield> for sequence columns. Previously, these were incorrectly marked up as <literal>. Author: Peter Smith <smithpb2250@gmail.com> Reviewed-by: Chao Li <li.evan.chao@gmail.com> Discussion: https://postgr.es/m/CAHut+PtpDMUE3Kd1p=1ff9pw2HMbgQCpowE_0Hd6gs5v2pKfQg@mail.gmail.com
1 parent 792353f commit c677f2b

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

doc/src/sgml/func/func-sequence.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,14 +67,14 @@
6767
</para>
6868
<para>
6969
Sets the sequence object's current value, and optionally
70-
its <literal>is_called</literal> flag. The two-parameter
71-
form sets the sequence's <literal>last_value</literal> field to the
72-
specified value and sets its <literal>is_called</literal> field to
70+
its <structfield>is_called</structfield> flag. The two-parameter
71+
form sets the sequence's <structfield>last_value</structfield> field to the
72+
specified value and sets its <structfield>is_called</structfield> field to
7373
<literal>true</literal>, meaning that the next
7474
<function>nextval</function> will advance the sequence before
7575
returning a value. The value that will be reported
7676
by <function>currval</function> is also set to the specified value.
77-
In the three-parameter form, <literal>is_called</literal> can be set
77+
In the three-parameter form, <structfield>is_called</structfield> can be set
7878
to either <literal>true</literal>
7979
or <literal>false</literal>. <literal>true</literal> has the same
8080
effect as the two-parameter form. If it is set

doc/src/sgml/ref/alter_sequence.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,8 +207,8 @@ ALTER SEQUENCE [ IF EXISTS ] <replaceable class="parameter">name</replaceable> S
207207
The optional clause <literal>RESTART [ WITH <replaceable
208208
class="parameter">restart</replaceable> ]</literal> changes the
209209
current value of the sequence. This is similar to calling the
210-
<function>setval</function> function with <literal>is_called</literal> =
211-
<literal>false</literal>: the specified value will be returned by the
210+
<function>setval</function> function with <structfield>is_called</structfield>
211+
= <literal>false</literal>: the specified value will be returned by the
212212
<emphasis>next</emphasis> call of <function>nextval</function>.
213213
Writing <literal>RESTART</literal> with no <replaceable
214214
class="parameter">restart</replaceable> value is equivalent to supplying

doc/src/sgml/ref/create_sequence.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ SELECT * FROM <replaceable>name</replaceable>;
7070
</programlisting>
7171

7272
to examine the parameters and current state of a sequence. In particular,
73-
the <literal>last_value</literal> field of the sequence shows the last value
73+
the <structfield>last_value</structfield> field of the sequence shows the last value
7474
allocated by any session. (Of course, this value might be obsolete
7575
by the time it's printed, if other sessions are actively doing
7676
<function>nextval</function> calls.)
@@ -295,7 +295,7 @@ SELECT * FROM <replaceable>name</replaceable>;
295295
used for a sequence object that will be used concurrently by
296296
multiple sessions. Each session will allocate and cache successive
297297
sequence values during one access to the sequence object and
298-
increase the sequence object's <literal>last_value</literal> accordingly.
298+
increase the sequence object's <structfield>last_value</structfield> accordingly.
299299
Then, the next <replaceable class="parameter">cache</replaceable>-1
300300
uses of <function>nextval</function> within that session simply return the
301301
preallocated values without touching the sequence object. So, any
@@ -319,7 +319,7 @@ SELECT * FROM <replaceable>name</replaceable>;
319319
class="parameter">cache</replaceable> setting greater than one you
320320
should only assume that the <function>nextval</function> values are all
321321
distinct, not that they are generated purely sequentially. Also,
322-
<literal>last_value</literal> will reflect the latest value reserved by
322+
<structfield>last_value</structfield> will reflect the latest value reserved by
323323
any session, whether or not it has yet been returned by
324324
<function>nextval</function>.
325325
</para>

0 commit comments

Comments
 (0)