Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions reference/shmop/book.xml
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<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>Shared Memory</title>

<!-- {{{ preface -->
<preface xml:id="intro.shmop">
&reftitle.intro;
<para>
<simpara>
Shmop is an easy to use set of functions that allows PHP to read,
write, create and delete Unix shared memory segments.
</para>
</simpara>
</preface>
<!-- }}} -->

Expand All @@ -21,7 +20,6 @@
&reference.shmop.shmop;

</book>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand All @@ -42,4 +40,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

8 changes: 3 additions & 5 deletions reference/shmop/configure.xml
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="shmop.installation" xmlns="http://docbook.org/ns/docbook">
<section xmlns="http://docbook.org/ns/docbook" xml:id="shmop.installation">
&reftitle.install;
<para>
<simpara>
To use shmop you will need to compile PHP with the
<option role="configure">--enable-shmop</option> parameter in your
configure line.
</para>
</simpara>
</section>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand All @@ -29,4 +28,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

21 changes: 8 additions & 13 deletions reference/shmop/examples.xml
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<chapter xml:id="shmop.examples" xmlns="http://docbook.org/ns/docbook">
<chapter xmlns="http://docbook.org/ns/docbook" xml:id="shmop.examples">
&reftitle.examples;
<section xml:id="shmop.examples-basic">
<title>Basic usage</title>
<para>
<example>
<title>Shared Memory Operations Overview</title>
<programlisting role="php">
<example>
<title>Shared Memory Operations Overview</title>
<programlisting role="php">
<![CDATA[
<?php

// Create 100 byte shared memory block with system id of 0xff3
$shm_id = shmop_open(0xff3, "c", 0644, 100);
if (!$shm_id) {
Expand Down Expand Up @@ -40,15 +38,13 @@ if (!shmop_delete($shm_id)) {
echo "Couldn't mark shared memory block for deletion.";
}
shmop_close($shm_id);

?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</section>
</chapter>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand All @@ -69,4 +65,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

58 changes: 26 additions & 32 deletions reference/shmop/functions/shmop-close.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.shmop-close" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-close">
<refnamediv>
<refname>shmop_close</refname>
<refpurpose>Close shared memory block</refpurpose>
Expand All @@ -18,31 +18,29 @@
<methodparam><type>Shmop</type><parameter>shmop</parameter></methodparam>
</methodsynopsis>
&note.resource-migration-8.0-dead-function;
<para>
<simpara>
<function>shmop_close</function> is used to close a shared memory block.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>shmop</parameter></term>
<listitem>
<para>
The shared memory block resource created by
<function>shmop_open</function>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>shmop</parameter></term>
<listitem>
<simpara>
The shared memory block resource created by
<function>shmop_open</function>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>

<refsect1 role="changelog">
Expand Down Expand Up @@ -76,29 +74,25 @@

<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Closing shared memory block</title>
<programlisting role="php">
<example>
<title>Closing shared memory block</title>
<programlisting role="php">
<![CDATA[
<?php
shmop_close($shm_id);
?>
]]>
</programlisting>
</example>
</para>
<para>
</programlisting>
</example>
<simpara>
This example will close shared memory block identified by <literal>$shm_id</literal>.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>shmop_open</function></member>
</simplelist>
</para>
<simplelist>
<member><function>shmop_open</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Expand Down
50 changes: 23 additions & 27 deletions reference/shmop/functions/shmop-delete.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.shmop-delete" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-delete">
<refnamediv>
<refname>shmop_delete</refname>
<refpurpose>Delete shared memory block</refpurpose>
Expand All @@ -11,31 +11,29 @@
<type>bool</type><methodname>shmop_delete</methodname>
<methodparam><type>Shmop</type><parameter>shmop</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>shmop_delete</function> is used to delete a shared memory block.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>shmop</parameter></term>
<listitem>
<para>
The shared memory block resource created by
<function>shmop_open</function>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>shmop</parameter></term>
<listitem>
<simpara>
The shared memory block resource created by
<function>shmop_open</function>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>

<refsect1 role="changelog">
Expand Down Expand Up @@ -63,22 +61,20 @@

<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Deleting shared memory block</title>
<programlisting role="php">
<example>
<title>Deleting shared memory block</title>
<programlisting role="php">
<![CDATA[
<?php
shmop_delete($shm_id);
?>
]]>
</programlisting>
</example>
</para>
<para>
</programlisting>
</example>
<simpara>
This example will delete shared memory block identified by
<literal>$shm_id</literal>.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Expand Down
Loading