[PATCH v1 3/3] landlock: Fix documentation style

Mickaël Salaün mic at digikod.net
Tue Sep 27 16:52:34 UTC 2022


On 24/09/2022 11:50, Bagas Sanjaya wrote:
> On Fri, Sep 23, 2022 at 05:42:07PM +0200, Mickaël Salaün wrote:
>> It seems that all code should use double backquotes, which is also used
>> to convert "%" defines.  Let's use an homogeneous style and remove all
>> use of simple backquotes (which should only be used for emphasis).
>>
> 
> A little nit: the kernel log content at the opening paragraph should
> also be in inline code:

Is there some precedent? Explicit quotes (") seems more appropriate 
because we are talking about a text string (not a command nor a code 
snippet).

> 
> ---- >8 ----
> diff --git a/Documentation/userspace-api/landlock.rst b/Documentation/userspace-api/landlock.rst
> index cec780c2f4973c..5dbd577b5f58b7 100644
> --- a/Documentation/userspace-api/landlock.rst
> +++ b/Documentation/userspace-api/landlock.rst
> @@ -19,10 +19,10 @@ unexpected/malicious behaviors in user space applications.  Landlock empowers
>   any process, including unprivileged ones, to securely restrict themselves.
>   
>   We can quickly make sure that Landlock is enabled in the running system by
> -looking for "landlock: Up and running" in kernel logs (as root): ``dmesg | grep
> -landlock || journalctl -kg landlock`` .  Developers can also easily check for
> -Landlock support with a :ref:`related system call <landlock_abi_versions>`.  If
> -Landlock is not currently supported, we need to :ref:`configure the kernel
> +looking for ``landlock: Up and running`` in kernel logs (as root): ``dmesg |
> +grep landlock || journalctl -kg landlock`` .  Developers can also easily check
> +for Landlock support with a :ref:`related system call <landlock_abi_versions>`.
> +If Landlock is not currently supported, we need to :ref:`configure the kernel
>   appropriately <kernel_support>`.
>   
>   Landlock rules
> 
> Thanks.
> 



More information about the Linux-security-module-archive mailing list