linux-kernel - Re: [PATCH] Documentation/llvm: refresh docs

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: <CAKwvOdkuxO0TeERBCRFrjKvKUsg=nchOuPJc_gx_zGfOaWwhmA@mail.gmail.com>
Date:   Thu, 24 Aug 2023 14:12:23 -0700
From:   Nick Desaulniers <ndesaulniers@...gle.com>
To:     Nathan Chancellor <nathan@...nel.org>
Cc:     Masahiro Yamada <masahiroy@...nel.org>, Tom Rix <trix@...hat.com>,
        Nicolas Schier <nicolas@...sle.eu>,
        Jonathan Corbet <corbet@....net>,
        Paul Walmsley <paul.walmsley@...ive.com>,
        Palmer Dabbelt <palmer@...belt.com>,
        Albert Ou <aou@...s.berkeley.edu>, llvm@...ts.linux.dev,
        linux-kbuild@...r.kernel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, linux-riscv@...ts.infradead.org
Subject: Re: [PATCH] Documentation/llvm: refresh docs

On Thu, Aug 24, 2023 at 1:32 PM Nick Desaulniers
<ndesaulniers@...gle.com> wrote:
>
> On Thu, Aug 24, 2023 at 11:49 AM Nathan Chancellor <nathan@...nel.org> wrote:
> >
>
> > I see a few new kernel-doc warnings from not adjusting the underlines to
> > match the new length of the title:
> >
> >   Documentation/kbuild/llvm.rst:40: WARNING: Title underline too short.
> >
> >   The LLVM= argument
> >   --------------
> >   Documentation/kbuild/llvm.rst:40: WARNING: Title underline too short.
> >
> >   The LLVM= argument
> >   --------------
> >   Documentation/kbuild/llvm.rst:102: WARNING: Title underline too short.
> >
> >   The LLVM_IAS= argument
> >   -----------------
> >   Documentation/kbuild/llvm.rst:102: WARNING: Title underline too short.
> >
> >   The LLVM_IAS= argument
> >   -----------------
>
> oops! remind me of the make target to observe these?

Found it;
make htmldocs
https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html


-- 
Thanks,
~Nick Desaulniers