Skip to contentSkip to conversation

batman-adv: Convert batman-adv.txt to reStructuredText

PATCH Applied Sven Eckelmann 2 participants 7 messages Jul 12, 2017 – Sep 19, 2017

Subsystems (3)
lore
Share & tools
lore

Sven Eckelmann

author maintainer
#0 lore raw

PATCH 1/1 batman-adv: Convert batman-adv.txt to reStructuredText

Converting the freeform text to parsable reStructuredText, allows the integration in the sphinx based documentation system of the kernel. It will therefore be accessible as hypertext under
https://www.kernel.org/doc/html/latest/

---
 Documentation/networking/00-INDEX       |   2 -
 Documentation/networking/batman-adv.rst | 220 ++++++++++++++++++++++++++++++++
 Documentation/networking/batman-adv.txt | 215 -------------------------------
 Documentation/networking/index.rst      |   1 +
 MAINTAINERS                             |   2 +-
 5 files changed, 222 insertions(+), 218 deletions(-)
 create mode 100644 Documentation/networking/batman-adv.rst
 delete mode 100644 Documentation/networking/batman-adv.txt
Documentation/networking/00-INDEX +0 -2
index c6beb5f1637f..7a79b3587dd3 100644
@@ -30,8 +30,6 @@ atm.txt
 	- info on where to get ATM programs and support for Linux.
 ax25.txt
 	- info on using AX.25 and NET/ROM code for Linux
-batman-adv.txt
-	- B.A.T.M.A.N routing protocol on top of layer 2 Ethernet Frames.
 baycom.txt
 	- info on the driver for Baycom style amateur radio modems
 bonding.txt
Documentation/networking/batman-adv.rst new file +220 -0

220 lines not on this page · raw message

Documentation/networking/batman-adv.txt deleted +0 -215

215 lines not on this page · raw message

Documentation/networking/index.rst +1 -0
index b5bd87e01f52..66e620866245 100644
@@ -6,6 +6,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   batman-adv
    kapi
    z8530book
 
MAINTAINERS +1 -1
index 2af3ab3f7702..62d216af5bd4 100644
@@ -2481,7 +2481,7 @@ Q:	https://patchwork.open-mesh.org/project/batman/list/
 S:	Maintained
 F:	Documentation/ABI/testing/sysfs-class-net-batman-adv
 F:	Documentation/ABI/testing/sysfs-class-net-mesh
-F:	Documentation/networking/batman-adv.txt
+F:	Documentation/networking/batman-adv.rst
 F:	include/uapi/linux/batman_adv.h
 F:	net/batman-adv/
 
Signature · 1 line
2.11.0
author maintainer
#1 lore raw
Quoted 8 lines · On Mittwoch, 12. Juli 2017 13:14:48 CEST Sven Eckelmann wrote:
 Documentation/networking/00-INDEX       |   2 -
 Documentation/networking/batman-adv.rst | 220 ++++++++++++++++++++++++++++++++
 Documentation/networking/batman-adv.txt | 215 -------------------------------
 Documentation/networking/index.rst      |   1 +
 MAINTAINERS                             |   2 +-
 5 files changed, 222 insertions(+), 218 deletions(-)
 create mode 100644 Documentation/networking/batman-adv.rst
 delete mode 100644 Documentation/networking/batman-adv.txt

Just in case somebody wonders, this is really a patch against the Linux kernel and not against the batman-adv repository. The batman-adv repository doesn't require the changes to:

* Documentation/networking/00-INDEX
* Documentation/networking/index.rst

But it requires a change of the README link.

Kind regards,
Sven

maintainer
#2 lore raw
In reply to Sven Eckelmann
Quoted 4 lines · On Wed, 12 Jul 2017 13:14:48 +0200 Sven Eckelmann <[email protected]> wrote:

Converting the freeform text to parsable reStructuredText, allows the integration in the sphinx based documentation system of the kernel. It will therefore be accessible as hypertext under
https://www.kernel.org/doc/html/latest/

From a quick look-through this looks good. However, davem likes to take networking documentation work through his tree; may I suggest a repost with netdev included?

Thanks,

jon

author maintainer
#3 lore raw

On Montag, 17. Juli 2017 15:05:08 CEST Jonathan Corbet wrote:
[...]

Quoted 3 lines

From a quick look-through this looks good. However, davem likes to take networking documentation work through his tree; may I suggest a repost with netdev included?

The usual approach is to get batman-adv related patches first in the batman-adv tree before submitting it to netdev. Should this approach be changed for documentation related patches?

Kind regards,
Sven

maintainer
#4 lore raw
Quoted 3 lines · On Mon, 17 Jul 2017 23:13:48 +0200 Sven Eckelmann <[email protected]> wrote:

The usual approach is to get batman-adv related patches first in the batman-adv tree before submitting it to netdev. Should this approach be changed for documentation related patches?

No, just carry on as usual, that's fine.

Thanks,

jon

author maintainer Applied
#5 lore raw
In reply to Sven Eckelmann
Quoted 6 lines · On Mittwoch, 12. Juli 2017 13:14:48 CEST Sven Eckelmann wrote:

Converting the freeform text to parsable reStructuredText, allows the integration in the sphinx based documentation system of the kernel. It will therefore be accessible as hypertext under
https://www.kernel.org/doc/html/latest/

Applied as ab3618d92710b2e09f2c9dddf8099eb339f4fbb9 [1]

Kind regards,
Sven

[1] https://git.open-mesh.org/batman-adv.git/commit/ab3618d92710b2e09f2c9dddf8099eb339f4fbb9

author maintainer
#6 lore raw
Quoted 9 lines · On Samstag, 29. Juli 2017 10:01:18 CEST Sven Eckelmann wrote:
Quoted 6 lines · On Mittwoch, 12. Juli 2017 13:14:48 CEST Sven Eckelmann wrote:

Converting the freeform text to parsable reStructuredText, allows the integration in the sphinx based documentation system of the kernel. It will therefore be accessible as hypertext under
https://www.kernel.org/doc/html/latest/

Applied as ab3618d92710b2e09f2c9dddf8099eb339f4fbb9 [1]

This file is now part of the documentation and can now be found under
https://www.kernel.org/doc/html/latest/networking/batman-adv.html

Kind regards,
Sven