linux-kernel - Re: [PATCH v2 1/6] Add AutoFDO support for Clang build

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <CAF1bQ=S7HfvXw+hczmQrSYcBf_DHsZo2k59JSL8T_9J9HitHuQ@mail.gmail.com>
Date: Mon, 7 Oct 2024 11:02:22 -0700
From: Rong Xu <xur@...gle.com>
To: Jonathan Corbet <corbet@....net>
Cc: Kees Cook <kees@...nel.org>, Peter Zijlstra <peterz@...radead.org>, 
	Nick Desaulniers <ndesaulniers@...gle.com>, Han Shen <shenhan@...gle.com>, 
	Sriraman Tallam <tmsriram@...gle.com>, David Li <davidxl@...gle.com>, 
	Krzysztof Pszeniczny <kpszeniczny@...gle.com>, Alice Ryhl <aliceryhl@...gle.com>, 
	Andrew Morton <akpm@...ux-foundation.org>, Arnd Bergmann <arnd@...db.de>, 
	Bill Wendling <morbo@...gle.com>, Borislav Petkov <bp@...en8.de>, Breno Leitao <leitao@...ian.org>, 
	Brian Gerst <brgerst@...il.com>, Dave Hansen <dave.hansen@...ux.intel.com>, 
	Heiko Carstens <hca@...ux.ibm.com>, "H. Peter Anvin" <hpa@...or.com>, Ingo Molnar <mingo@...hat.com>, 
	Jann Horn <jannh@...gle.com>, Josh Poimboeuf <jpoimboe@...nel.org>, Juergen Gross <jgross@...e.com>, 
	Justin Stitt <justinstitt@...gle.com>, linux-arch@...r.kernel.org, 
	linux-doc@...r.kernel.org, linux-kbuild@...r.kernel.org, 
	linux-kernel@...r.kernel.org, llvm@...ts.linux.dev, 
	Masahiro Yamada <masahiroy@...nel.org>, "Mike Rapoport (IBM)" <rppt@...nel.org>, 
	Nathan Chancellor <nathan@...nel.org>, Nicolas Schier <nicolas@...sle.eu>, 
	"Paul E. McKenney" <paulmck@...nel.org>, Samuel Holland <samuel.holland@...ive.com>, 
	Thomas Gleixner <tglx@...utronix.de>, Wei Yang <richard.weiyang@...il.com>, 
	workflows@...r.kernel.org, x86@...nel.org, "Xin Li (Intel)" <xin@...or.com>, 
	Stephane Eranian <eranian@...gle.com>
Subject: Re: [PATCH v2 1/6] Add AutoFDO support for Clang build

I removed the "code-block" directives from the rst files,
and used "::" suggested by Jonathan. The rst files themselves are now
easier to read in vi.  However, the rendered HTML output has some differences:
(1) The text that was previously in code-block no longer indents. It aligns
      with the preceding text, regardless of how many spaces I add.
(2) Previously, "code-block" removed '\' and combined the text into a
single line.
     This is no longer happening -- the '\' is not expanded.

These differences do not seem to be a blocker. I'm attaching the html files to
this email. If there is no objection, I'll change to using the new
method of "::".

-Rong

On Sat, Oct 5, 2024 at 7:43 AM Jonathan Corbet <corbet@....net> wrote:
>
> Kees Cook <kees@...nel.org> writes:
>
> > The tradition in kernel .rst is to do this with the trailing "::", e.g.:
> >
> > +Configure the kernel with::
> > +
> > +     CONFIG_AUTOFDO_CLANG=y
> >
> > This loses the language-specific highlighting when rendered. Perhaps the
> > "::" extension can be further extended?
> >
> > +Configure the kernel with::(make)
> > +
> > +     CONFIG_AUTOFDO_CLANG=y
> >
> > Then we could avoid the extra 2 lines but still gain the rendered language
> > highlights?
>
> The :: notation is standard Sphinx, not an extension we have done.  So
> the proposed syntax would have to be done from the beginning, I'm not
> sure how easy or hard that would be, or whether it would be worth it.
> But then, I've always seen relatively little value in the highlighting;
> others clearly differ.
>
> Thanks,
>
> jon

View attachment "autofdo_before.html" of type "text/html" (18398 bytes)

View attachment "autofdo_after.html" of type "text/html" (18065 bytes)