FreeRTOS/Common/ethernet/lwIP_130/doc/savannah.txt

   1 Daily Use Guide for using Savannah for lwIP\r
   2 \r
   3 Table of Contents:\r
   4 \r
   5 1 - Obtaining lwIP from the CVS repository\r
   6 2 - Committers/developers CVS access using SSH (to be written)\r
   7 3 - Merging from DEVEL branch to main trunk (stable branch)\r
   8 4 - How to release lwIP\r
   9 \r
  10 \r
  11 \r
  12 1 Obtaining lwIP from the CVS repository\r
  13 ----------------------------------------\r
  14 \r
  15 To perform an anonymous CVS checkout of the main trunk (this is where\r
  16 bug fixes and incremental enhancements occur), do this:\r
  17 \r
  18 cvs -z3 -d:pserver:anonymous@cvs.sv.gnu.org:/sources/lwip checkout lwip\r
  19  \r
  20 Or, obtain a stable branch (updated with bug fixes only) as follows:\r
  21 cvs -z3 -d:pserver:anonymous@cvs.sv.gnu.org:/sources/lwip checkout \\r
  22   -r STABLE-0_7 -d lwip-0.7 lwip\r
  23 \r
  24 Or, obtain a specific (fixed) release as follows:\r
  25 cvs -z3 -d:pserver:anonymous@cvs.sv.gnu.org:/sources/lwip checkout \\r
  26   -r STABLE-0_7_0 -d lwip-0.7.0 lwip\r
  27 \r
  28 3 Committers/developers CVS access using SSH\r
  29 --------------------------------------------\r
  30 \r
  31 The Savannah server uses SSH (Secure Shell) protocol 2 authentication and encryption.\r
  32 As such, CVS commits to the server occur through a SSH tunnel for project members.\r
  33 To create a SSH2 key pair in UNIX-like environments, do this:\r
  34 \r
  35 ssh-keygen -t dsa\r
  36 \r
  37 Under Windows, a recommended SSH client is "PuTTY", freely available with good\r
  38 documentation and a graphic user interface. Use its key generator.\r
  39 \r
  40 Now paste the id_dsa.pub contents into your Savannah account public key list. Wait\r
  41 a while so that Savannah can update its configuration (This can take minutes).\r
  42 \r
  43 Try to login using SSH:\r
  44 \r
  45 ssh -v your_login@cvs.sv.gnu.org\r
  46 \r
  47 If it tells you:\r
  48 \r
  49 Authenticating with public key "your_key_name"...\r
  50 Server refused to allocate pty\r
  51 \r
  52 then you could login; Savannah refuses to give you a shell - which is OK, as we\r
  53 are allowed to use SSH for CVS only. Now, you should be able to do this:\r
  54 \r
  55 export CVS_RSH=ssh\r
  56 cvs -z3 -d:ext:your_login@cvs.sv.gnu.org:/sources/lwip co lwip\r
  57  \r
  58 after which you can edit your local files with bug fixes or new features and\r
  59 commit them. Make sure you know what you are doing when using CVS to make\r
  60 changes on the repository. If in doubt, ask on the lwip-members mailing list.\r
  61 \r
  62 (If SSH asks about authenticity of the host, you can check the key\r
  63  fingerprint against http://savannah.nongnu.org/cvs/?group=lwip)\r
  64 \r
  65 \r
  66 3 Merging from DEVEL branch to main trunk (stable)\r
  67 --------------------------------------------------\r
  68 \r
  69 Merging is a delicate process in CVS and requires the\r
  70 following disciplined steps in order to prevent conflicts\r
  71 in the future. Conflicts can be hard to solve!\r
  72 \r
  73 Merging from branch A to branch B requires that the A branch\r
  74 has a tag indicating the previous merger. This tag is called\r
  75 'merged_from_A_to_B'. After merging, the tag is moved in the\r
  76 A branch to remember this merger for future merge actions.\r
  77 \r
  78 IMPORTANT: AFTER COMMITTING A SUCCESFUL MERGE IN THE\r
  79 REPOSITORY, THE TAG MUST BE SET ON THE SOURCE BRANCH OF THE\r
  80 MERGE ACTION (REPLACING EXISTING TAGS WITH THE SAME NAME).\r
  81 \r
  82 Merge all changes in DEVEL since our last merge to main:\r
  83 \r
  84 In the working copy of the main trunk:\r
  85 cvs update -P -jmerged_from_DEVEL_to_main -jDEVEL \r
  86 \r
  87 (This will apply the changes between 'merged_from_DEVEL_to_main'\r
  88 and 'DEVEL' to your work set of files)\r
  89 \r
  90 We can now commit the merge result.\r
  91 cvs commit -R -m "Merged from DEVEL to main." \r
  92 \r
  93 If this worked out OK, we now move the tag in the DEVEL branch\r
  94 to this merge point, so we can use this point for future merges:\r
  95 \r
  96 cvs rtag -F -r DEVEL merged_from_DEVEL_to_main lwip \r
  97 \r
  98 4 How to release lwIP\r
  99 ---------------------\r
 100 \r
 101 First, checkout a clean copy of the branch to be released. Tag this set with\r
 102 tag name "STABLE-0_6_3". (I use release number 0.6.3 throughout this example).\r
 103 \r
 104 Login CVS using pserver authentication, then export a clean copy of the\r
 105 tagged tree. Export is similar to a checkout, except that the CVS metadata\r
 106 is not created locally. \r
 107 \r
 108 export CVS_RSH=ssh\r
 109 cvs -z3 -d:pserver:anonymous@cvs.sv.gnu.org:/sources/lwip checkout \\r
 110   -r STABLE-0_6_3 -d lwip-0.6.3 lwip\r
 111 \r
 112 Archive this directory using tar, gzip'd, bzip2'd and zip'd.\r
 113 \r
 114 tar czvf lwip-0.6.3.tar.gz lwip-0.6.3\r
 115 tar cjvf lwip-0.6.3.tar.bz2 lwip-0.6.3\r
 116 zip -r lwip-0.6.3.zip lwip-0.6.3\r
 117 \r
 118 Now, sign the archives with a detached GPG binary signature as follows:\r
 119 \r
 120 gpg -b lwip-0.6.3.tar.gz\r
 121 gpg -b lwip-0.6.3.tar.bz2\r
 122 gpg -b lwip-0.6.3.zip\r
 123 \r
 124 Upload these files using anonymous FTP:\r
 125 ncftp ftp://savannah.gnu.org/incoming/savannah/lwip\r
 126 \r
 127 ncftp>mput *0.6.3.*\r
 128 \r
 129 Additionally, you may post a news item on Savannah, like this:\r
 130 \r
 131 A new 0.6.3 release is now available here:\r
 132 http://savannah.nongnu.org/files/?group=lwip&highlight=0.6.3\r
 133 \r
 134 You will have to submit this via the user News interface, then approve\r
 135 this via the Administrator News interface.