lwIP - A Lightweight TCP/IP stack - Tasks: task #7068, lwIP docs: Update, improve, add...
You are not allowed to post comments on this tracker with your current authentication level.
task #7068: lwIP docs: Update, improve, add documentation about using lwIP
Submitter: | Jared Grubb <jgrubb> | ||
Submitted: | Mon 09 Jul 2007 04:47:20 PM UTC | ||
Category: | Documentation | Should Start On: | Mon 09 Jul 2007 07:00:00 AM UTC |
Should be Finished on: | Mon 09 Jul 2007 07:00:00 AM UTC | Priority: | 7 - High |
Status: | None | Privacy: | Public |
Assigned to: | None | Percent Complete: | 0% |
Open/Closed: | Closed | Planned Release: | 1.3.0 |
Effort: | 0.00 |
Jump to the original submission
Sun 04 Nov 2007 11:43:13 AM UTC, comment #34: |
Simon Goldschmidt <goldsimon> |
Fri 02 Nov 2007 08:07:53 PM UTC, comment #33: Sounds good to me! |
Jared Grubb <jgrubb> |
Fri 02 Nov 2007 06:51:22 PM UTC, comment #32: Since now, http://lwip.scribblewiki.com seems to be accessible to most of users, and since most of active developers have an account on it, I propose to close this task to avoid to have multiple place to centralize the documentation. No objections?
|
Frédéric Bernon <fbernon> |
Wed 25 Jul 2007 01:09:46 PM UTC, comment #31: Wireshark's wiki can also provide some useful informations. Some examples :
|
Frédéric Bernon <fbernon> |
Fri 20 Jul 2007 03:08:19 PM UTC, comment #30: We've been making good progress on the doc project at the Wiki. If you havent looked at it in a few days, check it out. I have started to go through the protocols, starting with ARP:
|
Jared Grubb <jgrubb> |
Wed 18 Jul 2007 03:08:54 PM UTC, comment #29:
release
|
Jared Grubb <jgrubb> |
Wed 18 Jul 2007 12:28:04 PM UTC, comment #28: I think a block of links in the wiki ("outside" the lwIP ones) can be useful, for generic TCP/IP, network, references, C language, etc...
|
Frédéric Bernon <fbernon> |
Wed 18 Jul 2007 08:06:44 AM UTC, comment #27: About wiki, I think it's good for cooperative edition, but I don't feel that very good if you want to print the doc (to read it on the beach by example... ;). So, question, is it possible with scribblewiki to "extract" files documentation in html if we want to produce any off-line doc?
|
Frédéric Bernon <fbernon> |
Tue 17 Jul 2007 10:58:00 PM UTC, comment #26: (of course we can undo the wiki at any point if you all object or want it somewhere else) |
Jared Grubb <jgrubb> |
Tue 17 Jul 2007 10:53:30 PM UTC, comment #25: Good news! I finally found a couple free wiki hosting sites. I looked for common features and decent support (i.e., needs to use MediaWiki 1.10), and decided this one seemed to support what we want to do.
|
Jared Grubb <jgrubb> |
Mon 16 Jul 2007 09:23:15 PM UTC, comment #24:
|
Jared Grubb <jgrubb> |
Mon 16 Jul 2007 08:33:41 PM UTC, comment #23:
|
Simon Goldschmidt <goldsimon> |
Mon 16 Jul 2007 07:43:46 PM UTC, comment #22: If we use HTML for our docs, then the changes would have to be submitted via CVS.
|
Jared Grubb <jgrubb> |
Mon 16 Jul 2007 07:39:41 PM UTC, comment #21: How do we submit changes/extensions to the docs, do you commit them to CVS? |
Simon Goldschmidt <goldsimon> |
Mon 16 Jul 2007 01:52:43 AM UTC, comment #20: |
Jared Grubb <jgrubb> |
Sun 15 Jul 2007 04:28:03 PM UTC, comment #19: Attached is a draft for the netif management section for application developers. The formatting is a bit awkward until we make a nice-looking CSS for the docs.
|
Jared Grubb <jgrubb> |
Sat 14 Jul 2007 04:59:56 PM UTC, comment #18: ( I did contact Adam and received permission to use his materials a base for our docs ) |
Jared Grubb <jgrubb> |
Sat 14 Jul 2007 03:53:51 PM UTC, comment #17: Attached:
|
Jared Grubb <jgrubb> |
Sat 14 Jul 2007 03:11:45 PM UTC, comment #16: About HTTP server sample, I should be good to add the same with socket layer (even if it can be more usual).
|
Frédéric Bernon <fbernon> |
Sat 14 Jul 2007 08:28:25 AM UTC, comment #15: I like your changes, Frederic. |
Jared Grubb <jgrubb> |
Sat 14 Jul 2007 08:14:07 AM UTC, comment #14: I propose you another "topics" documentation. The difference is mainly in the "application documentation", because I think it's not useful to explain pbuf to a socket users by example, etc... The idea is "read only what you need", but, this is not very different from yours...
|
Frédéric Bernon <fbernon> |
Sat 14 Jul 2007 01:32:45 AM UTC, comment #13: Attached is a draft HTML file that will be the top-level document for lwIP documenation. I propose will go in lwip/doc directory.
|
Jared Grubb <jgrubb> |
Fri 13 Jul 2007 10:09:57 PM UTC, comment #12: I marked the doc as "Approved" and now it appears at the bottom of the "Docs" page. How did someone add the categories for bugs/tasks/etc? Should be the same process, no? |
Jared Grubb <jgrubb> |
Fri 13 Jul 2007 10:05:22 PM UTC, comment #11: Ok, we can see it, but it's not an easy access. Kieran, is it possible to change this part of the documentation menu? I see that doing a filter on "Category" could work (other don't seems to be supported by Savannah and give php errors), but there is only "None" in the "Category" list...
|
Frédéric Bernon <fbernon> |
Fri 13 Jul 2007 06:28:43 PM UTC, comment #10: I have attempted to add the CVS PDF you posted to teh "Documentation" tree. Can you see it? You may have to go to "Edit" in order to see the list. |
Jared Grubb <jgrubb> |
Fri 13 Jul 2007 04:24:19 PM UTC, comment #9: (another addition, per a note from Frederic, on explaining debugs: http://lists.gnu.org/archive/html/lwip-users/2007-06/msg00027.html) |
Jared Grubb <jgrubb> |
Fri 13 Jul 2007 01:32:35 PM UTC, comment #8: There is a "Documentation" part in the web main menu, but with links like "Delays on update", "Markup Reminder", etc... Isn't it possible to use it to post lwIP documentations? |
Frédéric Bernon <fbernon> |
Fri 13 Jul 2007 11:37:25 AM UTC, comment #7: If you could check this into the apps directory in the contrib module, that would be great. |
Kieran Mansley <kieranm> |
Thu 12 Jul 2007 05:56:51 PM UTC, comment #6: Frederic pointed out a bug in the HTTP code (need to call netconn_delete(newconn) instead of netconn_delete(conn) -- I moved the call out of http_server_serve and forgot to change it)
|
Jared Grubb <jgrubb> |
Thu 12 Jul 2007 05:35:54 PM UTC, comment #5: Attached is an example HTTP server, based on the original in Adam's PDF, but updated to match current API (most notably the call to netbuf_delete!). Of course, I think I did it all right, but someone else should look over this just to make sure. |
Jared Grubb <jgrubb> |
Tue 10 Jul 2007 05:22:14 PM UTC, comment #4:
What!!! opts.h is not clear enought? ;) The two first links in comment #2 give some tips, but it's not a full guidelines...
|
Frédéric Bernon <fbernon> |
Tue 10 Jul 2007 05:01:07 PM UTC, comment #3: I would love to see the flowcharts.
|
Jared Grubb <jgrubb> |
Tue 10 Jul 2007 07:35:37 AM UTC, comment #2: Mumtaz Ahmad had provided to users who ask him his flow charts, and they are a good help. I will ask him if he can post them here.
|
Frédéric Bernon <fbernon> |
Tue 10 Jul 2007 06:55:56 AM UTC, comment #1: The PDF is a good start!
|
Simon Goldschmidt <goldsimon> |
Mon 09 Jul 2007 04:47:20 PM UTC, original submission:
As a newcomer to lwIP, the docs are MUCH better than the competition out there, but more documentation on how to use lwIP would be useful. The learning curve is not bad, but it could be improved. I see the following areas of improvement:
|
Jared Grubb <jgrubb> |
Depends on the following items: None found
Items that depend on this one: None found
There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.
Follow 14 latest changes.
Date | Changed by | Updated Field | Previous Value | => | Replaced by |
---|---|---|---|---|---|
2007-11-04 | fbernon | Open/Closed | Open | Closed | |
2007-07-16 | jgrubb | Attached File | - | Added dev-port.html, #13351 | |
2007-07-15 | jgrubb | Attached File | - | Added app-netif.html, #13346 | |
2007-07-14 | jgrubb | Attached File | - | Added app-intro.html, #13340 | |
Attached File | - | Added app-pbuf.html, #13341 | |||
2007-07-14 | fbernon | Attached File | - | Added index.html, #13339 | |
2007-07-14 | jgrubb | Attached File | - | Added index.html, #13337 | |
2007-07-13 | kieranm | Priority | 5 - Normal | 7 - High | |
Planned Release | None | 1.3.0 | |||
2007-07-12 | jgrubb | Attached File | - | Added httpserver.c, #13312 | |
2007-07-12 | jgrubb | Attached File | - | Added httpserver.c, #13310 | |
2007-07-10 | fbernon | Attached File | - | Added lwip-doc.CVS_HEAD.pdf, #13279 | |
2007-07-09 | jgrubb | Attached File | - | Added rx_flow.tex, #13273 | |
Attached File | - | Added rx_flow.pdf, #13274 |
Powered by Savane 3.13-4448.
Corresponding source code
For this task (unlike the other two), I agree, since the summary is very geeric anyway (it doesn't remind us of something specific todo I mean).