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>
This commit is contained in:
parent
cea470729d
commit
7d59773945
|
@ -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
|
||||
|
|
1437
Documentation/networking/can.rst
Normal file
1437
Documentation/networking/can.rst
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
@ -7,6 +7,7 @@ Contents:
|
|||
:maxdepth: 2
|
||||
|
||||
batman-adv
|
||||
can
|
||||
kapi
|
||||
z8530book
|
||||
msg_zerocopy
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -61,7 +61,7 @@ MODULE_ALIAS_RTNL_LINK(DRV_NAME);
|
|||
/*
|
||||
* CAN test feature:
|
||||
* Enable the echo on driver level for testing the CAN core echo modes.
|
||||
* See Documentation/networking/can.txt for details.
|
||||
* See Documentation/networking/can.rst for details.
|
||||
*/
|
||||
|
||||
static bool echo; /* echo testing. Default: 0 (Off) */
|
||||
|
|
|
@ -11,7 +11,7 @@ menuconfig CAN
|
|||
1991, mainly for automotive, but now widely used in marine
|
||||
(NMEA2000), industrial, and medical applications.
|
||||
More information on the CAN network protocol family PF_CAN
|
||||
is contained in <Documentation/networking/can.txt>.
|
||||
is contained in <Documentation/networking/can.rst>.
|
||||
|
||||
If you want CAN support you should say Y here and also to the
|
||||
specific driver for your controller(s) below.
|
||||
|
|
Loading…
Reference in New Issue
Block a user