1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-23 22:52:11 +01:00

shmop: fix XML by converting para to simpara tags via script

This commit is contained in:
Gina Peter Banyard
2026-01-26 15:34:24 +00:00
parent 6356587589
commit ee44826803
9 changed files with 88 additions and 94 deletions

View File

@@ -1,19 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 46a9cdd2dbef4ec89bf65fad9930e2feb78bbb98 Maintainer: takagi Status: ready -->
<!-- EN-Revision: 41d34439ea8cae2bb1204264c1bce15d88284503 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa -->
<book xml:id="book.shmop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.shmop">
<?phpdoc extension-membership="bundled" ?>
<title>共有メモリ</title>
<!-- {{{ preface -->
<preface xml:id="intro.shmop">
&reftitle.intro;
<para>
<simpara>
shmop は、共有メモリセグメントを PHP から簡単に読み書きまたは作成、
削除することを可能にする一連の関数です。
</para>
</simpara>
</preface>
<!-- }}} -->
@@ -23,7 +22,6 @@
&reference.shmop.shmop;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -44,4 +42,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -1,15 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: hirokawa Status: ready -->
<section xml:id="shmop.installation" xmlns="http://docbook.org/ns/docbook">
<!-- EN-Revision: 41d34439ea8cae2bb1204264c1bce15d88284503 Maintainer: hirokawa Status: ready -->
<section xmlns="http://docbook.org/ns/docbook" xml:id="shmop.installation">
&reftitle.install;
<para>
shmop を使用するには、<option
role="configure">--enable-shmop</option>パラメータを configure に
<simpara>
shmop を使用するには、<option role="configure">--enable-shmop</option>パラメータを configure に
指定して PHP をコンパイルする必要があります。
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -30,4 +28,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6ce09e40979a5cd7ee87a4799cbaf1d8d17a3dc1 Maintainer: mumumu Status: ready -->
<!-- EN-Revision: 41d34439ea8cae2bb1204264c1bce15d88284503 Maintainer: mumumu Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-close">
<refnamediv>
<refname>shmop_close</refname>
@@ -19,9 +19,9 @@
<methodparam><type>Shmop</type><parameter>shmop</parameter></methodparam>
</methodsynopsis>
&note.resource-migration-8.0-dead-function;
<para>
<simpara>
<function>shmop_close</function> は、共有メモリブロックを閉じます。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -29,18 +29,18 @@
<varlistentry>
<term><parameter>shmop</parameter></term>
<listitem>
<para>
<simpara>
<function>shmop_open</function> 関数で作られた共有メモリブロックのリソース。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">
@@ -86,9 +86,9 @@ shmop_close($shm_id);
]]>
</programlisting>
</example>
<para>
<simpara>
この例は、<literal>$shm_id</literal> で識別される共有メモリブロックを閉じます。
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6ce09e40979a5cd7ee87a4799cbaf1d8d17a3dc1 Maintainer: mumumu Status: ready -->
<!-- EN-Revision: 41d34439ea8cae2bb1204264c1bce15d88284503 Maintainer: mumumu Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-delete">
<refnamediv>
<refname>shmop_delete</refname>
@@ -12,9 +12,9 @@
<type>bool</type><methodname>shmop_delete</methodname>
<methodparam><type>Shmop</type><parameter>shmop</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>shmop_delete</function> は、共有メモリブロックを削除ます。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -22,18 +22,18 @@
<varlistentry>
<term><parameter>shmop</parameter></term>
<listitem>
<para>
<simpara>
<function>shmop_open</function> で作られた共有メモリブロックのリソース
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">
@@ -72,9 +72,9 @@ shmop_delete($shm_id);
]]>
</programlisting>
</example>
<para>
<simpara>
この例は、<literal>$shm_id</literal> で識別された共有メモリブロックを削除します。
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6ce09e40979a5cd7ee87a4799cbaf1d8d17a3dc1 Maintainer: hirokawa Status: ready -->
<!-- EN-Revision: 41d34439ea8cae2bb1204264c1bce15d88284503 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-open">
<refnamediv>
@@ -16,10 +16,10 @@
<methodparam><type>int</type><parameter>permissions</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>shmop_open</function> は共有メモリブロックを作成または
オープンします。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -28,10 +28,10 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
共有メモリブロックのシステム ID であり、10 進数または
16 進数で指定することが可能です。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -78,48 +78,48 @@
<varlistentry>
<term><parameter>permissions</parameter></term>
<listitem>
<para>
<simpara>
共有メモリセグメントに設定したい
許可属性で、ファイルに関する許可属性と同様なものです。許可属性は、
例えば <literal>0644</literal> のような 8 進数形式で渡す必要があります。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
<simpara>
作成したい共有メモリブロックの大きさをバイト数で指定します。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
<note>
<para>
<simpara>
注意: 既存のメモリセグメントをオープンする場合には、3 番目および
4 番目の引数には 0 を指定する必要があります。
</para>
</simpara>
</note>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
成功した場合は、<function>shmop_open</function>
作成した共有メモリセグメントにアクセスするために使用する
<classname>Shmop</classname> クラスのインスタンスを返します。
失敗した場合に &false; を返します。
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
<parameter>mode</parameter> が不正な値だったり、
<parameter>size</parameter> が 0 以下の値の場合、
<classname>ValueError</classname> がスローされます。
それ以外の場合で、処理に失敗した場合は <constant>E_WARNING</constant> が発生します。
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">
@@ -168,10 +168,10 @@ $shm_id = shmop_open($shm_key, "c", 0644, 100);
]]>
</programlisting>
</example>
<para>
<simpara>
この例は、<function>ftok</function> が返すシステム ID
の共有メモリブロックをオープンします。
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6ce09e40979a5cd7ee87a4799cbaf1d8d17a3dc1 Maintainer: mumumu Status: ready -->
<!-- EN-Revision: 41d34439ea8cae2bb1204264c1bce15d88284503 Maintainer: mumumu Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-read">
<refnamediv>
<refname>shmop_read</refname>
@@ -14,9 +14,9 @@
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>shmop_read</function> は、共有メモリブロックから文字列を読み取ります。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -24,46 +24,46 @@
<varlistentry>
<term><parameter>shmop</parameter></term>
<listitem>
<para>
<simpara>
<function>shmop_open</function> 関数で作られた、共有メモリブロックの識別子。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
<simpara>
読み取りを始めるオフセット。
この値は 0 以上、かつ共有メモリセグメントの実際のサイズ以下でなければいけません。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
<simpara>
読み取るバイト数。
この値は 0 以上、かつ <parameter>offset</parameter><parameter>size</parameter>
の合計値が、共有メモリセグメントの実際のサイズ以下でなければいけません。
<literal>0</literal> を指定すると、<code>shmop_size($shmid) - $start</code> バイトを読み取ります。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
読み取ったデータを返します。
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
<parameter>offset</parameter><parameter>size</parameter> が範囲外の値の場合、
<classname>ValueError</classname> がスローされます。
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">
@@ -111,10 +111,10 @@ $shm_data = shmop_read($shm_id, 0, 50);
]]>
</programlisting>
</example>
<para>
<simpara>
この例は、共有メモリブロックから50バイトを読み取り、
データを <literal>$shm_data</literal> に格納します。
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6ce09e40979a5cd7ee87a4799cbaf1d8d17a3dc1 Maintainer: mumumu Status: ready -->
<!-- EN-Revision: 41d34439ea8cae2bb1204264c1bce15d88284503 Maintainer: mumumu Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-size">
<refnamediv>
<refname>shmop_size</refname>
@@ -12,9 +12,9 @@
<type>int</type><methodname>shmop_size</methodname>
<methodparam><type>Shmop</type><parameter>shmop</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>shmop_size</function> は、共有メモリブロックのサイズをバイト単位で取得します。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -22,18 +22,18 @@
<varlistentry>
<term><parameter>shmop</parameter></term>
<listitem>
<para>
<simpara>
<function>shmop_open</function> 関数で作られた、共有メモリブロックの識別子。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
共有メモリブロックが専有している大きさをバイト単位で返します。
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">
@@ -72,10 +72,10 @@ $shm_size = shmop_size($shm_id);
]]>
</programlisting>
</example>
<para>
<simpara>
この例は、<literal>$shm_id</literal> で識別される共有メモリブロックのサイズを
<literal>$shm_size</literal> に代入しています。
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6ce09e40979a5cd7ee87a4799cbaf1d8d17a3dc1 Maintainer: mumumu Status: ready -->
<!-- EN-Revision: 41d34439ea8cae2bb1204264c1bce15d88284503 Maintainer: mumumu Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-write">
<refnamediv>
<refname>shmop_write</refname>
@@ -14,9 +14,9 @@
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>shmop_write</function> は、共有メモリブロックに文字列を書き込みます。
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -24,44 +24,44 @@
<varlistentry>
<term><parameter>shmop</parameter></term>
<listitem>
<para>
<simpara>
<function>shmop_open</function> で作られた共有メモリブロックの識別子。
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
共有メモリブロックに書き込む文字列
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
<simpara>
共有メモリセグメント内部のどこから、データを書き始めるかを指定します。
この値は 0 以上、かつ共有メモリセグメントの実際のサイズ以下でなければいけません。
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
書き込んだ <parameter>data</parameter> のサイズを返します。
</para>
</simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<simpara>
<parameter>offset</parameter> が範囲外の値の場合、
または読み取り専用の共有メモリセグメントに書き込んだ場合、
<classname>ValueError</classname> がスローされます。
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">
@@ -107,10 +107,10 @@ $shm_bytes_written = shmop_write($shm_id, $my_string, 0);
]]>
</programlisting>
</example>
<para>
<simpara>
この例は、<literal>$my_string</literal> にあるデータを共有メモリブロックに書き込みます。
<literal>$shm_bytes_written</literal> には、書かれたデータのバイト数が入ります。
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14767af0f05dffa6fdb9b49e1a1f4e9ca7022a60 Maintainer: mumumu Status: ready -->
<reference xml:id="class.shmop" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<!-- EN-Revision: 41d34439ea8cae2bb1204264c1bce15d88284503 Maintainer: mumumu Status: ready -->
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.shmop" role="class">
<title>Shmop クラス</title>
<titleabbrev>Shmop</titleabbrev>
@@ -11,10 +11,10 @@
<!-- {{{ Shmop intro -->
<section xml:id="shmop.intro">
&reftitle.intro;
<para>
<simpara>
PHP 8.0.0 以降、
<literal>shmop</literal> リソースを置き換える完全不透明クラスです。
</para>
</simpara>
</section>
<!-- }}} -->