From a94db2ed71cd1972ef3d597400c8cfb5302bdf3c Mon Sep 17 00:00:00 2001 From: likewise Date: Fri, 23 Apr 2004 15:18:49 +0000 Subject: [PATCH] Merged updated documentation from HEAD. --- doc/rawapi.txt | 5 +++++ doc/savannah.txt | 54 +++++++++++++++++++++++++++++++++++++++++------- 2 files changed, 51 insertions(+), 8 deletions(-) diff --git a/doc/rawapi.txt b/doc/rawapi.txt index 61a5edb9..2c88ca28 100644 --- a/doc/rawapi.txt +++ b/doc/rawapi.txt @@ -272,6 +272,11 @@ level of complexity of UDP, the interface is significantly simpler. Sets the remote end of the pcb. This function does not generate any network traffic, but only set the remote address of the pcb. +- err_t udp_disconnect(struct udp_pcb *pcb) + + Remove the remote end of the pcb. This function does not generate + any network traffic, but only removes the remote address of the pcb. + - err_t udp_send(struct udp_pcb *pcb, struct pbuf *p) Sends the pbuf p. The pbuf is not deallocated. diff --git a/doc/savannah.txt b/doc/savannah.txt index 99fe853f..d33dfdd0 100644 --- a/doc/savannah.txt +++ b/doc/savannah.txt @@ -2,16 +2,18 @@ Daily Use Guide for using Savannah for lwIP Table of Contents: -1 - Anonymous CVS checkouts and updates (to be elaborated) +1 - Obtaining lwIP from the CVS repository 2 - Committers/developers CVS access using SSH (to be written) 3 - Merging from DEVEL branch to main trunk (stable branch) 4 - How to release lwIP -1 Anonymous CVS checkouts and updates -------------------------------------- -Obtain lwIP from the CVS main trunk (stable) +1 Obtaining lwIP from the CVS repository +---------------------------------------- + +To perform an anonymous CVS checkout of the main trunk (this is where +bug fixes and incremental enhancements occur), do this: export CVS_RSH=ssh cvs -d:ext:anoncvs@subversions.gnu.org:/cvsroot/lwip checkout lwip @@ -19,15 +21,51 @@ cvs -d:ext:anoncvs@subversions.gnu.org:/cvsroot/lwip checkout lwip (If SSH asks about authenticity of the host, you can check the key fingerprint against http://savannah.nongnu.org/cvs/?group=lwip) -Or, obtain a specific release as follows: -cvs -d:ext:anoncvs@subversions.gnu.org:/cvsroot/lwip checkout -r STABLE-0_6_3 -d lwip-0.6.3 lwip +Or, obtain a stable branch (updated with bug fixes only) as follows: +cvs -d:ext:anoncvs@subversions.gnu.org:/cvsroot/lwip checkout -r STABLE-0_7 -d lwip-0.7 lwip -Or, obtain a development branch as follows: +Or, obtain a specific (fixed) release as follows: +cvs -d:ext:anoncvs@subversions.gnu.org:/cvsroot/lwip checkout -r STABLE-0_7_0 -d lwip-0.7.0 lwip + +Or, obtain a development branch (considered unstable!) as follows: cvs -d:ext:anoncvs@subversions.gnu.org:/cvsroot/lwip checkout -r DEVEL -d lwip-DEVEL lwip +3 Committers/developers CVS access using SSH +-------------------------------------------- + +The Savannah server uses SSH (Secure Shell) protocol 2 authentication and encryption. +As such, CVS commits to the server occur through a SSH tunnel for project members. +To create a SSH2 key pair in UNIX-like environments, do this: + +ssh-keygen -t dsa + +Under Windows, a recommended SSH client is "PuTTY", freely available with good +documentation and a graphic user interface. Use its key generator. + +Now paste the id_dsa.pub contents into your Savannah account public key list. Wait +a while so that Savannah can update its configuration (This can take minutes). + +Try to login using SSH: + +ssh -v your_login@subversions.gnu.org + +If it tells you: + +Authenticating with public key "your_key_name"... +Server refused to allocate pty + +then you could login; Savannah refuses to give you a shell - which is OK, as we +are allowed to use SSH for CVS only. Now, you should be able to do this: + +export CVS_RSH=ssh +cvs -d:ext:your_login@subversions.gnu.org:/cvsroot/lwip checkout lwip + +after which you can edit your local files with bug fixes or new features and +commit them. Make sure you know what you are doing when using CVS to make +changes on the repository. If in doubt, ask on the lwip-members mailing list. 3 Merging from DEVEL branch to main trunk (stable) ---------------------------------------------------------- +-------------------------------------------------- Merging is a delicate process in CVS and requires the following disciplined steps in order to prevent conflicts