[PATCH 22/32] Documentation/mono.txt: convert to ReST markup

From: Mauro Carvalho Chehab
Date: Mon Oct 17 2016 - 13:04:22 EST


- Fix document title;
- use quote blocks where needed;
- use .. note:: for notes;
- use monotonic fonts for config options and file names;
- adjust whitespaces and blank lines;
- add it to the user's book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
---
Documentation/mono.txt | 44 +++++++++++++++++++++++---------------------
Documentation/user/index.rst | 1 +
Documentation/user/mono.rst | 1 +
3 files changed, 25 insertions(+), 21 deletions(-)
create mode 120000 Documentation/user/mono.rst

diff --git a/Documentation/mono.txt b/Documentation/mono.txt
index d01ac6052194..9a9744ca0cf3 100644
--- a/Documentation/mono.txt
+++ b/Documentation/mono.txt
@@ -1,5 +1,5 @@
- Mono(tm) Binary Kernel Support for Linux
- -----------------------------------------
+Mono(tm) Binary Kernel Support for Linux
+-----------------------------------------

To configure Linux to automatically execute Mono-based .NET binaries
(in the form of .exe files) without the need to use the mono CLR
@@ -19,22 +19,22 @@ other program after you have done the following:
http://www.go-mono.com/compiling.html

Once the Mono CLR support has been installed, just check that
- /usr/bin/mono (which could be located elsewhere, for example
- /usr/local/bin/mono) is working.
+ ``/usr/bin/mono`` (which could be located elsewhere, for example
+ ``/usr/local/bin/mono``) is working.

2) You have to compile BINFMT_MISC either as a module or into
- the kernel (CONFIG_BINFMT_MISC) and set it up properly.
+ the kernel (``CONFIG_BINFMT_MISC``) and set it up properly.
If you choose to compile it as a module, you will have
to insert it manually with modprobe/insmod, as kmod
- cannot be easily supported with binfmt_misc.
- Read the file 'binfmt_misc.txt' in this directory to know
+ cannot be easily supported with binfmt_misc.
+ Read the file ``binfmt_misc.txt`` in this directory to know
more about the configuration process.

-3) Add the following entries to /etc/rc.local or similar script
- to be run at system startup:
+3) Add the following entries to ``/etc/rc.local`` or similar script
+ to be run at system startup::

-# Insert BINFMT_MISC module into the kernel
-if [ ! -e /proc/sys/fs/binfmt_misc/register ]; then
+ # Insert BINFMT_MISC module into the kernel
+ if [ ! -e /proc/sys/fs/binfmt_misc/register ]; then
/sbin/modprobe binfmt_misc
# Some distributions, like Fedora Core, perform
# the following command automatically when the
@@ -43,24 +43,26 @@ if [ ! -e /proc/sys/fs/binfmt_misc/register ]; then
# Thus, it is possible that the following line
# is not needed at all.
mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
-fi
+ fi

-# Register support for .NET CLR binaries
-if [ -e /proc/sys/fs/binfmt_misc/register ]; then
+ # Register support for .NET CLR binaries
+ if [ -e /proc/sys/fs/binfmt_misc/register ]; then
# Replace /usr/bin/mono with the correct pathname to
# the Mono CLR runtime (usually /usr/local/bin/mono
# when compiling from sources or CVS).
echo ':CLR:M::MZ::/usr/bin/mono:' > /proc/sys/fs/binfmt_misc/register
-else
+ else
echo "No binfmt_misc support"
exit 1
-fi
+ fi

-4) Check that .exe binaries can be ran without the need of a
- wrapper script, simply by launching the .exe file directly
- from a command prompt, for example:
+4) Check that ``.exe`` binaries can be ran without the need of a
+ wrapper script, simply by launching the ``.exe`` file directly
+ from a command prompt, for example::

/usr/bin/xsd.exe

- NOTE: If this fails with a permission denied error, check
- that the .exe file has execute permissions.
+ .. note::
+
+ If this fails with a permission denied error, check
+ that the ``.exe`` file has execute permissions.
diff --git a/Documentation/user/index.rst b/Documentation/user/index.rst
index dee63ce0662a..1858fc94c630 100644
--- a/Documentation/user/index.rst
+++ b/Documentation/user/index.rst
@@ -21,5 +21,6 @@ Contents:
devices
module-signing
binfmt_misc
+ mono
bad_memory
basic_profiling
diff --git a/Documentation/user/mono.rst b/Documentation/user/mono.rst
new file mode 120000
index 000000000000..067f9498c0e3
--- /dev/null
+++ b/Documentation/user/mono.rst
@@ -0,0 +1 @@
+../mono.txt
\ No newline at end of file
--
2.7.4