From: Sven Eckelmann <sven@narfation.org>
To: b.a.t.m.a.n@lists.open-mesh.org
Subject: [B.A.T.M.A.N.] [PATCH 3/3] batman-adv: Convert README to reStructuredText
Date: Mon, 20 Nov 2017 22:02:17 +0100 [thread overview]
Message-ID: <20171120210217.8941-4-sven@narfation.org> (raw)
In-Reply-To: <20171120210217.8941-1-sven@narfation.org>
The current format of the file is not well defined. The reStructuredText
format (as used by other batman-adv related files) has the benefit that it
is similar easy to read and write. And it allows other tools to parse the
content of the file and convert it in a sensible way to a different file
format.
Multiple git repository web-based management software also can directly
render these files as properly formatted HTML output.
Signed-off-by: Sven Eckelmann <sven@narfation.org>
---
README.external | 51 ------------------------------------------
README.external.license | 2 --
README.external.rst | 59 +++++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 59 insertions(+), 53 deletions(-)
delete mode 100644 README.external
delete mode 100644 README.external.license
create mode 100644 README.external.rst
diff --git a/README.external b/README.external
deleted file mode 100644
index 03f08ad1..00000000
--- a/README.external
+++ /dev/null
@@ -1,51 +0,0 @@
-BATMAN-ADV external module
---------------------------
-
-The batman-adv module is shipped as part of the Linux kernel
-and as external module. The external module allows to get
-new features without upgrading to a newer kernel version
-and to get batman-adv specific bugfixes for kernels that are
-not supported anymore. It compiles against and should work
-with Linux 3.2 - 4.14. Supporting older versions is not
-planned, but it's probably easy to backport it. If you work on a
-backport, feel free to contact us. :-)
-
-COMPILE
--------
-
-To compile against your currently installed kernel, just type:
-
-# make
-
-if you want to compile against some other kernel, use:
-
-# make KERNELPATH=/path/to/kernel
-
-if you want to install this module:
-
-# sudo make install
-
-CONFIGURATION
--------------
-
-The in-kernel module can be configured through
-menuconfig. When compiling outside of the kernel tree, it is
-necessary to configure it using the make options. Each
-option can be set to to y (enabled), n (disabled) or m (build as
-module). Available options and their possible values are
-(default marked with an "*")
-
- * CONFIG_BATMAN_ADV_DEBUGFS=[y*|n] (B.A.T.M.A.N. debugfs entries)
- * CONFIG_BATMAN_ADV_DEBUG=[y|n*] (B.A.T.M.A.N. debugging)
- * CONFIG_BATMAN_ADV_BLA=[y*|n] (B.A.T.M.A.N. bridge loop avoidance)
- * CONFIG_BATMAN_ADV_DAT=[y*|n] (B.A.T.M.A.N. Distributed ARP Table)
- * CONFIG_BATMAN_ADV_MCAST=[y*|n] (B.A.T.M.A.N. multicast optimizations)
- * CONFIG_BATMAN_ADV_NC=[y|n*] (B.A.T.M.A.N. Network Coding)
- * CONFIG_BATMAN_ADV_BATMAN_V=[y|n*] (B.A.T.M.A.N. V routing algorithm)
-
-e.g., debugging can be enabled by
-
-# make CONFIG_BATMAN_ADV_DEBUG=y
-
-Keep in mind that all options must also be added to "make
-install" call.
diff --git a/README.external.license b/README.external.license
deleted file mode 100644
index a55d70ee..00000000
--- a/README.external.license
+++ /dev/null
@@ -1,2 +0,0 @@
-SPDX-License-Identifier: GPL-2.0
-License-Filename: LICENSES/preferred/GPL-2.0
diff --git a/README.external.rst b/README.external.rst
new file mode 100644
index 00000000..40a00452
--- /dev/null
+++ b/README.external.rst
@@ -0,0 +1,59 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==========================
+BATMAN-ADV external module
+==========================
+
+Introduction
+============
+
+The batman-adv module is shipped as part of the Linux kernel
+and as external module. The external module allows to get
+new features without upgrading to a newer kernel version
+and to get batman-adv specific bugfixes for kernels that are
+not supported anymore. It compiles against and should work
+with Linux 3.2 - 4.14. Supporting older versions is not
+planned, but it's probably easy to backport it. If you work on a
+backport, feel free to contact us. :-)
+
+
+COMPILE
+=======
+
+To compile against your currently installed kernel, just type::
+
+ # make
+
+if you want to compile against some other kernel, use::
+
+ # make KERNELPATH=/path/to/kernel
+
+if you want to install this module::
+
+ # sudo make install
+
+
+CONFIGURATION
+=============
+
+The in-kernel module can be configured through
+menuconfig. When compiling outside of the kernel tree, it is
+necessary to configure it using the make options. Each
+option can be set to to y (enabled), n (disabled) or m (build as
+module). Available options and their possible values are
+(default marked with an "*")
+
+ * ``CONFIG_BATMAN_ADV_DEBUGFS=[y*|n]`` (B.A.T.M.A.N. debugfs entries)
+ * ``CONFIG_BATMAN_ADV_DEBUG=[y|n*]`` (B.A.T.M.A.N. debugging)
+ * ``CONFIG_BATMAN_ADV_BLA=[y*|n]`` (B.A.T.M.A.N. bridge loop avoidance)
+ * ``CONFIG_BATMAN_ADV_DAT=[y*|n]`` (B.A.T.M.A.N. Distributed ARP Table)
+ * ``CONFIG_BATMAN_ADV_MCAST=[y*|n]`` (B.A.T.M.A.N. multicast optimizations)
+ * ``CONFIG_BATMAN_ADV_NC=[y|n*]`` (B.A.T.M.A.N. Network Coding)
+ * ``CONFIG_BATMAN_ADV_BATMAN_V=[y|n*]`` (B.A.T.M.A.N. V routing algorithm)
+
+e.g., debugging can be enabled by::
+
+ # make CONFIG_BATMAN_ADV_DEBUG=y
+
+Keep in mind that all options must also be added to ``make install``
+call.
--
2.11.0
next prev parent reply other threads:[~2017-11-20 21:02 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-20 21:02 [B.A.T.M.A.N.] [PATCH 0/3] batman-adv: Convert CHANGELOG/README to reStructuredText Sven Eckelmann
2017-11-20 21:02 ` [B.A.T.M.A.N.] [PATCH 1/3] batman-adv: Add .rst to README symlink Sven Eckelmann
2017-11-20 21:02 ` [B.A.T.M.A.N.] [PATCH 2/3] batman-adv: Convert CHANGELOG to reStructuredText Sven Eckelmann
2017-11-20 21:02 ` Sven Eckelmann [this message]
2017-12-01 13:20 ` [B.A.T.M.A.N.] [PATCH 0/3] batman-adv: Convert CHANGELOG/README " Sven Eckelmann
2017-12-01 13:23 ` Sven Eckelmann
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=20171120210217.8941-4-sven@narfation.org \
--to=sven@narfation.org \
--cc=b.a.t.m.a.n@lists.open-mesh.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