Re: [lwip-users] TCP client waiting for answer from server (Kieran Mansley)

[Walter Saegesser]

Hi Kieran / Simon

>> The Wiki (http://lwip.wikia.com/wiki/LwIP_Wiki) is thoroughly out of
>> date and I scarcely consult it.

> It shouldn't be.  Do you have an example of something that is wrong
> there?  If so, please let us know or even better just fix it. (Kieran)

Well, I did not say, there's something wrong. Just missing. E.g. there
is no release note for v1.3.2 and there was none for v1.4.0 until
yesterday. I have started a page for 1.4.0 and I also intend to do some
documentation for the rather radically changed sys_arch interface. But
about new features, bug fixes etc. I certainly do not know.
Further I did not find any hint on the changed interface for the netconn
API in v1.4.0. Maybe I looked in all the wrong places - but anyway, only
the compiler told me that something was wrong.

----

>> On the other hand no one except those
>> deeply involved in the project can actually do proper documentation.

> Now that's totally untrue. (Simon)

I understand your argument but can agree only partly. I have started to
improve the "Netconn API" documentation. But I don't do it very
confidently. I always come across the main drawback of any Wiki: Anyone
can write any humbug - not even viciously, but from ignorance. For
example: the "netconn_new_with_proto_and_callback" function. I don't
know what the "proto" parameter is for. And for the callback parameter
it's even worse.
- when is the callback invoked
- what is it intended for
- what do the parameters actually mean (except the first one, which is
clear).
I had burned many hours in trying to get something out of the callback,
but in the end gave up.
So then, how can you document what you don't thoroughly understand?
The concept of many people writing the documentation is welcome. But
there should or maybe even must be a supervisor, who approves or
disapproves the information given. Otherwise I fear that people will
sooner or later realize they cannot rely on the Wiki. Either they don't
find what they are looking for or they find that what they find they
better had not found ... 

Walter

********************************************************************************************************************************
This email message, including any attachments, is for the sole use of the 
intended recipient(s) and may contain 
confidential and privileged information. Any unauthorized review, use, 
disclosure or distribution is prohibited. 
If you are not the intended recipient, please contact the sender by reply 
e-mail and destroy all copies of the original message. 
[Delta Energy Systems]
********************************************************************************************************************************