--- /dev/null
+Daily Use Guide for using Savannah for lwIP\r
+\r
+Table of Contents:\r
+\r
+1 - Obtaining lwIP from the CVS repository\r
+2 - Committers/developers CVS access using SSH (to be written)\r
+3 - Merging from DEVEL branch to main trunk (stable branch)\r
+4 - How to release lwIP\r
+\r
+\r
+\r
+1 Obtaining lwIP from the CVS repository\r
+----------------------------------------\r
+\r
+To perform an anonymous CVS checkout of the main trunk (this is where\r
+bug fixes and incremental enhancements occur), do this:\r
+\r
+cvs -z3 -d:pserver:anonymous@cvs.sv.gnu.org:/sources/lwip checkout lwip\r
+ \r
+Or, obtain a stable branch (updated with bug fixes only) as follows:\r
+cvs -z3 -d:pserver:anonymous@cvs.sv.gnu.org:/sources/lwip checkout \\r
+ -r STABLE-0_7 -d lwip-0.7 lwip\r
+\r
+Or, obtain a specific (fixed) release as follows:\r
+cvs -z3 -d:pserver:anonymous@cvs.sv.gnu.org:/sources/lwip checkout \\r
+ -r STABLE-0_7_0 -d lwip-0.7.0 lwip\r
+\r
+3 Committers/developers CVS access using SSH\r
+--------------------------------------------\r
+\r
+The Savannah server uses SSH (Secure Shell) protocol 2 authentication and encryption.\r
+As such, CVS commits to the server occur through a SSH tunnel for project members.\r
+To create a SSH2 key pair in UNIX-like environments, do this:\r
+\r
+ssh-keygen -t dsa\r
+\r
+Under Windows, a recommended SSH client is "PuTTY", freely available with good\r
+documentation and a graphic user interface. Use its key generator.\r
+\r
+Now paste the id_dsa.pub contents into your Savannah account public key list. Wait\r
+a while so that Savannah can update its configuration (This can take minutes).\r
+\r
+Try to login using SSH:\r
+\r
+ssh -v your_login@cvs.sv.gnu.org\r
+\r
+If it tells you:\r
+\r
+Authenticating with public key "your_key_name"...\r
+Server refused to allocate pty\r
+\r
+then you could login; Savannah refuses to give you a shell - which is OK, as we\r
+are allowed to use SSH for CVS only. Now, you should be able to do this:\r
+\r
+export CVS_RSH=ssh\r
+cvs -z3 -d:ext:your_login@cvs.sv.gnu.org:/sources/lwip co lwip\r
+ \r
+after which you can edit your local files with bug fixes or new features and\r
+commit them. Make sure you know what you are doing when using CVS to make\r
+changes on the repository. If in doubt, ask on the lwip-members mailing list.\r
+\r
+(If SSH asks about authenticity of the host, you can check the key\r
+ fingerprint against http://savannah.nongnu.org/cvs/?group=lwip)\r
+\r
+\r
+3 Merging from DEVEL branch to main trunk (stable)\r
+--------------------------------------------------\r
+\r
+Merging is a delicate process in CVS and requires the\r
+following disciplined steps in order to prevent conflicts\r
+in the future. Conflicts can be hard to solve!\r
+\r
+Merging from branch A to branch B requires that the A branch\r
+has a tag indicating the previous merger. This tag is called\r
+'merged_from_A_to_B'. After merging, the tag is moved in the\r
+A branch to remember this merger for future merge actions.\r
+\r
+IMPORTANT: AFTER COMMITTING A SUCCESFUL MERGE IN THE\r
+REPOSITORY, THE TAG MUST BE SET ON THE SOURCE BRANCH OF THE\r
+MERGE ACTION (REPLACING EXISTING TAGS WITH THE SAME NAME).\r
+\r
+Merge all changes in DEVEL since our last merge to main:\r
+\r
+In the working copy of the main trunk:\r
+cvs update -P -jmerged_from_DEVEL_to_main -jDEVEL \r
+\r
+(This will apply the changes between 'merged_from_DEVEL_to_main'\r
+and 'DEVEL' to your work set of files)\r
+\r
+We can now commit the merge result.\r
+cvs commit -R -m "Merged from DEVEL to main." \r
+\r
+If this worked out OK, we now move the tag in the DEVEL branch\r
+to this merge point, so we can use this point for future merges:\r
+\r
+cvs rtag -F -r DEVEL merged_from_DEVEL_to_main lwip \r
+\r
+4 How to release lwIP\r
+---------------------\r
+\r
+First, checkout a clean copy of the branch to be released. Tag this set with\r
+tag name "STABLE-0_6_3". (I use release number 0.6.3 throughout this example).\r
+\r
+Login CVS using pserver authentication, then export a clean copy of the\r
+tagged tree. Export is similar to a checkout, except that the CVS metadata\r
+is not created locally. \r
+\r
+export CVS_RSH=ssh\r
+cvs -z3 -d:pserver:anonymous@cvs.sv.gnu.org:/sources/lwip checkout \\r
+ -r STABLE-0_6_3 -d lwip-0.6.3 lwip\r
+\r
+Archive this directory using tar, gzip'd, bzip2'd and zip'd.\r
+\r
+tar czvf lwip-0.6.3.tar.gz lwip-0.6.3\r
+tar cjvf lwip-0.6.3.tar.bz2 lwip-0.6.3\r
+zip -r lwip-0.6.3.zip lwip-0.6.3\r
+\r
+Now, sign the archives with a detached GPG binary signature as follows:\r
+\r
+gpg -b lwip-0.6.3.tar.gz\r
+gpg -b lwip-0.6.3.tar.bz2\r
+gpg -b lwip-0.6.3.zip\r
+\r
+Upload these files using anonymous FTP:\r
+ncftp ftp://savannah.gnu.org/incoming/savannah/lwip\r
+\r
+ncftp>mput *0.6.3.*\r
+\r
+Additionally, you may post a news item on Savannah, like this:\r
+\r
+A new 0.6.3 release is now available here:\r
+http://savannah.nongnu.org/files/?group=lwip&highlight=0.6.3\r
+\r
+You will have to submit this via the user News interface, then approve\r
+this via the Administrator News interface.
\ No newline at end of file
projects / freertos / blobdiff