Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 7d597739 authored Jan 24, 2018 by Robert Schwebel Committed by Marc Kleine-Budde Jan 26, 2018

can: migrate documentation to restructured text



The kernel documentation is now restructured text. Convert the SocketCAN
documentation and include it in the toplevel kernel documentation.

This patch doesn't do any content change.

All references to can.txt in the code are converted to can.rst.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de>

parent cea47072

Documentation/networking/00-INDEX

+0 −2

Original line number	Diff line number	Diff line
		@@ -36,8 +36,6 @@ bonding.txt
		- Linux Ethernet Bonding Driver HOWTO: link aggregation in Linux.
		bridge.txt
		- where to get user space programs for ethernet bridging with Linux.
		can.txt
		- documentation on CAN protocol family.
		cdc_mbim.txt
		- 3G/LTE USB modem (Mobile Broadband Interface Model)
		checksum-offloads.txt

Documentation/networking/can.txt→Documentation/networking/can.rst

+1437 −0

File changed and moved.

Preview size limit exceeded, changes collapsed.

Documentation/networking/index.rst

+1 −0

Original line number	Diff line number	Diff line
		@@ -7,6 +7,7 @@ Contents:
		:maxdepth: 2

		batman-adv
		can
		kapi
		z8530book
		msg_zerocopy

MAINTAINERS

+1 −1

Original line number	Diff line number	Diff line
		@@ -3206,7 +3206,7 @@ W: https://github.com/linux-can
		T: git git://git.kernel.org/pub/scm/linux/kernel/git/mkl/linux-can.git
		T: git git://git.kernel.org/pub/scm/linux/kernel/git/mkl/linux-can-next.git
		S: Maintained
		F: Documentation/networking/can.txt
		F: Documentation/networking/can.rst
		F: net/can/
		F: include/linux/can/core.h
		F: include/uapi/linux/can.h

drivers/net/can/dev.c

+1 −1

Original line number	Diff line number	Diff line
		@@ -412,7 +412,7 @@ EXPORT_SYMBOL_GPL(can_change_state);
		* Local echo of CAN messages
		*
		* CAN network devices should support a local echo functionality
		* (see Documentation/networking/can.txt). To test the handling of CAN
		* (see Documentation/networking/can.rst). To test the handling of CAN
		* interfaces that do not support the local echo both driver types are
		* implemented. In the case that the driver does not support the echo
		* the IFF_ECHO remains clear in dev->flags. This causes the PF_CAN core