Re: [PATCH wpan-misc] website: inital commit

[Stefan Schmidt <stefan@datenfreihafen.org>]

Hello.

On 12/12/14 15:20, Alexander Aring wrote:
> On Fri, Dec 12, 2014 at 02:03:11PM +0000, Stefan Schmidt wrote:
>> Hello.
>>
>> Good to see this getting a bit more documented. Some remarks inline.
>>
>> On 12/12/14 14:47, Alexander Aring wrote:
>>> This is the initial commit for the website asciidoc framework of:
>>>
>>> http://wpan.cakelab.org/
>>>
>>> Signed-off-by: Alexander Aring <alex.aring@gmail.com>
>>> ---
>>>  website/.gitingore |   1 +
>>>  website/Makefile   |   5 +++
>>>  website/index.txt  | 128
>>> +++++++++++++++++++++++++++++++++++++++++++++++++++++
>>>  3 files changed, 134 insertions(+)
>>>  create mode 100644 website/.gitingore
>>>  create mode 100644 website/Makefile
>>>  create mode 100644 website/index.txt
>>>
>>> diff --git a/website/.gitingore b/website/.gitingore
>>> new file mode 100644
>>> index 0000000..dcaf716
>>> --- /dev/null
>>> +++ b/website/.gitingore
>>> @@ -0,0 +1 @@
>>> +index.html
>>> diff --git a/website/Makefile b/website/Makefile
>>> new file mode 100644
>>> index 0000000..cc090bc
>>> --- /dev/null
>>> +++ b/website/Makefile
>>> @@ -0,0 +1,5 @@
>>> +all:
>>> +	asciidoc -b html5 -a icons -a toc2 -a theme=flask index.txt
>>> +
>>> +clean:
>>> +	rm index.html
>>> diff --git a/website/index.txt b/website/index.txt
>>> new file mode 100644
>>> index 0000000..a7ab4bb
>>> --- /dev/null
>>> +++ b/website/index.txt
>>> @@ -0,0 +1,128 @@
>>> +linux-wpan
>>> +==========
>>> +Mailinglist <linux-wpan@vger.kernel.org>
>>> +
>>> +wpan-tools
>>> +----------
>>> +
>>> +To access the nl802154 netlink inteface you will need the wpan-tools.
>>> +
>>> +Dependencies:
>>> +
>>> +- netlink library http://www.infradead.org/~tgr/libnl/[libnl].
>> Better name it libnl-3 here as it does not work with libnl-1 and libnl-2
>>
> ok. I thought also about that.
>
> The original iw tool has backwards compat. to older libnl version. We
> could fix that inside the wpan-tools. But for now indeed libnl-3 is
> supported only. I will change to it and maybe we have also this
> backwards compat like iw.

I would say that really depends on how ugly this compat would be and how
many people are actually need it.
For now using libnl-3 only is fine I would say.
>>> +These tools contains:
>>> +
>>> +[horizontal]
>>> +*iwpan*:: based on the wireless
>>> http://wireless.kernel.org/en/users/Documentation/iw[iw] tool.
>>> +
>>> +Download
>>> +~~~~~~~~
>>> +For the last release check out
>>> http://wpan.cakelab.org/releases/[releases] page:
>>> +
>>> +http://wpan.cakelab.org/releases/
>>> +
>>> +Supported Hardware
>>> +------------------
>>> +
>>> +.Supported 802.15.4 Hardware
>>> +[cols="3,4,2,^2,12",options="header"]
>>> +|=============================================================
>>> +|Transceiver |Supported        |Driver     | Bus |Where to buy
>>> +|at86rf230   |no               |at86rf230? | SPI |
>>> +|at86rf231   |yes              |at86rf230  | SPI |
>>> http://downloads.qi-hardware.com/people/werner/wpan/web/[atben] Out of
>>> stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact
>>> http://en.qi-hardware.com/wiki/Main_Page[qi-hardware].
>>> +|at86rf233   |yes              |at86rf230  | SPI |
>>> http://openlabs.co/store/Raspberry-Pi-802.15.4-radio[openlabs]
>>> +|at86rf212   |yes              |at86rf230  | SPI |
>>> +|atusb       |not mainline yet |atusb      | USB |
>>> http://downloads.qi-hardware.com/people/werner/wpan/web/[atusb] Out of
>>> stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact
>>> http://en.qi-hardware.com/wiki/Main_Page[qi-hardware].
>>> +|=============================================================
>> Maybe mention the other drivers we have mainline here as well? CC2520 and
>> MRF24j40 are fully supported or not?
> Don't know about these transceivers I have CC2520 here but these are
> buildin inside some contiki nodes and I don't have any pinout headers
> for these.
>
> Specially MRF24j40 have some different types and I don't know which type
> is now supported. The driver maintainers can send patches to linux-wpan
> and I will apply changes to wpan-misc and generate a new website.

This sounds fair to me. People using the driver can better comment on this.

> For futher maybe we should add some "features" collumn because many of
> them doesn't support all driver callbacks.

I think this is a good idea.

regards
Stefan Schmidt