examples/tests: remove redundant xbee config#6982
Conversation
aabadie
left a comment
There was a problem hiding this comment.
Just a minor comment on my side
|
|
||
| BOARD_INSUFFICIENT_MEMORY := chronos msb-430 msb-430h nucleo32-f031 | ||
|
|
||
| ## Uncomment to support the XBee module |
There was a problem hiding this comment.
Maybe those 2 lines could be kept ?
There was a problem hiding this comment.
I am opposed to that, I don't think we should have comments about available hw/modules in these makefiles, so if we would keep the comment about the xbee here, why not also have comments about w5100, encxxx, etc.? IMHO these kind of comments don't belong here.
|
As said in #6971, it would be nice if there's written somewhere that Also, that the UART can be specified through: XBEE_UART ?= "1"
CFLAGS += -DXBEE_PARAM_UART=$(XBEE_UART) |
|
@kYc0o see my comment above: I don't think this belongs here. But feel free to create a wiki page about the |
I disagree with the wiki page. Why not adding this documentation in the xbee.h driver file as doxygen documentation ? |
|
Because this kind of documentation is not specific to the xbee. I mean, we also don't put information on how to use a device in the default example to every single sensor driver that supports SAUL... |
|
Thinking from a newcomer with a Xbee module point of view, his first question will be how can I use it with or something similar. Putting it in the doxygen is imho better regarding code and documentation maintenance.
Sure, but I don't see this as a good reason for not doing it here. We always have to start somewhere. |
Yes, very true. But the same is true for many other boards/network devices/misc modules. So I think we should find a way to gracefully 'educate' the newcomers to understand our basic concepts, instead of giving them copy-paste instructions for every single peace of code we include. Don't get me wrong, I am not whatsoever going against elaborate documentation here, I am just thinking that we should focus on more generic parts (where applicable) instead of doing things that are not going to scale... |
Fine with me. Regarding documentation, I would definitely prefer to find all documentation in a single place. Doxygen is made for that and today RIOT has very nice api doc style (thanks @miri64). For example, we could even imagine to move all boards description from the wiki to Doxygen. But for now, we can just keep the comment (with |
no :-) Thats exactly what I don't want. Then the next person puts an out-commented |
Well, there is this invention from the 60s we could use: Hypertext ;-P |
|
What I mean: we could write a doc page for our doxygen documentation (e.g. "How to enable pluggable devices"), list all devices we support that fall into that category there and link to there any time this is applicable (or at least in the examples most beginners go into first, like e.g. gnrc_networking) |
Makes a lot of sense +1, let's do this documentation job in follow-up PRs |
|
opened #7001 to keep track of the |
Alternative to #6971
There is no need in configuring the xbee to use
UART_DEV(1)in these Makefiles, as it is configured to use this UART per default -> seedrivers/xbee/include/xbee_params.h.