Verified Commit 7abc6194 authored by Karel Koci's avatar Karel Koci 🤘

Fix documentation formating for subprocess

parent 1b5519c7
......@@ -89,29 +89,29 @@ cleanup_unregister_handle(index)::
Subprocesses
------------
Family of functions ``subproc*`` defined in ``subprocess.h`` are exported to lua
Family of functions `subproc*` defined in `subprocess.h` are exported to lua
in form of functions `subprocess`.
Function `subprocess` is defined as follows:
`subprocess(type, message, timeout, callback, command ...)`
`type` is identification used to specify what type of subprocess it's. Allowed
* `type` is identification used to specify what type of subprocess it's. Allowed
predefined constants are as follows:
-- `LST_PKG_SCRIPT` Any script provided by package (pre/post inst/rm)
-- `LST_HOOK` Hook script executed on some updater state
- `LST_PKG_SCRIPT` Any script provided by package (pre/post inst/rm)
- `LST_HOOK` Hook script executed on some updater state
`message` is string describing what this subprocess is to user. It's human
* `message` is string describing what this subprocess is to user. It's human
readable description of executed command.
`timeout` is time in seconds after which subprocess will be automatically
* `timeout` is time in seconds after which subprocess will be automatically
killed.
`callback` is optional function that would be called in subprocess just before
it executes given command. If you don't want to specify it then you can pass nil
or you can just drop it out (in that case command is expeted on this argument
place). This functions should has no arguments and shouldn't return anything.
* `callback` is optional function that would be called in subprocess just before
It executes given command. If you don't want to specify it then you can pass nil
Or you can just drop it out (in that case command is expeted on this argument
Place). This functions should has no arguments and shouldn't return anything.
`command` is any arbitrary number of string arguments that are passed as command
* `command` is any arbitrary number of string arguments that are passed as command
and its additional arguments.
This function returns exit code of executed subprocess as first argument. And
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment