diff options
| author | Emily <vcs@emily.moe> | 2023-06-22 09:05:03 +0100 |
|---|---|---|
| committer | Emily <vcs@emily.moe> | 2023-06-24 10:48:55 +0100 |
| commit | efe314cdbabaf5cd210d9c658b4ad540437b7ee5 (patch) | |
| tree | 8b00b1c0518922b71311ba2e0c448d6b3e5340d8 /modules/launchd/launchd.nix | |
| parent | c2716817a8e5fb47889aaf625aa13b89d786da51 (diff) | |
treewide: manually convert some docs to Markdown
These all use DocBook markup too complex for `nix-doc-munge` to handle,
have syntax that clashes with Markdown, or already contain Markdown
syntax that currently isn't rendering correctly.
Converting DocBook list syntax makes me think that maybe Markdown
isn't so bad after all.
Diffstat (limited to 'modules/launchd/launchd.nix')
| -rw-r--r-- | modules/launchd/launchd.nix | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/modules/launchd/launchd.nix b/modules/launchd/launchd.nix index 727db95..61a78d9 100644 --- a/modules/launchd/launchd.nix +++ b/modules/launchd/launchd.nix @@ -633,27 +633,27 @@ with lib; type = types.nullOr (types.enum [ "Background" "Standard" "Adaptive" "Interactive" ]); default = null; example = "Background"; - description = '' + description = lib.mdDoc '' This optional key describes, at a high level, the intended purpose of the job. The system will apply resource limits based on what kind of job it is. If left unspecified, the system will apply light resource limits to the job, throttling its CPU usage and I/O bandwidth. The following are valid values: - Background - Background jobs are generally processes that do work that was not directly requested by the user. - The resource limits applied to Background jobs are intended to prevent them from disrupting the - user experience. + Background + : Background jobs are generally processes that do work that was not directly requested by the user. + The resource limits applied to Background jobs are intended to prevent them from disrupting the + user experience. - Standard - Standard jobs are equivalent to no ProcessType being set. + Standard + : Standard jobs are equivalent to no ProcessType being set. - Adaptive - Adaptive jobs move between the Background and Interactive classifications based on activity over - XPC connections. See <literal>xpc_transaction_begin(3)</literal> for details. + Adaptive + : Adaptive jobs move between the Background and Interactive classifications based on activity over + XPC connections. See `xpc_transaction_begin(3)` for details. - Interactive - Interactive jobs run with the same resource limitations as apps, that is to say, none. Interactive - jobs are critical to maintaining a responsive user experience, and this key should only be - used if an app's ability to be responsive depends on it, and cannot be made Adaptive. + Interactive + : Interactive jobs run with the same resource limitations as apps, that is to say, none. Interactive + jobs are critical to maintaining a responsive user experience, and this key should only be + used if an app's ability to be responsive depends on it, and cannot be made Adaptive. ''; }; |
