Skip to content

Updades description of the popen module #5117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: latest
Choose a base branch
from
+98 −52
Open

Updades description of the popen module #5117

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
608ffb3
Updades description of the popen module
AArdeev May 19, 2025
97d83fc
Updates datatype for popen handle objet in parameters
AArdeev May 19, 2025
dc3ddfd
Updates ``popen.rst`` structure of headings by comments
AArdeev May 19, 2025
3078414
Changes table names to headings in the Overview
AArdeev May 19, 2025
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
119 changes: 77 additions & 42 deletions doc/reference/reference_lua/popen.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ object:
syscall
* :ref:`popen.new <popen-new>` to create a popen object with more specific options

Below is a list of all ``popen`` functions and handle methods.
Below are tables with summaries of ``popen`` constructors, constants, mrthods, and fields.
Copy link
Contributor

@Totktonada Totktonada May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: mrthods.


Popen module constructors:

.. container:: table

Expand All @@ -46,6 +48,31 @@ Below is a list of all ``popen`` functions and handle methods.
| :ref:`popen.new() | Execute a child program in |
| <popen-new>` | a new process |
+--------------------------------------+---------------------------------+

Popen module constants:

.. container:: table

.. rst-class:: left-align-column-1
.. rst-class:: left-align-column-2

+--------------------------------------+---------------------------------+
| Name | Use |
+======================================+=================================+
| :ref:`Module constants | Module constants |
| <popen-constants>` | |
+--------------------------------------+---------------------------------+

Popen handle methods:

.. container:: table

.. rst-class:: left-align-column-1
.. rst-class:: left-align-column-2

+--------------------------------------+---------------------------------+
| Name | Use |
+======================================+=================================+
| :ref:`popen_handle:read() | Read data from a child peer |
| <popen-read>` | |
+--------------------------------------+---------------------------------+
Expand Down Expand Up @@ -73,16 +100,24 @@ Below is a list of all ``popen`` functions and handle methods.
| :ref:`popen_handle:close() | Close a popen handle |
| <popen-close>` | |
+--------------------------------------+---------------------------------+
| :ref:`Module constants | Module constants |
| <popen-constants>` | |

Popen handle fields:

.. container:: table

.. rst-class:: left-align-column-1
.. rst-class:: left-align-column-2

+--------------------------------------+---------------------------------+
| Name | Use |
+======================================+=================================+
| :ref:`Handle fields | Handle fields |
| <popen-handle_fields>` | |
+--------------------------------------+---------------------------------+

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
popen module constructors
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
===============================================================================
popen module constructors
===============================================================================

.. _popen-shell:

Expand Down Expand Up @@ -377,9 +412,39 @@ Below is a list of all ``popen`` functions and handle methods.
return table.concat(chunks):rstrip()
end

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
popen handle methods
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
===============================================================================
popen module constants
===============================================================================

.. _popen-constants:

**Module constants**

.. code-block:: none

- popen.opts
- INHERIT (== 'inherit')
- DEVNULL (== 'devnull')
- CLOSE (== 'close')
- PIPE (== 'pipe')

- popen.signal
- SIGTERM (== 9)
- SIGKILL (== 15)
- ...

- popen.state
- ALIVE (== 'alive')
- EXITED (== 'exited')
- SIGNALED (== 'signaled')

- popen.stream
- OPEN (== 'open')
- CLOSED (== 'closed')

===============================================================================
popen handle methods
===============================================================================

.. class:: popen_handle

Expand Down Expand Up @@ -830,9 +895,9 @@ Below is a list of all ``popen`` functions and handle methods.
means success for a caller. The return values are purely
informational: they are for logging or some kind of reporting.

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
popen handle fields
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
===============================================================================
popen handle fields
===============================================================================

.. _popen-handle_fields:

Expand All @@ -849,33 +914,3 @@ Below is a list of all ``popen`` functions and handle methods.
popen_handle.stderr

See :ref:`popen_handle:info() <popen-info>` for details.

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
popen module constants
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. _popen-constants:

**Module constants**

.. code-block:: none

- popen.opts
- INHERIT (== 'inherit')
- DEVNULL (== 'devnull')
- CLOSE (== 'close')
- PIPE (== 'pipe')

- popen.signal
- SIGTERM (== 9)
- SIGKILL (== 15)
- ...

- popen.state
- ALIVE (== 'alive')
- EXITED (== 'exited')
- SIGNALED (== 'signaled')

- popen.stream
- OPEN (== 'open')
- CLOSED (== 'closed')