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 v4 26/28] docs: xilinx: convert eemi.txt to eemi.rst Date: Wed, 12 Jun 2019 14:53:02 -0300 [thread overview] Message-ID: <b2adf3e68b4e8f3f3c3d670be7f32a9bd981b17c.1560361364.git.mchehab+samsung@kernel.org> (raw) In-Reply-To: <cover.1560361364.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 v4 26/28] docs: xilinx: convert eemi.txt to eemi.rst Date: Wed, 12 Jun 2019 14:53:02 -0300 [thread overview] Message-ID: <b2adf3e68b4e8f3f3c3d670be7f32a9bd981b17c.1560361364.git.mchehab+samsung@kernel.org> (raw) In-Reply-To: <cover.1560361364.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-12 17:55 UTC|newest] Thread overview: 96+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-06-12 17:52 [PATCH v4 00/28] Convert files to ReST - part 1 Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 01/28] docs: aoe: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 02/28] docs: arm64: convert docs to ReST and rename to .rst Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-14 20:10 ` Jonathan Corbet 2019-06-14 20:10 ` Jonathan Corbet 2019-06-14 20:34 ` Jonathan Corbet 2019-06-14 20:34 ` Jonathan Corbet 2019-06-12 17:52 ` [PATCH v4 03/28] docs: cdrom-standard.tex: convert from LaTeX to ReST Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 04/28] docs: cdrom: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 05/28] docs: cgroup-v1: " Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-14 20:14 ` Jonathan Corbet 2019-06-14 20:14 ` Jonathan Corbet 2019-06-14 20:30 ` Tejun Heo 2019-06-14 20:30 ` Tejun Heo 2019-06-12 17:52 ` [PATCH v4 06/28] docs: cgroup-v1/blkio-controller.rst: add a note about CFQ scheduler Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 07/28] docs: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 08/28] docs: fault-injection: " Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 09/28] docs: fb: " Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 10/28] docs: fpga: " Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 11/28] docs: ide: " Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 12/28] docs: kbuild: " Mauro Carvalho Chehab 2019-06-12 17:52 ` [Bridge] " Mauro Carvalho Chehab 2019-06-12 17:52 ` [OpenRISC] " Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 13/28] docs: kdump: " Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 14/28] docs: locking: " Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-14 20:36 ` Jonathan Corbet 2019-06-12 17:52 ` [PATCH v4 15/28] docs: mic: " Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 16/28] docs: netlabel: " Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 17/28] docs: pcmcia: " Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 18/28] docs: " Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-13 0:25 ` Srivatsa S. Bhat 2019-06-13 0:25 ` Srivatsa S. Bhat 2019-06-13 0:25 ` Srivatsa S. Bhat 2019-06-13 9:58 ` Mauro Carvalho Chehab 2019-06-13 9:58 ` Mauro Carvalho Chehab 2019-06-13 9:58 ` Mauro Carvalho Chehab 2019-06-13 10:10 ` [PATCH v5] docs: power: " Mauro Carvalho Chehab 2019-06-13 10:10 ` Mauro Carvalho Chehab 2019-06-14 20:36 ` Jonathan Corbet 2019-06-14 20:36 ` Jonathan Corbet 2019-06-14 20:36 ` Jonathan Corbet 2019-06-14 21:14 ` Bjorn Helgaas 2019-06-14 21:14 ` Bjorn Helgaas 2019-06-14 21:14 ` Bjorn Helgaas 2019-06-13 15:58 ` [PATCH v4 18/28] docs: " Mathieu Poirier 2019-06-13 15:58 ` Mathieu Poirier 2019-06-12 17:52 ` [PATCH v4 19/28] docs: powerpc: " Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-14 20:36 ` Jonathan Corbet 2019-06-14 20:36 ` Jonathan Corbet 2019-06-14 20:36 ` Jonathan Corbet 2019-06-14 20:36 ` Jonathan Corbet 2019-06-14 21:30 ` Bjorn Helgaas 2019-06-14 21:30 ` Bjorn Helgaas 2019-06-14 21:30 ` Bjorn Helgaas 2019-06-14 21:30 ` Bjorn Helgaas 2019-06-18 12:39 ` Michael Ellerman 2019-06-18 12:39 ` Michael Ellerman 2019-06-18 12:39 ` Michael Ellerman 2019-06-18 12:39 ` Michael Ellerman 2019-06-12 17:52 ` [PATCH v4 20/28] docs: pps.txt: convert to ReST and rename to pps.rst Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 21/28] docs: ptp.txt: convert to ReST and move to driver-api Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 22/28] docs: riscv: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-12 17:52 ` [PATCH v4 23/28] docs: target: " Mauro Carvalho Chehab 2019-06-12 17:52 ` Mauro Carvalho Chehab 2019-06-19 3:38 ` Martin K. Petersen 2019-06-19 3:38 ` Martin K. Petersen 2019-06-12 17:53 ` [PATCH v4 24/28] docs: timers: " Mauro Carvalho Chehab 2019-06-12 17:53 ` Mauro Carvalho Chehab 2019-06-12 18:25 ` Mark Brown 2019-06-12 17:53 ` [PATCH v4 25/28] docs: watchdog: " Mauro Carvalho Chehab 2019-06-12 17:53 ` Mauro Carvalho Chehab [this message] 2019-06-12 17:53 ` [PATCH v4 26/28] docs: xilinx: convert eemi.txt to eemi.rst Mauro Carvalho Chehab 2019-06-12 17:53 ` [PATCH v4 27/28] docs: scheduler: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab 2019-06-12 17:53 ` [PATCH v4 28/28] docs: EDID/HOWTO.txt: convert it and rename to howto.rst Mauro Carvalho Chehab 2019-06-12 17:53 ` Mauro Carvalho Chehab 2019-06-14 20:36 ` [PATCH v4 00/28] Convert files to ReST - part 1 Jonathan Corbet 2019-06-14 20:36 ` Jonathan Corbet 2019-06-18 14:14 ` Mauro Carvalho Chehab 2019-06-18 14:14 ` Mauro Carvalho Chehab
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=b2adf3e68b4e8f3f3c3d670be7f32a9bd981b17c.1560361364.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.