linux-kernel - Re: [PATCH 14/34] docs: dev-tools: kunit: avoid using ReST :doc:`foo` markup

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]

Date:   Wed, 16 Jun 2021 08:13:26 +0200
From:   Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To:     David Gow <davidgow@...gle.com>
Cc:     Jonathan Corbet <corbet@....net>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Brendan Higgins <brendanhiggins@...gle.com>,
        KUnit Development <kunit-dev@...glegroups.com>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        "open list:KERNEL SELFTEST FRAMEWORK" 
        <linux-kselftest@...r.kernel.org>
Subject: Re: [PATCH 14/34] docs: dev-tools: kunit: avoid using ReST
 :doc:`foo` markup

Em Wed, 16 Jun 2021 08:00:34 +0200
Mauro Carvalho Chehab <mchehab+huawei@...nel.org> escreveu:

> Em Sat, 5 Jun 2021 23:44:41 +0800
> David Gow <davidgow@...gle.com> escreveu:
> 
> > On Sat, Jun 5, 2021 at 9:18 PM Mauro Carvalho Chehab
> > <mchehab+huawei@...nel.org> wrote:
> > >
> > > The :doc:`foo` tag is auto-generated via automarkup.py.
> > > So, use the filename at the sources, instead of :doc:`foo`.
> > >
> > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> > > ---  
> > 
> > This is much better, thanks! Do note that there's a merge conflict
> > (and another :doc:`` tag which needs updating) in the kunit-fixes
> > branch:
> > https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/commit/?h=kunit-fixes&id=11dbc62a73a7da9f3697e8ce83d07503c11dcabb
> 
> Ok, thanks for the warning. I'm folding the enclosed patch:

Err... ended adding a wrong diff there...

I guess I'm missing my morning dosage of caffeine ;-)

The diff I appended is this one:

diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
index ee21e482a0de..63ef7b625c13 100644
--- a/Documentation/dev-tools/kunit/start.rst
+++ b/Documentation/dev-tools/kunit/start.rst
@@ -236,5 +236,5 @@ Next Steps
 ==========
 *   Check out the Documentation/dev-tools/kunit/tips.rst page for tips on
     writing idiomatic KUnit tests.
-*   Optional: see the Documentation/dev-tools/kunit/usage.rst page for a more
+*   Optional: see the :doc:`usage` page for a more
     in-depth explanation of KUnit.

It basically reverts a change in order to avoid merge conflicts at
linux-next when this patch gets merged via docs-next.

I'll submit later a followup patch against 5.14-rc1.

Thanks,
Mauro