linux-kernel - Re: [PATCH v2 RESEND] Documentation: doc-guide: use '%' constant indicator in Return: examples

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <87ilamz4j5.fsf@meer.lwn.net>
Date:   Fri, 14 Jul 2023 13:17:34 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        Steven Rostedt <rostedt@...dmis.org>, linux-doc@...r.kernel.org
Subject: Re: [PATCH v2 RESEND] Documentation: doc-guide: use '%' constant
 indicator in Return: examples

Randy Dunlap <rdunlap@...radead.org> writes:

> Use the 'constant' indicator '%' in the examples for the
> Return: values syntax. This can help encourage people to use it.
>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Suggested-by: Steven Rostedt <rostedt@...dmis.org>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: linux-doc@...r.kernel.org
> Link: https://lore.kernel.org/lkml/20221121154358.36856ca6@gandalf.local.home/
> Acked-by: Steven Rostedt (Google) <rostedt@...dmis.org>
> ---
> v2: in Subject, spell 'examples' correctly;
>     Add Link: and Acked-by: Steven
>     add Note:
>
> Note: %-ECODE or -%ECODE both work well.
>
>  Documentation/doc-guide/kernel-doc.rst |   10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)

I'm not convinced that this %notation really helps the documentation
rather than just cluttering...but for now we have it, so I've applied
this.

Thanks,

jon