mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Linux Media Mailing List <linux-media@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>,
	Sean Young <sean@mess.org>
Subject: [PATCH 06/12] media: rc-sysfs-nodes.rst: better use literals
Date: Sat,  2 Sep 2017 23:34:58 -0300	[thread overview]
Message-ID: <1c7141e8a4191f298d648cd16993ca9b7b36abdc.1504405125.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1504405124.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1504405124.git.mchehab@s-opensource.com>

A literal box provides a better visual when pdf and html output
is generated for things like the output of a sysfs devnode.
It alsod matches other conventions used within the media book.

So, use it.

While here, use literals for protocol names.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/media/uapi/rc/rc-sysfs-nodes.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/media/uapi/rc/rc-sysfs-nodes.rst b/Documentation/media/uapi/rc/rc-sysfs-nodes.rst
index 3476ae29708f..2d01358d5504 100644
--- a/Documentation/media/uapi/rc/rc-sysfs-nodes.rst
+++ b/Documentation/media/uapi/rc/rc-sysfs-nodes.rst
@@ -34,9 +34,9 @@ receiver device where N is the number of the receiver.
 /sys/class/rc/rcN/protocols
 ===========================
 
-Reading this file returns a list of available protocols, something like:
+Reading this file returns a list of available protocols, something like::
 
-``rc5 [rc6] nec jvc [sony]``
+	rc5 [rc6] nec jvc [sony]
 
 Enabled protocols are shown in [] brackets.
 
@@ -90,11 +90,11 @@ This value may be reset to 0 if the current protocol is altered.
 ==================================
 
 Reading this file returns a list of available protocols to use for the
-wakeup filter, something like:
+wakeup filter, something like::
 
-``rc-5 nec nec-x rc-6-0 rc-6-6a-24 [rc-6-6a-32] rc-6-mce``
+	rc-5 nec nec-x rc-6-0 rc-6-6a-24 [rc-6-6a-32] rc-6-mce
 
-Note that protocol variants are listed, so "nec", "sony", "rc-5", "rc-6"
+Note that protocol variants are listed, so ``nec``, ``sony``, ``rc-5``, ``rc-6``
 have their different bit length encodings listed if available.
 
 Note that all protocol variants are listed.
-- 
2.13.5

  parent reply	other threads:[~2017-09-03  2:38 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-03  2:34 [PATCH 00/12] media documentation ReST fixes Mauro Carvalho Chehab
2017-09-03  2:34 ` [PATCH 01/12] media: v4l uAPI: add descriptions for arguments to all ioctls Mauro Carvalho Chehab
2017-09-03  2:34 ` [PATCH 02/12] media: vidioc-querycap: use a more realistic value for KERNEL_VERSION Mauro Carvalho Chehab
2017-09-03  2:34 ` [PATCH 03/12] media: vidioc-g-tuner.rst: Fix table number of cols Mauro Carvalho Chehab
2017-09-03  2:34 ` [PATCH 04/12] media: v4l uAPI docs: adjust some tables for PDF output Mauro Carvalho Chehab
2017-09-03  2:34 ` [PATCH 05/12] media: docs: fix PDF build with Sphinx 1.4 Mauro Carvalho Chehab
2017-09-03  2:34 ` Mauro Carvalho Chehab [this message]
2017-09-03  2:34 ` [PATCH 07/12] media: mc uapi: adjust some table sizes for PDF output Mauro Carvalho Chehab
2017-09-03  2:35 ` [PATCH 08/12] media: cec uapi: Adjust " Mauro Carvalho Chehab
2017-09-03  2:35 ` [PATCH 09/12] media: docs: don't show ToC for each part on " Mauro Carvalho Chehab
2017-09-03  2:35 ` [PATCH 10/12] media: v4l2-event.rst: adjust table to fit " Mauro Carvalho Chehab
2017-09-03  2:35 ` [PATCH 11/12] media: em28xx-cardlist.rst: update to reflect last changes Mauro Carvalho Chehab
2017-09-03  2:35 ` [PATCH 12/12] media: docs-rst: cardlists: change their format to flat-tables 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=1c7141e8a4191f298d648cd16993ca9b7b36abdc.1504405125.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@infradead.org \
    --cc=sean@mess.org \
    /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®