From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> To: Linux Doc Mailing List <linux-doc@vger.kernel.org> Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>, Mauro Carvalho Chehab <mchehab@infradead.org>, linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>, Michal Simek <michal.simek@xilinx.com>, linux-arm-kernel@lists.infradead.org Subject: [PATCH v3 31/33] docs: xilinx: convert eemi.txt to eemi.rst Date: Sat, 8 Jun 2019 23:27:21 -0300 [thread overview] Message-ID: <1f3dfdcaa06e339791a86cf99918d7d0a2b52a67.1560045490.git.mchehab+samsung@kernel.org> (raw) In-Reply-To: <cover.1560045490.git.mchehab+samsung@kernel.org> This is a very trivial conversion: adjust the title markup and add a few literal block markups to produce a better visual when parsed and avoid warnings. As newer documents related to xilinx could be added in the future, create a new index file for it. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> --- Documentation/xilinx/{eemi.txt => eemi.rst} | 8 ++++---- Documentation/xilinx/index.rst | 17 +++++++++++++++++ 2 files changed, 21 insertions(+), 4 deletions(-) rename Documentation/xilinx/{eemi.txt => eemi.rst} (92%) create mode 100644 Documentation/xilinx/index.rst diff --git a/Documentation/xilinx/eemi.txt b/Documentation/xilinx/eemi.rst similarity index 92% rename from Documentation/xilinx/eemi.txt rename to Documentation/xilinx/eemi.rst index 5f39b4ffdcd4..9dcbc6f18d75 100644 --- a/Documentation/xilinx/eemi.txt +++ b/Documentation/xilinx/eemi.rst @@ -1,6 +1,6 @@ ---------------------------------------------------------------------- +==================================== Xilinx Zynq MPSoC EEMI Documentation ---------------------------------------------------------------------- +==================================== Xilinx Zynq MPSoC Firmware Interface ------------------------------------- @@ -21,7 +21,7 @@ The zynqmp-firmware driver maintain all EEMI APIs in zynqmp_eemi_ops structure. Any driver who want to communicate with PMC using EEMI APIs can call zynqmp_pm_get_eemi_ops(). -Example of EEMI ops: +Example of EEMI ops:: /* zynqmp-firmware driver maintain all EEMI APIs */ struct zynqmp_eemi_ops { @@ -34,7 +34,7 @@ Example of EEMI ops: .query_data = zynqmp_pm_query_data, }; -Example of EEMI ops usage: +Example of EEMI ops usage:: static const struct zynqmp_eemi_ops *eemi_ops; u32 ret_payload[PAYLOAD_ARG_CNT]; diff --git a/Documentation/xilinx/index.rst b/Documentation/xilinx/index.rst new file mode 100644 index 000000000000..01cc1a0714df --- /dev/null +++ b/Documentation/xilinx/index.rst @@ -0,0 +1,17 @@ +:orphan: + +=========== +Xilinx FPGA +=========== + +.. toctree:: + :maxdepth: 1 + + eemi + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex` -- 2.21.0
WARNING: multiple messages have this Message-ID (diff)
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> To: Linux Doc Mailing List <linux-doc@vger.kernel.org> Cc: Jonathan Corbet <corbet@lwn.net>, Michal Simek <michal.simek@xilinx.com>, linux-kernel@vger.kernel.org, Mauro Carvalho Chehab <mchehab+samsung@kernel.org>, Mauro Carvalho Chehab <mchehab@infradead.org>, linux-arm-kernel@lists.infradead.org Subject: [PATCH v3 31/33] docs: xilinx: convert eemi.txt to eemi.rst Date: Sat, 8 Jun 2019 23:27:21 -0300 [thread overview] Message-ID: <1f3dfdcaa06e339791a86cf99918d7d0a2b52a67.1560045490.git.mchehab+samsung@kernel.org> (raw) In-Reply-To: <cover.1560045490.git.mchehab+samsung@kernel.org> This is a very trivial conversion: adjust the title markup and add a few literal block markups to produce a better visual when parsed and avoid warnings. As newer documents related to xilinx could be added in the future, create a new index file for it. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> --- Documentation/xilinx/{eemi.txt => eemi.rst} | 8 ++++---- Documentation/xilinx/index.rst | 17 +++++++++++++++++ 2 files changed, 21 insertions(+), 4 deletions(-) rename Documentation/xilinx/{eemi.txt => eemi.rst} (92%) create mode 100644 Documentation/xilinx/index.rst diff --git a/Documentation/xilinx/eemi.txt b/Documentation/xilinx/eemi.rst similarity index 92% rename from Documentation/xilinx/eemi.txt rename to Documentation/xilinx/eemi.rst index 5f39b4ffdcd4..9dcbc6f18d75 100644 --- a/Documentation/xilinx/eemi.txt +++ b/Documentation/xilinx/eemi.rst @@ -1,6 +1,6 @@ ---------------------------------------------------------------------- +==================================== Xilinx Zynq MPSoC EEMI Documentation ---------------------------------------------------------------------- +==================================== Xilinx Zynq MPSoC Firmware Interface ------------------------------------- @@ -21,7 +21,7 @@ The zynqmp-firmware driver maintain all EEMI APIs in zynqmp_eemi_ops structure. Any driver who want to communicate with PMC using EEMI APIs can call zynqmp_pm_get_eemi_ops(). -Example of EEMI ops: +Example of EEMI ops:: /* zynqmp-firmware driver maintain all EEMI APIs */ struct zynqmp_eemi_ops { @@ -34,7 +34,7 @@ Example of EEMI ops: .query_data = zynqmp_pm_query_data, }; -Example of EEMI ops usage: +Example of EEMI ops usage:: static const struct zynqmp_eemi_ops *eemi_ops; u32 ret_payload[PAYLOAD_ARG_CNT]; diff --git a/Documentation/xilinx/index.rst b/Documentation/xilinx/index.rst new file mode 100644 index 000000000000..01cc1a0714df --- /dev/null +++ b/Documentation/xilinx/index.rst @@ -0,0 +1,17 @@ +:orphan: + +=========== +Xilinx FPGA +=========== + +.. toctree:: + :maxdepth: 1 + + eemi + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex` -- 2.21.0 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2019-06-09 2:29 UTC|newest] Thread overview: 99+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-06-09 2:26 [PATCH v3 00/33] Convert files to ReST - part 1 Mauro Carvalho Chehab 2019-06-09 2:26 ` Mauro Carvalho Chehab 2019-06-09 2:26 ` [PATCH v3 01/33] docs: aoe: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab 2019-06-09 2:26 ` [PATCH v3 02/33] docs: arm64: convert docs to ReST and rename to .rst Mauro Carvalho Chehab 2019-06-09 2:26 ` Mauro Carvalho Chehab 2019-06-09 2:26 ` [PATCH v3 03/33] docs: cdrom-standard.tex: convert from LaTeX to ReST Mauro Carvalho Chehab 2019-06-09 2:26 ` [PATCH v3 04/33] docs: cdrom: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab 2019-06-09 2:26 ` [PATCH v3 05/33] docs: cgroup-v1: " Mauro Carvalho Chehab 2019-06-09 2:26 ` Mauro Carvalho Chehab 2019-06-11 19:03 ` Tejun Heo 2019-06-11 19:03 ` Tejun Heo 2019-06-09 2:26 ` [PATCH v3 06/33] docs: cgroup-v1/blkio-controller.rst: add a note about CFQ scheduler Mauro Carvalho Chehab 2019-06-09 2:26 ` [PATCH v3 07/33] docs: cpu-freq: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab 2019-06-09 21:38 ` Rafael J. Wysocki 2019-06-10 0:27 ` Mauro Carvalho Chehab 2019-06-09 2:26 ` [PATCH v3 08/33] docs: " Mauro Carvalho Chehab 2019-06-09 2:26 ` Mauro Carvalho Chehab 2019-06-09 2:26 ` [PATCH v3 09/33] docs: fault-injection: " Mauro Carvalho Chehab 2019-06-10 16:24 ` Federico Vaga 2019-06-09 2:27 ` [PATCH v3 10/33] docs: fb: " Mauro Carvalho Chehab 2019-06-09 7:54 ` Geert Uytterhoeven 2019-06-09 7:54 ` Geert Uytterhoeven 2019-06-09 7:54 ` Geert Uytterhoeven 2019-06-09 2:27 ` [PATCH v3 11/33] docs: fpga: " Mauro Carvalho Chehab 2019-06-09 2:27 ` [PATCH v3 12/33] docs: ide: " Mauro Carvalho Chehab 2019-06-09 7:50 ` Geert Uytterhoeven 2019-06-09 2:27 ` [PATCH v3 13/33] docs: infiniband: " Mauro Carvalho Chehab 2019-06-10 17:27 ` Jason Gunthorpe 2019-06-10 17:35 ` Jonathan Corbet 2019-06-25 13:24 ` Jason Gunthorpe 2019-06-09 2:27 ` [PATCH v3 14/33] docs: kbuild: " Mauro Carvalho Chehab 2019-06-09 2:27 ` [Bridge] " Mauro Carvalho Chehab 2019-06-09 2:27 ` [OpenRISC] " Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-10 16:25 ` Federico Vaga 2019-06-10 16:25 ` [Bridge] " Federico Vaga 2019-06-10 16:25 ` [OpenRISC] " Federico Vaga 2019-06-10 16:25 ` Federico Vaga 2019-06-10 16:48 ` Federico Vaga 2019-06-10 16:48 ` [Bridge] " Federico Vaga 2019-06-10 16:48 ` [OpenRISC] " Federico Vaga 2019-06-10 16:48 ` Federico Vaga 2019-06-09 2:27 ` [PATCH v3 15/33] docs: kdump: " Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-09 2:27 ` [PATCH v3 16/33] docs: locking: " Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-10 16:26 ` Federico Vaga 2019-06-09 2:27 ` [PATCH v3 17/33] docs: mic: " Mauro Carvalho Chehab 2019-06-09 2:27 ` [PATCH v3 18/33] docs: netlabel: " Mauro Carvalho Chehab 2019-06-12 14:48 ` Paul Moore 2019-06-09 2:27 ` [PATCH v3 19/33] docs: pcmcia: " Mauro Carvalho Chehab 2019-06-09 6:59 ` Dominik Brodowski 2019-06-09 2:27 ` [PATCH v3 20/33] docs: " Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-09 2:27 ` [PATCH v3 21/33] docs: powerpc: " Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-09 2:27 ` [PATCH v3 22/33] docs: pps.txt: convert to ReST and rename to pps.rst Mauro Carvalho Chehab 2019-06-09 9:20 ` Rodolfo Giometti 2019-06-09 2:27 ` [PATCH v3 23/33] docs: ptp.txt: convert to ReST and move to driver-api Mauro Carvalho Chehab 2019-06-09 13:45 ` Richard Cochran 2019-06-09 2:27 ` [PATCH v3 24/33] docs: riscv: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-09 2:27 ` [PATCH v3 25/33] docs: Debugging390.txt: convert table to ascii artwork Mauro Carvalho Chehab 2019-06-09 2:27 ` [PATCH v3 26/33] docs: s390: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab 2019-06-09 2:27 ` [PATCH v3 27/33] s390: include/asm/debug.h add kerneldoc markups Mauro Carvalho Chehab 2019-06-09 2:27 ` [PATCH v3 28/33] docs: target: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-09 2:27 ` [PATCH v3 29/33] docs: timers: " Mauro Carvalho Chehab 2019-06-09 2:27 ` [PATCH v3 30/33] docs: watchdog: " Mauro Carvalho Chehab 2019-06-09 20:51 ` Guenter Roeck 2019-06-09 2:27 ` Mauro Carvalho Chehab [this message] 2019-06-09 2:27 ` [PATCH v3 31/33] docs: xilinx: convert eemi.txt to eemi.rst Mauro Carvalho Chehab 2019-06-09 2:27 ` [PATCH v3 32/33] docs: scheduler: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab 2019-06-09 2:27 ` [PATCH v3 33/33] docs: EDID/HOWTO.txt: convert it and rename to howto.rst Mauro Carvalho Chehab 2019-06-09 2:27 ` Mauro Carvalho Chehab 2019-06-11 8:37 ` Daniel Vetter 2019-06-11 9:02 ` Mauro Carvalho Chehab 2019-06-11 9:40 ` Daniel Vetter 2019-06-11 15:37 ` Jonathan Corbet 2019-06-12 17:40 ` Mauro Carvalho Chehab 2019-06-12 19:45 ` Daniel Vetter 2019-06-09 9:16 ` [PATCH v3 00/33] Convert files to ReST - part 1 Heiko Carstens 2019-06-09 9:16 ` Heiko Carstens 2019-06-09 9:22 ` Markus Heiser 2019-06-09 9:22 ` Markus Heiser 2019-06-09 9:27 ` Heiko Carstens 2019-06-09 9:27 ` Heiko Carstens 2019-06-09 12:29 ` Mauro Carvalho Chehab 2019-06-09 12:29 ` Mauro Carvalho Chehab 2019-06-10 15:55 ` Heiko Carstens 2019-06-10 15:55 ` Heiko Carstens
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=1f3dfdcaa06e339791a86cf99918d7d0a2b52a67.1560045490.git.mchehab+samsung@kernel.org \ --to=mchehab+samsung@kernel.org \ --cc=corbet@lwn.net \ --cc=linux-arm-kernel@lists.infradead.org \ --cc=linux-doc@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=mchehab@infradead.org \ --cc=michal.simek@xilinx.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.