From dd110309e59ab939622cce638ccfbf447a1dbddf Mon Sep 17 00:00:00 2001 From: sg Date: Wed, 3 Aug 2016 20:21:54 +0200 Subject: [PATCH] update some FILES list files --- FILES | 1 + doc/FILES | 5 ++++- src/FILES | 6 ++++-- src/netif/FILES | 19 ++++++------------- 4 files changed, 15 insertions(+), 16 deletions(-) diff --git a/FILES b/FILES index 66253196..e6e09989 100644 --- a/FILES +++ b/FILES @@ -1,4 +1,5 @@ src/ - The source code for the lwIP TCP/IP stack. doc/ - The documentation for lwIP. +test/ - Some code to test whether the sources do what they should. See also the FILES file in each subdirectory. diff --git a/doc/FILES b/doc/FILES index 05d356f4..e5885750 100644 --- a/doc/FILES +++ b/doc/FILES @@ -1,6 +1,9 @@ +doxygen/ - Configuration files and scripts to create the lwIP doxygen source + documentation (found at http://www.nongnu.org/lwip/) + savannah.txt - How to obtain the current development source code. contrib.txt - How to contribute to lwIP as a developer. rawapi.txt - The documentation for the core API of lwIP. Also provides an overview about the other APIs and multithreading. -snmp_agent.txt - The documentation for the lwIP SNMP agent. sys_arch.txt - The documentation for a system abstraction layer of lwIP. +ppp.txt - Documentation of the PPP interface for lwIP. diff --git a/src/FILES b/src/FILES index 952aeabb..0be0741d 100644 --- a/src/FILES +++ b/src/FILES @@ -1,13 +1,15 @@ api/ - The code for the high-level wrapper API. Not needed if you use the lowel-level call-back/raw API. +apps/ - Higher layer applications that are specifically programmed + with the lwIP low-level raw API. + core/ - The core of the TPC/IP stack; protocol implementations, memory and buffer management, and the low-level raw API. include/ - lwIP include files. -netif/ - Generic network interface device drivers are kept here, - as well as the ARP module. +netif/ - Generic network interface device drivers are kept here. For more information on the various subdirectories, check the FILES file in each directory. diff --git a/src/netif/FILES b/src/netif/FILES index 501edac3..a3ff431d 100644 --- a/src/netif/FILES +++ b/src/netif/FILES @@ -2,30 +2,23 @@ This directory contains generic network interface device drivers that do not contain any hardware or architecture specific code. The files are: -etharp.c - Implements the ARP (Address Resolution Protocol) over - Ethernet. The code in this file should be used together with - Ethernet device drivers. Note that this module has been - largely made Ethernet independent so you should be able to - adapt this for other link layers (such as Firewire). +ethernet.c + Shared code for Ethernet based interfaces. ethernetif.c An example of how an Ethernet device driver could look. This file can be used as a "skeleton" for developing new Ethernet network device drivers. It uses the etharp.c ARP code. -loopif.c - A "loopback" network interface driver. It requires configuration - through the define LWIP_LOOPIF_MULTITHREADING (see opt.h). +lowpan6.c + A 6LoWPAN implementation as a netif. slipif.c A generic implementation of the SLIP (Serial Line IP) protocol. It requires a sio (serial I/O) module to work. -lowpan6.c - 6LoWPAN implementation - ppp/ Point-to-Point Protocol stack The lwIP PPP support is based from pppd (http://ppp.samba.org) with huge changes to match code size and memory requirements for embedded - devices. Please read ppp/PPPD_FOLLOWUP for a detailed explanation. + devices. Please read /doc/ppp.txt and ppp/PPPD_FOLLOWUP for a detailed + explanation.