| Message ID | 20241022213516.1756-4-yesanishhere@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | remoteproc documentation changes | expand |
anish kumar <yesanishhere@gmail.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@gmail.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
diff --git a/Documentation/remoteproc/index.rst b/Documentation/remoteproc/index.rst new file mode 100644 index 000000000000..af3573123ee4 --- /dev/null +++ b/Documentation/remoteproc/index.rst @@ -0,0 +1,25 @@ +.. SPDX-License-Identifier: GPL-2.0 + +======================================================================== +remoteproc - remote processor subsystem in Linux(TM) kernel +======================================================================== + +Authors: + - anish kumar <yesanishhere@gmail.com> + + remote processor subsystem is a way to manage the lifecycle of + a subsytem that is external to the Linux. The remoteproc framework + allows different platforms/architectures to control (power on, + load firmware, power off) those remote processors while abstracting + the hardware differences, so the entire driver doesn't need to be + duplicated. + +.. toctree:: + :maxdepth: 1 + + remoteproc + +Mailing List +------------ +To post a message, send an email to +linux-remoteproc@vger.kernel.org
Add index file so that readthedocs.io pick this file up and properly build the documentation site. Signed-off-by: anish kumar <yesanishhere@gmail.com> --- Documentation/remoteproc/index.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 Documentation/remoteproc/index.rst