[PATCH 1/2] tee.txt: standardize document format

2017-07-12 Thread Mauro Carvalho Chehab
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 identation of titles;
- mark ascii artwork as a literal block;
- adjust references.

Signed-off-by: Mauro Carvalho Chehab 
---
 Documentation/tee.txt | 51 ++-
 1 file changed, 30 insertions(+), 21 deletions(-)

diff --git a/Documentation/tee.txt b/Documentation/tee.txt
index 718599357596..56ea85ffebf2 100644
--- a/Documentation/tee.txt
+++ b/Documentation/tee.txt
@@ -1,4 +1,7 @@
+=
 TEE subsystem
+=
+
 This document describes the TEE subsystem in Linux.
 
 A TEE (Trusted Execution Environment) is a trusted OS running in some
@@ -80,27 +83,27 @@ The GlobalPlatform TEE Client API [5] is implemented on top 
of the generic
 TEE API.
 
 Picture of the relationship between the different components in the
-OP-TEE architecture.
+OP-TEE architecture::
 
-User space  Kernel   Secure world
-~~  ~~   
- ++ +-+
- | Client | | Trusted |
- ++ | Application |
-/\  +-+
-|| +--+   /\
-|| |tee-  |   ||
-|| |supplicant|   \/
-|| +--+ +-+
-\/  /\  | TEE Internal|
- +---+  ||  | API |
- + TEE   |  ||+++   +-+
- | Client|  ||| TEE| OP-TEE |   | OP-TEE  |
- | API   |  \/| subsys | driver |   | Trusted OS  |
- +---+++---++---+-+
- |  Generic TEE API|   | OP-TEE MSG   |
- |  IOCTL (TEE_IOC_*)  |   | SMCCC (OPTEE_SMC_CALL_*) |
- +-+   +--+
+  User space  Kernel   Secure world
+  ~~  ~~   
+   ++ +-+
+   | Client | | Trusted |
+   ++ | Application |
+  /\  +-+
+  || +--+   /\
+  || |tee-  |   ||
+  || |supplicant|   \/
+  || +--+ +-+
+  \/  /\  | TEE Internal|
+   +---+  ||  | API |
+   + TEE   |  ||+++   +-+
+   | Client|  ||| TEE| OP-TEE |   | OP-TEE  |
+   | API   |  \/| subsys | driver |   | Trusted OS  |
+   +---+++---++---+-+
+   |  Generic TEE API|   | OP-TEE MSG   |
+   |  IOCTL (TEE_IOC_*)  |   | SMCCC (OPTEE_SMC_CALL_*) |
+   +-+   +--+
 
 RPC (Remote Procedure Call) are requests from secure world to kernel driver
 or tee-supplicant. An RPC is identified by a special range of SMCCC return
@@ -109,10 +112,16 @@ kernel are handled by the kernel driver. Other RPC 
messages will be forwarded to
 tee-supplicant without further involvement of the driver, except switching
 shared memory buffer representation.
 
-References:
+References
+==
+
 [1] https://github.com/OP-TEE/optee_os
+
 [2] http://infocenter.arm.com/help/topic/com.arm.doc.den0028a/index.html
+
 [3] drivers/tee/optee/optee_smc.h
+
 [4] drivers/tee/optee/optee_msg.h
+
 [5] http://www.globalplatform.org/specificationsdevice.asp look for
 "TEE Client API Specification v1.0" and click download.
-- 
2.13.0



Re: [PATCH 1/2] tee.txt: standardize document format

2017-07-17 Thread Jens Wiklander
On Wed, Jul 12, 2017 at 10:35:04AM -0300, Mauro Carvalho Chehab wrote:
> 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 identation of titles;
> - mark ascii artwork as a literal block;
> - adjust references.
> 
> Signed-off-by: Mauro Carvalho Chehab 

Looks good to me. In case you're taking it by some other route:
Acked-by: Jens Wiklander 

Please let me know if you'd like me to pick it up.

--
Thanks,
Jens