[PATCH v2 14/26] SM501.txt: standardize document format

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Newsgroups	linux.kernel
Subject	[PATCH v2 14/26] SM501.txt: standardize document format
Date	2017-06-17 17:30 +0200
Message-ID	<tTnPI-y3-33@gated-at.bofh.it> (permalink)
References	<tTnPI-y3-25@gated-at.bofh.it>
Organization	linux.* mail to news gateway

Show all headers | View raw

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:

- adjust document title;
- use the copyright markup.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/SM501.txt | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/Documentation/SM501.txt b/Documentation/SM501.txt
index 561826f82093..882507453ba4 100644
--- a/Documentation/SM501.txt
+++ b/Documentation/SM501.txt
@@ -1,7 +1,10 @@
-			SM501 Driver
-			============
+.. include:: <isonum.txt>
 
-Copyright 2006, 2007 Simtec Electronics
+============
+SM501 Driver
+============
+
+:Copyright: |copy| 2006, 2007 Simtec Electronics
 
 The Silicon Motion SM501 multimedia companion chip is a multifunction device
 which may provide numerous interfaces including USB host controller USB gadget,
-- 
2.9.4

Back to linux.kernel | Previous | Next | Find similar | Unroll thread

Thread

[PATCH v2 14/26] SM501.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-06-17 17:30 +0200

csiph-web