[doc-en] master: Document Error thrown by shm_* functions on a detached segment (#5975)

Author: qodelicious (qodelicious) Committer: GitHub (web-flow) Pusher: lacatoire Date: 2026-10-20T12:21:00+02:00 Commit: https://github.com/php/doc-en/commit/589b2024573a14b6a4d286e5ec9aad614b36c6fa Raw diff: https://github.com/php/doc-en/commit/589b2024573a14b6a4d286e5ec9aad614b36c6fa.diff Document Error thrown by shm_* functions on a detached segment (#5975) * Document Error thrown by shm_* functions on a detached segment * Move the detached segment error sentence into an entity Changed paths: A reference/sem/entities.ent M reference/sem/functions/shm-detach.xml M reference/sem/functions/shm-get-var.xml M reference/sem/functions/shm-has-var.xml M reference/sem/functions/shm-put-var.xml M reference/sem/functions/shm-remove-var.xml M reference/sem/functions/shm-remove.xml Diff: diff --git a/reference/sem/entities.ent b/reference/sem/entities.ent new file mode 100644 index 000000000000..0ce12fecb92d --- /dev/null +++ b/reference/sem/entities.ent @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision$ --> +<!-- + See manual.xml for XML namespaces defaults. + Keep the lines under 79 columns, to make the process of manual + translation easier, and to avoid wrap-around in some other contexts. +--> +<entities xmlns = "http://docbook.org/ns/docbook" + xmlns:xlink = "http://www.w3.org/1999/xlink" + translate = "yes"> + +<entity name="ext.sem.shm-detached-error"> + <simpara> + Throws an <exceptionname>Error</exceptionname> if <parameter>shm</parameter> + has already been detached with <function>shm_detach</function>. + </simpara> +</entity> + +</entities> diff --git a/reference/sem/functions/shm-detach.xml b/reference/sem/functions/shm-detach.xml index 677cd1ddef58..b5724cc999e5 100644 --- a/reference/sem/functions/shm-detach.xml +++ b/reference/sem/functions/shm-detach.xml @@ -41,6 +41,11 @@ </simpara> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.sem.shm-detached-error; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> diff --git a/reference/sem/functions/shm-get-var.xml b/reference/sem/functions/shm-get-var.xml index 4256c03fe7fa..03f3d301b52a 100644 --- a/reference/sem/functions/shm-get-var.xml +++ b/reference/sem/functions/shm-get-var.xml @@ -46,9 +46,16 @@ &reftitle.returnvalues; <simpara> Returns the variable with the given key. + If the key does not exist, an <constant>E_WARNING</constant> is raised + and &false; is returned. </simpara> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.sem.shm-detached-error; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> diff --git a/reference/sem/functions/shm-has-var.xml b/reference/sem/functions/shm-has-var.xml index 5843b41c2796..afe836671d9b 100644 --- a/reference/sem/functions/shm-has-var.xml +++ b/reference/sem/functions/shm-has-var.xml @@ -47,6 +47,11 @@ </simpara> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.sem.shm-detached-error; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> diff --git a/reference/sem/functions/shm-put-var.xml b/reference/sem/functions/shm-put-var.xml index b404df75f6c9..833893e83de6 100644 --- a/reference/sem/functions/shm-put-var.xml +++ b/reference/sem/functions/shm-put-var.xml @@ -67,6 +67,11 @@ </simpara> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.sem.shm-detached-error; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> diff --git a/reference/sem/functions/shm-remove-var.xml b/reference/sem/functions/shm-remove-var.xml index 2fca1fb97b62..f07ef0a067a6 100644 --- a/reference/sem/functions/shm-remove-var.xml +++ b/reference/sem/functions/shm-remove-var.xml @@ -49,6 +49,11 @@ </simpara> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.sem.shm-detached-error; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> diff --git a/reference/sem/functions/shm-remove.xml b/reference/sem/functions/shm-remove.xml index f12fd5bfe172..cb77c8bbcd05 100644 --- a/reference/sem/functions/shm-remove.xml +++ b/reference/sem/functions/shm-remove.xml @@ -39,6 +39,11 @@ </simpara> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.sem.shm-detached-error; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable>