Re: [PATCH] Documentation: insist on the plain-text requirement for security reports

[Willy Tarreau <w@1wt.eu>]

Hi Ingo,

On Mon, Dec 01, 2025 at 09:47:01PM +0100, Ingo Molnar wrote:
> 
> * Willy Tarreau <w@1wt.eu> wrote:
> 
> > As the trend of AI-generated reports is growing, the trend of unreadable
> > reports in gimmicky formats is following, and we cannot request that
> > developers rely on online viewers to be able to read a security report
> > full for formatting tags. Let's just insist on the plain text requirement
> > a bit more.
> > 
> > Signed-off-by: Willy Tarreau <w@1wt.eu>
> > ---
> >  Documentation/process/security-bugs.rst | 6 +++++-
> >  1 file changed, 5 insertions(+), 1 deletion(-)
> > 
> > diff --git a/Documentation/process/security-bugs.rst b/Documentation/process/security-bugs.rst
> > index 84657e7d2e5b..c0cf93e11565 100644
> > --- a/Documentation/process/security-bugs.rst
> > +++ b/Documentation/process/security-bugs.rst
> > @@ -33,12 +33,16 @@ that can speed up the process considerably.  It is possible that the
> >  security team will bring in extra help from area maintainers to
> >  understand and fix the security vulnerability.
> >  
> > -Please send plain text emails without attachments where possible.
> > +Please send **plain text** emails without attachments where possible.
> 
> So maybe part of the confusion is that this sentence 
> can be read permissively, depending how the 'where 
> possible' qualifier is interpreted:
> 
>     Please send plain text emails without attachments, 
>     where possible.
> 
> Note how "it's not possible because my report is in 
> PDF" seems to allow for that in the permissive reading.
> 
> What that sentence should really say is something like:
> 
>    Please send plain text emails only. Please do not 
>    include any attachments, where possible.
> 
> This makes it clear that only plain text emails are 
> acceptable.

Well, honestly I don't think it *really* makes a difference.
Either the message is read, understood, and compatible with
the rules in place, or it is not. As you know, we're getting
regular reports as a password-protected ZIP and stuff like
this, and it's not changing because people follow the rules
in place. However those who quickly glance at the text above
might have been believing that markdown and HTML were plain
text. With the extra addition it clarifies this specific
point, and since most returning submitters try to improve on
their second submission after our feedback I think it will
help us deliver this "feedback" prior to their first message.

> Ie. something like the patch below?

I have nothing against it but I'm not convinced at all that
it brings any extra benefit over the first one. I'm fine with
both in fact.

Thanks,
Willy