LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Julian Brost <linux-kernel@0x4a42.net>
To: linux-doc@vger.kernel.org
Cc: Julian Brost <linux-kernel@0x4a42.net>,
	linux-kernel@vger.kernel.org, corbet@lwn.net,
	tomas.winkler@intel.com, linux-mei@linux.intel.com,
	linux-kernel@i4.cs.fau.de, fabian.hofmann@fau.de
Subject: [PATCH 1/4] Documentation/misc-devices/mei: Fix formatting of headings.
Date: Mon, 12 Jan 2015 00:58:06 +0100	[thread overview]
Message-ID: <1421020689-28332-2-git-send-email-linux-kernel@0x4a42.net> (raw)
In-Reply-To: <1421020689-28332-1-git-send-email-linux-kernel@0x4a42.net>

Make the heading underlines fit the length of the heading, remove colons
at the end of headings and consistently place an empty line after each
heading and two empty lines before each that is preceded by a paragraph.

Signed-off-by: Julian Brost <linux-kernel@0x4a42.net>
Signed-off-by: Fabian Hofmann <fabian.hofmann@fau.de>
---
 Documentation/misc-devices/mei/mei-client-bus.txt |  7 ++++--
 Documentation/misc-devices/mei/mei.txt            | 27 ++++++++++++++---------
 2 files changed, 22 insertions(+), 12 deletions(-)

diff --git a/Documentation/misc-devices/mei/mei-client-bus.txt b/Documentation/misc-devices/mei/mei-client-bus.txt
index f83910a..6ca486b 100644
--- a/Documentation/misc-devices/mei/mei-client-bus.txt
+++ b/Documentation/misc-devices/mei/mei-client-bus.txt
@@ -1,9 +1,10 @@
 Intel(R) Management Engine (ME) Client bus API
-===============================================
+==============================================
 
 
 Rationale
 =========
+
 MEI misc character device is useful for dedicated applications to send and receive
 data to the many FW appliance found in Intel's ME from the user space.
 However for some of the ME functionalities it make sense to leverage existing software
@@ -17,7 +18,8 @@ the existing code.
 
 
 MEI CL bus API
-===========
+==============
+
 A driver implementation for an MEI Client is very similar to existing bus
 based device drivers. The driver registers itself as an MEI CL bus driver through
 the mei_cl_driver structure:
@@ -55,6 +57,7 @@ received buffers.
 
 Example
 =======
+
 As a theoretical example let's pretend the ME comes with a "contact" NFC IP.
 The driver init and exit routines for this device would look like:
 
diff --git a/Documentation/misc-devices/mei/mei.txt b/Documentation/misc-devices/mei/mei.txt
index 15bba1a..9a96af1 100644
--- a/Documentation/misc-devices/mei/mei.txt
+++ b/Documentation/misc-devices/mei/mei.txt
@@ -1,8 +1,8 @@
 Intel(R) Management Engine Interface (Intel(R) MEI)
-=======================
+===================================================
 
 Introduction
-=======================
+============
 
 The Intel Management Engine (Intel ME) is an isolated and protected computing
 resource (Co-processor) residing inside certain Intel chipsets. The Intel ME
@@ -44,8 +44,9 @@ HTTP/S that are received from a remote management console application.
 For more information about Intel AMT:
 http://software.intel.com/sites/manageability/AMT_Implementation_and_Reference_Guide
 
+
 Intel MEI Driver
-=======================
+================
 
 The driver exposes a misc device called /dev/mei.
 
@@ -91,8 +92,10 @@ A code snippet for an application communicating with Intel AMTHI client:
 	[...]
 	close(fd);
 
-IOCTL:
-======
+
+IOCTL
+=====
+
 The Intel MEI Driver supports the following IOCTL command:
 	IOCTL_MEI_CONNECT_CLIENT	Connect to firmware Feature (client).
 
@@ -122,8 +125,9 @@ The Intel MEI Driver supports the following IOCTL command:
         data that can be sent or received. (e.g. if MTU=2K, can send
         requests up to bytes 2k and received responses up to 2k bytes).
 
-Intel ME Applications:
-==============
+
+Intel ME Applications
+=====================
 
 1) Intel Local Management Service (Intel LMS)
 
@@ -172,8 +176,9 @@ Intel ME Applications:
 	http://software.intel.com/en-us/articles/download-the-latest-intel-amt-open-source-drivers/
 
 
-Intel AMT OS Health Watchdog:
-=============================
+Intel AMT OS Health Watchdog
+============================
+
 The Intel AMT Watchdog is an OS Health (Hang/Crash) watchdog.
 Whenever the OS hangs or crashes, Intel AMT will send an event
 to any subscriber to this event. This mechanism means that
@@ -192,8 +197,10 @@ watchdog is 120 seconds.
 If the Intel AMT Watchdog feature does not exist (i.e. the connection failed),
 the Intel MEI driver will disable the sending of heartbeats.
 
-Supported Chipsets:
+
+Supported Chipsets
 ==================
+
 7 Series Chipset Family
 6 Series Chipset Family
 5 Series Chipset Family
-- 
2.2.1


  reply	other threads:[~2015-01-11 23:58 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-01-11 23:58 [PATCH 0/4] Documentation/misc-devices/mei: Fix formatting Julian Brost
2015-01-11 23:58 ` Julian Brost [this message]
2015-01-28 19:17   ` [PATCH 1/4] Documentation/misc-devices/mei: Fix formatting of headings Jonathan Corbet
2015-01-29  1:39     ` [i4passt] " Alexander Wuerstlein
2015-01-29 19:57       ` Jonathan Corbet
2015-01-11 23:58 ` [PATCH 2/4] Documentation/misc-devices/mei: Fix spacing around parentheses Julian Brost
2015-01-11 23:58 ` [PATCH 3/4] Documentation/misc-devices/mei: Fix indentation of enumeration Julian Brost
2015-01-11 23:58 ` [PATCH 4/4] Documentation/misc-devices/mei: Fix indentation of embedded code Julian Brost
2015-01-12  4:56   ` Jeremiah Mahler
2015-01-12  4:57 ` [PATCH 0/4] Documentation/misc-devices/mei: Fix formatting Jeremiah Mahler
2015-01-12  8:55   ` Winkler, Tomas

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=1421020689-28332-2-git-send-email-linux-kernel@0x4a42.net \
    --to=linux-kernel@0x4a42.net \
    --cc=corbet@lwn.net \
    --cc=fabian.hofmann@fau.de \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@i4.cs.fau.de \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mei@linux.intel.com \
    --cc=tomas.winkler@intel.com \
    --subject='Re: [PATCH 1/4] Documentation/misc-devices/mei: Fix formatting of headings.' \
    /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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).