Skip to content

Commit 4472dfc

Browse files
pcntl QoS ドキュメント重複の解消に追従し、reflection を同期(2モジュール完訳) (php#403)
* pcntl: QoS 関数ドキュメントの重複解消に追従(ハイフン版を翻訳・アンダースコア版を削除) doc-en PR #5609 (28192e830f) が pcntl_getqos_class / pcntl_setqos_class の ドキュメント重複(xml:id 同一の2組共存)を解消し、ハイフン名ファイルに統合・ アンダースコア名版を削除した。これに追従する。 - pcntl-getqos-class.xml / pcntl-setqos-class.xml を新規翻訳 (既存のアンダースコア版訳を土台に、統合後の正式版との差分のみ反映) - doc-en で対応の消えたアンダースコア版 pcntl_getqos_class.xml / pcntl_setqos_class.xml を削除 pcntl モジュールが完訳になる。 * reflection: hasreturntype.xml を doc-en と同期(古くなった段落の削除に追従) doc-en PR #5610 (c3485c8f1c) で、ビルトイン関数での利用に関する古い段落が 削除されたことに追従する。 reflection モジュールが完訳になる。
1 parent f727c85 commit 4472dfc

4 files changed

Lines changed: 149 additions & 153 deletions

File tree

reference/pcntl/functions/pcntl_getqos_class.xml renamed to reference/pcntl/functions/pcntl-getqos-class.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 30b0c51175bb9bc5a329d7924b0ca5eff1f1f9ad Maintainer: KentarouTakeda Status: ready -->
3+
<!-- EN-Revision: 28192e830f2c204570cc140c24341d07807df8bc Maintainer: KentarouTakeda Status: ready -->
44
<refentry xml:id="function.pcntl-getqos-class" xmlns="http://docbook.org/ns/docbook">
55
<refnamediv>
66
<refname>pcntl_getqos_class</refname>
@@ -14,7 +14,7 @@
1414
<void/>
1515
</methodsynopsis>
1616
<simpara>
17-
QoS クラスを取得します。
17+
現在のスレッドの Quality of Service (<acronym>QoS</acronym>) クラスを取得します。
1818
</simpara>
1919
<note>
2020
<simpara>この関数は、Apple のプラットフォームでのみ利用可能です。</simpara>
@@ -29,15 +29,16 @@
2929
<refsect1 role="returnvalues">
3030
&reftitle.returnvalues;
3131
<simpara>
32-
<enumname>Pcntl\QosClass</enumname> を返します。
32+
現在の <acronym>QoS</acronym> クラスを
33+
<enumname>Pcntl\QosClass</enumname> として返します。
3334
</simpara>
3435
</refsect1>
3536

3637
<refsect1 role="errors">
3738
&reftitle.errors;
3839
<simpara>
3940
内部の <literal>pthread_get_qos_class_np()</literal> の呼び出しが失敗した場合、
40-
<classname>Error</classname> をスローします。
41+
<exceptionname>Error</exceptionname> をスローします。
4142
</simpara>
4243
</refsect1>
4344

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
<!-- EN-Revision: 28192e830f2c204570cc140c24341d07807df8bc Maintainer: KentarouTakeda Status: ready -->
4+
<refentry xml:id="function.pcntl-setqos-class" xmlns="http://docbook.org/ns/docbook">
5+
<refnamediv>
6+
<refname>pcntl_setqos_class</refname>
7+
<refpurpose>現在のスレッドの QoS クラスを設定する</refpurpose>
8+
</refnamediv>
9+
10+
<refsect1 role="description">
11+
&reftitle.description;
12+
<methodsynopsis>
13+
<type>void</type><methodname>pcntl_setqos_class</methodname>
14+
<methodparam choice="opt"><type>Pcntl\QosClass</type><parameter>qos_class</parameter><initializer><constant>Pcntl\QosClass::Default</constant></initializer></methodparam>
15+
</methodsynopsis>
16+
<simpara>
17+
現在のスレッドの Quality of Service (<acronym>QoS</acronym>) クラスを設定します。
18+
</simpara>
19+
</refsect1>
20+
21+
<refsect1 role="parameters">
22+
&reftitle.parameters;
23+
<variablelist>
24+
<varlistentry>
25+
<term><parameter>qos_class</parameter></term>
26+
<listitem>
27+
<simpara>
28+
現在のスレッドに割り当てる Quality of Service クラス。
29+
オペレーティングシステムは、これを CPU 時間の割り当て、
30+
I/O 優先度、電力消費をスケジューリングする際のヒントとして使用し、
31+
上位のクラスは下位のクラスに割り込んで実行されます。
32+
利用可能なケースについては、<enumname>Pcntl\QosClass</enumname>
33+
を参照してください。
34+
</simpara>
35+
<variablelist>
36+
<varlistentry>
37+
<term><constant>Pcntl\QosClass::UserInteractive</constant></term>
38+
<listitem>
39+
<simpara>
40+
最も高い優先度です。ユーザーインターフェイスを直接駆動する処理向けで、
41+
イベント処理や描画など、体感的な遅延を避けるために
42+
ほぼ瞬時に完了する必要があるものを想定しています。
43+
</simpara>
44+
</listitem>
45+
</varlistentry>
46+
<varlistentry>
47+
<term><constant>Pcntl\QosClass::UserInitiated</constant></term>
48+
<listitem>
49+
<simpara>
50+
高い優先度で、<constant>UserInteractive</constant> のすぐ下です。
51+
ユーザーが明示的に開始し、結果を待っている処理向けで、
52+
数秒以内に完了することが期待されるものを想定しています。
53+
</simpara>
54+
</listitem>
55+
</varlistentry>
56+
<varlistentry>
57+
<term><constant>Pcntl\QosClass::Default</constant></term>
58+
<listitem>
59+
<simpara>
60+
標準の優先度で、より具体的なクラスが該当しない場合に使用します。
61+
より優先度の高い処理の後に実行されますが、
62+
<constant>Utility</constant> や <constant>Background</constant>
63+
よりは先に実行されます。
64+
</simpara>
65+
</listitem>
66+
</varlistentry>
67+
<varlistentry>
68+
<term><constant>Pcntl\QosClass::Utility</constant></term>
69+
<listitem>
70+
<simpara>
71+
低めの優先度です。ダウンロード、インポート、
72+
一括計算など、ユーザーは認識しているものの、
73+
結果を待ってはいない長時間の処理向けです。
74+
省電力なスケジューリングが行われます。
75+
</simpara>
76+
</listitem>
77+
</varlistentry>
78+
<varlistentry>
79+
<term><constant>Pcntl\QosClass::Background</constant></term>
80+
<listitem>
81+
<simpara>
82+
最も低い優先度です。プリフェッチ、インデックス作成、
83+
メンテナンスなど、ユーザーが認識していない処理向けです。
84+
電力効率を強く重視して最適化されており、
85+
システムが高負荷の場合は実行が後回しにされる可能性があります。
86+
</simpara>
87+
</listitem>
88+
</varlistentry>
89+
</variablelist>
90+
</listitem>
91+
</varlistentry>
92+
</variablelist>
93+
<note>
94+
<simpara>この関数は、Apple のプラットフォームでのみ利用可能です。</simpara>
95+
</note>
96+
</refsect1>
97+
98+
<refsect1 role="returnvalues">
99+
&reftitle.returnvalues;
100+
<simpara>
101+
&return.void;
102+
</simpara>
103+
</refsect1>
104+
105+
<refsect1 role="errors">
106+
&reftitle.errors;
107+
<simpara>
108+
内部の <literal>pthread_set_qos_class_self_np()</literal> の呼び出しが失敗した場合、
109+
<exceptionname>Error</exceptionname> をスローします。
110+
</simpara>
111+
</refsect1>
112+
113+
<refsect1 role="seealso">
114+
&reftitle.seealso;
115+
<simplelist>
116+
<member><function>pcntl_getqos_class</function></member>
117+
<member><enumname>Pcntl\QosClass</enumname></member>
118+
</simplelist>
119+
</refsect1>
120+
121+
</refentry>
122+
<!-- Keep this comment at the end of the file
123+
Local variables:
124+
mode: sgml
125+
sgml-omittag:t
126+
sgml-shorttag:t
127+
sgml-minimize-attributes:nil
128+
sgml-always-quote-attributes:t
129+
sgml-indent-step:1
130+
sgml-indent-data:t
131+
indent-tabs-mode:nil
132+
sgml-parent-document:nil
133+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
134+
sgml-exposed-tags:nil
135+
sgml-local-catalogs:nil
136+
sgml-local-ecat-files:nil
137+
End:
138+
vim600: syn=xml fen fdm=syntax fdl=2 si
139+
vim: et tw=78 syn=sgml
140+
vi: ts=1 sw=1
141+
-->

reference/pcntl/functions/pcntl_setqos_class.xml

Lines changed: 0 additions & 143 deletions
This file was deleted.

reference/reflection/reflectionfunctionabstract/hasreturntype.xml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: ec2fe9a592f794978114ef5021db9f1d00c2e05d Maintainer: mumumu Status: ready -->
3+
<!-- EN-Revision: c3485c8f1c57caa8ea0fc2924050a175bbc7686d Maintainer: mumumu Status: ready -->
44

55
<refentry xml:id="reflectionfunctionabstract.hasreturntype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
66
<refnamediv>
@@ -41,7 +41,8 @@
4141
<![CDATA[
4242
<?php
4343
44-
function to_int($param) : int {
44+
function to_int($param): int
45+
{
4546
return (int) $param;
4647
}
4748
@@ -76,10 +77,6 @@ bool(false)
7677
</screen>
7778
</example>
7879
</para>
79-
<para>
80-
こうなるのは、たくさんの内部関数が引数や戻り値に型を指定していないからです。
81-
よって、このメソッドはビルトイン関数に使わないのが最適です。
82-
</para>
8380
</refsect1>
8481

8582
<refsect1 role="seealso">

0 commit comments

Comments
 (0)