From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
David Woodhouse <dwmw2@infradead.org>,
Brian Norris <computersforpeace@gmail.com>,
Boris Brezillon <boris.brezillon@free-electrons.com>,
Marek Vasut <marek.vasut@gmail.com>,
Richard Weinberger <richard@nod.at>,
Cyrille Pitchen <cyrille.pitchen@atmel.com>,
linux-mtd@lists.infradead.org
Subject: [PATCH 18/31] debugging-via-ohci1394.txt: standardize document format
Date: Thu, 18 May 2017 22:22:23 -0300 [thread overview]
Message-ID: <ff99f0940e66e4a42b67113363f4643e4ecb3340.1495156488.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1495156488.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1495156488.git.mchehab@s-opensource.com>
Each text file under Documentation follows a different
format. Some doesn't even have titles!
Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:
- Mark and adjust titles;
- Mark and indent literal blocks.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/debugging-via-ohci1394.txt | 21 +++++++++++----------
1 file changed, 11 insertions(+), 10 deletions(-)
diff --git a/Documentation/debugging-via-ohci1394.txt b/Documentation/debugging-via-ohci1394.txt
index 9ff026d22b75..981ad4f89fd3 100644
--- a/Documentation/debugging-via-ohci1394.txt
+++ b/Documentation/debugging-via-ohci1394.txt
@@ -1,6 +1,6 @@
-
- Using physical DMA provided by OHCI-1394 FireWire controllers for debugging
- ---------------------------------------------------------------------------
+===========================================================================
+Using physical DMA provided by OHCI-1394 FireWire controllers for debugging
+===========================================================================
Introduction
------------
@@ -91,10 +91,10 @@ Step-by-step instructions for using firescope with early OHCI initialization:
1) Verify that your hardware is supported:
Load the firewire-ohci module and check your kernel logs.
- You should see a line similar to
+ You should see a line similar to::
- firewire_ohci 0000:15:00.1: added OHCI v1.0 device as card 2, 4 IR + 4 IT
- ... contexts, quirks 0x11
+ firewire_ohci 0000:15:00.1: added OHCI v1.0 device as card 2, 4 IR + 4 IT
+ ... contexts, quirks 0x11
when loading the driver. If you have no supported controller, many PCI,
CardBus and even some Express cards which are fully compliant to OHCI-1394
@@ -113,9 +113,9 @@ Step-by-step instructions for using firescope with early OHCI initialization:
stable connection and has matching connectors (there are small 4-pin and
large 6-pin FireWire ports) will do.
- If an driver is running on both machines you should see a line like
+ If an driver is running on both machines you should see a line like::
- firewire_core 0000:15:00.1: created device fw1: GUID 00061b0020105917, S400
+ firewire_core 0000:15:00.1: created device fw1: GUID 00061b0020105917, S400
on both machines in the kernel log when the cable is plugged in
and connects the two machines.
@@ -123,7 +123,7 @@ Step-by-step instructions for using firescope with early OHCI initialization:
3) Test physical DMA using firescope:
On the debug host, make sure that /dev/fw* is accessible,
- then start firescope:
+ then start firescope::
$ firescope
Port 0 (/dev/fw1) opened, 2 nodes detected
@@ -163,7 +163,7 @@ Step-by-step instructions for using firescope with early OHCI initialization:
host loaded, reboot the debugged machine, booting the kernel which has
CONFIG_PROVIDE_OHCI1394_DMA_INIT enabled, with the option ohci1394_dma=early.
- Then, on the debugging host, run firescope, for example by using -A:
+ Then, on the debugging host, run firescope, for example by using -A::
firescope -A System.map-of-debug-target-kernel
@@ -178,6 +178,7 @@ Step-by-step instructions for using firescope with early OHCI initialization:
Notes
-----
+
Documentation and specifications: http://halobates.de/firewire/
FireWire is a trademark of Apple Inc. - for more information please refer to:
--
2.9.4
next prev parent reply other threads:[~2017-05-19 1:22 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-05-19 1:22 [PATCH 00/31] Standardize doc formats - part 1 Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 01/31] bcache.txt: standardize document format Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 02/31] bt8xxgpio.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 03/31] btmrvl.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 04/31] bus-virt-phys-mapping.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 05/31] cachetlb.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 06/31] cgroup-v2.txt: " Mauro Carvalho Chehab
2017-05-19 14:59 ` Tejun Heo
2017-06-17 15:18 ` Mauro Carvalho Chehab
2017-06-18 10:46 ` Tejun Heo
2017-05-19 1:22 ` [PATCH 07/31] circular-buffers.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 08/31] clk.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 09/31] cpu-load: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 10/31] cputopology.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 11/31] crc32.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 12/31] dcdbas.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 13/31] digsig.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 14/31] DMA-API.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 15/31] DMA-API-HOWTO.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 16/31] DMA-attributes.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 17/31] DMA-ISA-LPC.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` Mauro Carvalho Chehab [this message]
2017-05-19 1:22 ` [PATCH 19/31] efi-stub.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 20/31] eisa.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 21/31] flexible-arrays.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 22/31] futex-requeue-pi.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 23/31] gcc-plugins.txt: " Mauro Carvalho Chehab
2017-05-24 17:35 ` Kees Cook
2017-05-24 20:18 ` Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 24/31] highuid.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 25/31] hw_random.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 26/31] hwspinlock.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 27/31] intel_txt.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 28/31] Intel-IOMMU.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 29/31] io-mapping.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 30/31] io_ordering.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 31/31] iostats.txt: " 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=ff99f0940e66e4a42b67113363f4643e4ecb3340.1495156488.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=boris.brezillon@free-electrons.com \
--cc=computersforpeace@gmail.com \
--cc=corbet@lwn.net \
--cc=cyrille.pitchen@atmel.com \
--cc=dwmw2@infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mtd@lists.infradead.org \
--cc=marek.vasut@gmail.com \
--cc=mchehab@infradead.org \
--cc=richard@nod.at \
/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: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®