linux-kernel - Re: [PATCH 3/7] Remoteproc: Documentation: add the main index

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: <87h693olnu.fsf@trenco.lwn.net>
Date: Tue, 22 Oct 2024 15:47:01 -0600
From: Jonathan Corbet <corbet@....net>
To: anish kumar <yesanishhere@...il.com>, ohad@...ery.com,
 bjorn.andersson@...aro.org, mathieu.poirier@...aro.org
Cc: linux-remoteproc@...r.kernel.org, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, anish kumar <yesanishhere@...il.com>
Subject: Re: [PATCH 3/7] Remoteproc: Documentation: add the main index

anish kumar <yesanishhere@...il.com> writes:

> Add index file so that readthedocs.io pick this file
> up and properly build the documentation site.
>
> Signed-off-by: anish kumar <yesanishhere@...il.com>
> ---
>  Documentation/remoteproc/index.rst | 25 +++++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
>  create mode 100644 Documentation/remoteproc/index.rst

readthedocs.io is not particularly relevant here; this change is needed
simply to make the docs build work right.

Properly, you should have added a version of this file first, since your
series is not bisectable as organized.  For a docs change, that alone
does not merit redoing the series, though.  However...

You do need to remove the entry in Documentation/staging/index.rst, or
you will break the docs build.

Please be sure to do a proper docs build before sending a patch series
like this.

More to the point, though, why are you creating a new top-level
directory for this?  That's something I would really like to avoid.  It
looks like the existing document fits well in the driver-api manual, is
there a reason why you haven't put it there?

Thanks,

jon