Skip to content

Commit

Permalink
doc: Use gendoc for limits.kernel
Browse files Browse the repository at this point in the history
Signed-off-by: Stéphane Graber <stgraber@stgraber.org>
  • Loading branch information
stgraber committed May 6, 2024
1 parent 21955b4 commit 3a834cf
Showing 1 changed file with 5 additions and 14 deletions.
19 changes: 5 additions & 14 deletions doc/reference/instance_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,20 +183,11 @@ This allows users to specify any supported limit on their system.

Some common limits are:

Key | Resource | Description
:-- | :--- | :----------
`limits.kernel.as` | `RLIMIT_AS` | Maximum size of the process's virtual memory
`limits.kernel.core` | `RLIMIT_CORE` | Maximum size of the process's core dump file
`limits.kernel.cpu` | `RLIMIT_CPU` | Limit in seconds on the amount of CPU time the process can consume
`limits.kernel.data` | `RLIMIT_DATA` | Maximum size of the process's data segment
`limits.kernel.fsize` | `RLIMIT_FSIZE` | Maximum size of files the process may create
`limits.kernel.locks` | `RLIMIT_LOCKS` | Limit on the number of file locks that this process may establish
`limits.kernel.memlock` | `RLIMIT_MEMLOCK` | Limit on the number of bytes of memory that the process may lock in RAM
`limits.kernel.nice` | `RLIMIT_NICE` | Maximum value to which the process's nice value can be raised
`limits.kernel.nofile` | `RLIMIT_NOFILE` | Maximum number of open files for the process
`limits.kernel.nproc` | `RLIMIT_NPROC` | Maximum number of processes that can be created for the user of the calling process
`limits.kernel.rtprio` | `RLIMIT_RTPRIO` | Maximum value on the real-time-priority that may be set for this process
`limits.kernel.sigpending`| `RLIMIT_SIGPENDING` | Maximum number of signals that may be queued for the user of the calling process
% Include content from [../config_options.txt](../config_options.txt)
```{include} ../config_options.txt
:start-after: <!-- config group kernel-limits start -->
:end-before: <!-- config group kernel-limits end -->
```

A full list of all available limits can be found in the manpages for the `getrlimit(2)`/`setrlimit(2)` system calls.

Expand Down

0 comments on commit 3a834cf

Please sign in to comment.