Skip to content

Commit daae02c

Browse files
KentarouTakedaKentarouTakeda
committed
Address review: use exceptionname for Error and simpara for parameters
Mark the thrown Error with <exceptionname>, use <simpara> for the qos_class description, and drop the <para> wrapper around its <variablelist>.
1 parent 1c46369 commit daae02c

2 files changed

Lines changed: 56 additions & 58 deletions

File tree

‎reference/pcntl/functions/pcntl-getqos-class.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
<refsect1 role="errors">
3737
&reftitle.errors;
3838
<simpara>
39-
Throws an <classname>Error</classname> if the underlying call to
39+
Throws an <exceptionname>Error</exceptionname> if the underlying call to
4040
<literal>pthread_get_qos_class_np()</literal> fails.
4141
</simpara>
4242
</refsect1>

‎reference/pcntl/functions/pcntl-setqos-class.xml‎

Lines changed: 55 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -23,66 +23,64 @@
2323
<varlistentry>
2424
<term><parameter>qos_class</parameter></term>
2525
<listitem>
26-
<para>
26+
<simpara>
2727
The Quality of Service class to assign to the current thread. The
2828
operating system uses this as a hint to schedule CPU time, I/O priority,
2929
and energy usage, with higher classes preempting lower ones. See
3030
<enumname>Pcntl\QosClass</enumname> for the available cases.
31-
</para>
32-
<para>
33-
<variablelist>
34-
<varlistentry>
35-
<term><constant>Pcntl\QosClass::UserInteractive</constant></term>
36-
<listitem>
37-
<simpara>
38-
Highest priority. Intended for work that directly drives a user
39-
interface and must complete virtually instantly to avoid perceived
40-
delay, such as event handling or drawing.
41-
</simpara>
42-
</listitem>
43-
</varlistentry>
44-
<varlistentry>
45-
<term><constant>Pcntl\QosClass::UserInitiated</constant></term>
46-
<listitem>
47-
<simpara>
48-
High priority, just below <constant>UserInteractive</constant>.
49-
Intended for work the user has explicitly initiated and is actively
50-
waiting on, expected to complete within a few seconds.
51-
</simpara>
52-
</listitem>
53-
</varlistentry>
54-
<varlistentry>
55-
<term><constant>Pcntl\QosClass::Default</constant></term>
56-
<listitem>
57-
<simpara>
58-
Standard priority, used when no more specific class applies. Runs
59-
after higher-priority work but ahead of <constant>Utility</constant>
60-
and <constant>Background</constant>.
61-
</simpara>
62-
</listitem>
63-
</varlistentry>
64-
<varlistentry>
65-
<term><constant>Pcntl\QosClass::Utility</constant></term>
66-
<listitem>
67-
<simpara>
68-
Lower priority, intended for long-running work the user is aware of
69-
but not actively waiting on, such as downloads, imports, or bulk
70-
computation. Scheduled in an energy-efficient manner.
71-
</simpara>
72-
</listitem>
73-
</varlistentry>
74-
<varlistentry>
75-
<term><constant>Pcntl\QosClass::Background</constant></term>
76-
<listitem>
77-
<simpara>
78-
Lowest priority, intended for work the user is not aware of, such as
79-
prefetching, indexing, or maintenance. Heavily optimized for energy
80-
efficiency and may be deferred when the system is under load.
81-
</simpara>
82-
</listitem>
83-
</varlistentry>
84-
</variablelist>
85-
</para>
31+
</simpara>
32+
<variablelist>
33+
<varlistentry>
34+
<term><constant>Pcntl\QosClass::UserInteractive</constant></term>
35+
<listitem>
36+
<simpara>
37+
Highest priority. Intended for work that directly drives a user
38+
interface and must complete virtually instantly to avoid perceived
39+
delay, such as event handling or drawing.
40+
</simpara>
41+
</listitem>
42+
</varlistentry>
43+
<varlistentry>
44+
<term><constant>Pcntl\QosClass::UserInitiated</constant></term>
45+
<listitem>
46+
<simpara>
47+
High priority, just below <constant>UserInteractive</constant>.
48+
Intended for work the user has explicitly initiated and is actively
49+
waiting on, expected to complete within a few seconds.
50+
</simpara>
51+
</listitem>
52+
</varlistentry>
53+
<varlistentry>
54+
<term><constant>Pcntl\QosClass::Default</constant></term>
55+
<listitem>
56+
<simpara>
57+
Standard priority, used when no more specific class applies. Runs
58+
after higher-priority work but ahead of <constant>Utility</constant>
59+
and <constant>Background</constant>.
60+
</simpara>
61+
</listitem>
62+
</varlistentry>
63+
<varlistentry>
64+
<term><constant>Pcntl\QosClass::Utility</constant></term>
65+
<listitem>
66+
<simpara>
67+
Lower priority, intended for long-running work the user is aware of
68+
but not actively waiting on, such as downloads, imports, or bulk
69+
computation. Scheduled in an energy-efficient manner.
70+
</simpara>
71+
</listitem>
72+
</varlistentry>
73+
<varlistentry>
74+
<term><constant>Pcntl\QosClass::Background</constant></term>
75+
<listitem>
76+
<simpara>
77+
Lowest priority, intended for work the user is not aware of, such as
78+
prefetching, indexing, or maintenance. Heavily optimized for energy
79+
efficiency and may be deferred when the system is under load.
80+
</simpara>
81+
</listitem>
82+
</varlistentry>
83+
</variablelist>
8684
</listitem>
8785
</varlistentry>
8886
</variablelist>
@@ -101,7 +99,7 @@
10199
<refsect1 role="errors">
102100
&reftitle.errors;
103101
<simpara>
104-
Throws an <classname>Error</classname> if the underlying call to
102+
Throws an <exceptionname>Error</exceptionname> if the underlying call to
105103
<literal>pthread_set_qos_class_self_np()</literal> fails.
106104
</simpara>
107105
</refsect1>

0 commit comments

Comments
 (0)