linux-kernel - Re: [PATCH v2] Documentation: kunit: rewrite writing first test instructions

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: <CABVgOSkbBPmNROt2h=M5tZk4OFhsysA8F_GTrPMG1M3e-QzNyg@mail.gmail.com>
Date:   Sat, 1 Oct 2022 14:51:29 +0800
From:   David Gow <davidgow@...gle.com>
To:     Bagas Sanjaya <bagasdotme@...il.com>
Cc:     "open list:KERNEL SELFTEST FRAMEWORK" 
        <linux-kselftest@...r.kernel.org>,
        KUnit Development <kunit-dev@...glegroups.com>,
        "open list:DOCUMENTATION" <linux-doc@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Brendan Higgins <brendan.higgins@...ux.dev>,
        Jonathan Corbet <corbet@....net>,
        Khalid Masum <khalid.masum.92@...il.com>,
        Sadiya Kazi <sadiyakazi@...gle.com>
Subject: Re: [PATCH v2] Documentation: kunit: rewrite writing first test instructions

On Sat, Oct 1, 2022 at 11:07 AM Bagas Sanjaya <bagasdotme@...il.com> wrote:
>
> On 9/30/22 17:32, David Gow wrote:
> >>
> >> The indentation for code-block directive is required, since the preceding
> >> paragraph is multiline; otherwise there will be Sphinx warnings.
> >>
> >
> > I don't see any such warnings on my machine (which claims to have
> > sphinx-build 4.5.0).
> >
> > Could you send an example warning, and your sphinx version to me so I
> > can try to reproduce it.
> >
> > Regardless, if it's causing warnings, keep these changes. (Though it'd
> > be nice to include the warnings in the commit message, so it's obvious
> > that these are being re-aligned for a reason.)
> >
>
> I'm using Sphinx 2.4.4 (as installed from pip through
> Documentation/sphinx/requirements.txt).
>
> Sorry I can't reproduce the warning I mentioned earlier (I forget
> the recipe that triggers it when writing the improv).
>
> In any case, I'd like to keep code block aligning in the separate patch.
> It would be nice to see code blocks aligned to the instructions list.
>

Sounds good. I tried to read through the reStructuredText spec to see
what it said about indentation here, and it was pretty vague, but if
it's causing warnings, we definitely should fix it. It would be nicer
(though not essential) to have it as a separate patch to the other
content changes.

Either way, feel free to send a new version (ideally based on top of
the kselftest/kunit tree, which has just had a number of patches
merged, including v1 of [1]).

Cheers,
-- David

[1]: https://lore.kernel.org/linux-doc/20220929085332.4155-1-khalid.masum.92@gmail.com/

Download attachment "smime.p7s" of type "application/pkcs7-signature" (4003 bytes)