Skip to contentSkip to conversation

Documentation/networking/can.txt

DISCUSSION John Whitmore 2 participants 2 messages Dec 2, 2013 – Dec 3, 2013 CAN network drivers

lore
Share & tools
lore
#0 lore raw

Been lurking on this list for a while trying to get a feel for it. First post, poking my head above the wall, so to speak.

I'll start with the Documentation in the Linux kernel. At the moment, on a netbook, running from the Linus' git tree so perhaps I'm on the wrong git tree for communicating with this mailing list, but given the number of different git trees, I can't keep my head straight. Let me know if I'd be better on a different git tree.

I've been reading (and re-reading) a few of the networking docs and specifically can.txt as I'm starting to do some work on Linux CAN. To date I've been working on MCP2515's connected to small micro-controllers creating my own networks. I'm now hoping to plug a RaspberryPi into my CAN Networks.

There are a few typos in can.txt that aren't a big deal, but I could try send a patch file for them. My bigger question is with regard to section 3.3 which mentions Kconfig options "CAN_RAW_USER" and "CAN_BCM_USER". I've searched in the linux "make menuconfig" for these options and neither exist. grep'd the code, and didn't find an occurrence, outside can.txt, so I assume these two options could be removed from the text?

Finally, for the moment, section 7 references:

http://developer.berlios.de/projects/socketcan

this link is no longer correct as it points to another URL, so perhaps this reference could be updated?

I can attempt a patch but let me know against which git tree? Maybe that info could go into can.txt as well.

jwhitmore

#1 lore raw
Quoted 3 lines · John Whitmore

Been lurking on this list for a while trying to get a feel for it. First post, poking my head above the wall, so to speak.

Welcome! :-)

Quoted 5 lines

I'll start with the Documentation in the Linux kernel. At the moment, on a netbook, running from the Linus' git tree so perhaps I'm on the wrong git tree for communicating with this mailing list, but given the number of different git trees, I can't keep my head straight. Let me know if I'd be better on a different git tree.

This is at least the correct mailing list for Documentation/networking/can.txt

Sometimes the Documentation URL is mentioned in the MAINTAINERS file, e.g.

http://lxr.linux.no/#linux+v3.12.2/MAINTAINERS#L123

We should add the documentation URL like this ...

MAINTAINERS +1 -0
index 4afcfb4..5791d3d 100644
@@ -2023,6 +2023,7 @@ L:	[email protected]
 W:	http://gitorious.org/linux-can
 T:	git git://gitorious.org/linux-can/linux-can-next.git
 S:	Maintained
+F:	Documentation/networking/can.txt
 F:	net/can/
 F:	include/linux/can/core.h
 F:	include/uapi/linux/can.h

... to answer the question which mailing list to use for can.txt . You might add this change into your final patch.

Quoted 6 lines

I've been reading (and re-reading) a few of the networking docs and specifically can.txt as I'm starting to do some work on Linux CAN. To date I've been working on MCP2515's connected to small micro-controllers creating my own networks. I'm now hoping to plug a RaspberryPi into my CAN Networks.

Many people tried this before. That should work.

Quoted 6 lines

There are a few typos in can.txt that aren't a big deal, but I could try send a patch file for them. My bigger question is with regard to section 3.3 which mentions Kconfig options "CAN_RAW_USER" and "CAN_BCM_USER". I've searched in the linux "make menuconfig" for these options and neither exist. grep'd the code, and didn't find an occurrence, outside can.txt, so I assume these two options could be removed from the text?

Yes.
It's a remainder from a very early post of the CAN patch series.

Quoted 7 lines

Finally, for the moment, section 7 references:

http://developer.berlios.de/projects/socketcan

this link is no longer correct as it points to another URL, so perhaps this reference could be updated?

I updated this URL list at Wikipedia some days ago:
http://en.wikipedia.org/wiki/SocketCAN#External_links

Doing this I was also thinking about section 7 but I did not find a good solution so far.

We could add some of the URLs here too.
But I wonder if having the URLs to the project website and the mailing list in the MAINTAINERS file only is better (to have only one single point of reference). E.g. section 7 could point to the MAINTAINERS file then. Any preference?

Quoted 3 lines

I can attempt a patch but let me know against which git tree? Maybe that info could go into can.txt as well.

The different git trees (torvalds/linux.git, davem/net.git, davem/net-next.git) and the two CAN trees located at gitorious.org are always in different states depending on the current development phase.

Usually davem/net-next.git is the right place for new drivers and bigger changes in the documentation.

For fixes and small documentation updates davem/net.git is the right tree to send patched against. -> I would use this tree in your case.

Best regards,
Oliver