Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

features/FEATURE_LWIP/lwip-interface/lwip/doc/savannah.txt@1:3deb71413561, 2017-07-20 (annotated)

Committer:
xuaner
Date:
Thu Jul 20 14:26:57 2017 +0000
Revision:
1:3deb71413561
Parent:
0:f269e3021894 
mbed_os

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 Daily Use Guide for using Savannah for lwIP
elessair 0:f269e3021894 2
elessair 0:f269e3021894 3 Table of Contents:
elessair 0:f269e3021894 4
elessair 0:f269e3021894 5 1 - Obtaining lwIP from the Git repository
elessair 0:f269e3021894 6 2 - Committers/developers Git access using SSH
elessair 0:f269e3021894 7 3 - Merging a development branch to master branch
elessair 0:f269e3021894 8 4 - How to release lwIP
elessair 0:f269e3021894 9
elessair 0:f269e3021894 10
elessair 0:f269e3021894 11
elessair 0:f269e3021894 12 1 Obtaining lwIP from the Git repository
elessair 0:f269e3021894 13 ----------------------------------------
elessair 0:f269e3021894 14
elessair 0:f269e3021894 15 To perform an anonymous Git clone of the master branch (this is where
elessair 0:f269e3021894 16 bug fixes and incremental enhancements occur), do this:
elessair 0:f269e3021894 17 git clone git://git.savannah.nongnu.org/lwip.git
elessair 0:f269e3021894 18
elessair 0:f269e3021894 19 Or, obtain a stable branch (updated with bug fixes only) as follows:
elessair 0:f269e3021894 20 git clone --branch DEVEL-1_4_1 git://git.savannah.nongnu.org/lwip.git
elessair 0:f269e3021894 21
elessair 0:f269e3021894 22 Or, obtain a specific (fixed) release as follows:
elessair 0:f269e3021894 23 git clone --branch STABLE-1_4_1 git://git.savannah.nongnu.org/lwip.git
elessair 0:f269e3021894 24
elessair 0:f269e3021894 25
elessair 0:f269e3021894 26 2 Committers/developers Git access using SSH
elessair 0:f269e3021894 27 --------------------------------------------
elessair 0:f269e3021894 28
elessair 0:f269e3021894 29 The Savannah server uses SSH (Secure Shell) protocol 2 authentication and encryption.
elessair 0:f269e3021894 30 As such, Git commits to the server occur through a SSH tunnel for project members.
elessair 0:f269e3021894 31 To create a SSH2 key pair in UNIX-like environments, do this:
elessair 0:f269e3021894 32 ssh-keygen -t dsa
elessair 0:f269e3021894 33
elessair 0:f269e3021894 34 Under Windows, a recommended SSH client is "PuTTY", freely available with good
elessair 0:f269e3021894 35 documentation and a graphic user interface. Use its key generator.
elessair 0:f269e3021894 36
elessair 0:f269e3021894 37 Now paste the id_dsa.pub contents into your Savannah account public key list. Wait
elessair 0:f269e3021894 38 a while so that Savannah can update its configuration (This can take minutes).
elessair 0:f269e3021894 39
elessair 0:f269e3021894 40 Try to login using SSH:
elessair 0:f269e3021894 41 ssh -v your_login@git.sv.gnu.org
elessair 0:f269e3021894 42
elessair 0:f269e3021894 43 If it tells you:
elessair 0:f269e3021894 44 Linux vcs.savannah.gnu.org 2.6.32-5-xen-686 #1 SMP Wed Jun 17 17:10:03 UTC 2015 i686
elessair 0:f269e3021894 45
elessair 0:f269e3021894 46 Interactive shell login is not possible for security reasons.
elessair 0:f269e3021894 47 VCS commands are allowed.
elessair 0:f269e3021894 48 Last login: Tue May 15 23:10:12 2012 from 82.245.102.129
elessair 0:f269e3021894 49 You tried to execute:
elessair 0:f269e3021894 50 Sorry, you are not allowed to execute that command.
elessair 0:f269e3021894 51 Shared connection to git.sv.gnu.org closed.
elessair 0:f269e3021894 52
elessair 0:f269e3021894 53 then you could login; Savannah refuses to give you a shell - which is OK, as we
elessair 0:f269e3021894 54 are allowed to use SSH for Git only. Now, you should be able to do this:
elessair 0:f269e3021894 55 git clone your_login@git.sv.gnu.org:/srv/git/lwip.git
elessair 0:f269e3021894 56
elessair 0:f269e3021894 57 After which you can edit your local files with bug fixes or new features and
elessair 0:f269e3021894 58 commit them. Make sure you know what you are doing when using Git to make
elessair 0:f269e3021894 59 changes on the repository. If in doubt, ask on the lwip-members mailing list.
elessair 0:f269e3021894 60
elessair 0:f269e3021894 61 (If SSH asks about authenticity of the host, you can check the key
elessair 0:f269e3021894 62 fingerprint against https://savannah.nongnu.org/git/?group=lwip
elessair 0:f269e3021894 63
elessair 0:f269e3021894 64
elessair 0:f269e3021894 65 3 - Merging a development branch to master branch
elessair 0:f269e3021894 66 -------------------------------------------------
elessair 0:f269e3021894 67
elessair 0:f269e3021894 68 Merging is a straightforward process in Git. How to merge all changes in a
elessair 0:f269e3021894 69 development branch since our last merge from main:
elessair 0:f269e3021894 70
elessair 0:f269e3021894 71 Checkout the master branch:
elessair 0:f269e3021894 72 git checkout master
elessair 0:f269e3021894 73
elessair 0:f269e3021894 74 Merge the development branch to master:
elessair 0:f269e3021894 75 git merge your-development-branch
elessair 0:f269e3021894 76
elessair 0:f269e3021894 77 Resolve any conflict.
elessair 0:f269e3021894 78
elessair 0:f269e3021894 79 Commit the merge result.
elessair 0:f269e3021894 80 git commit -a
elessair 0:f269e3021894 81
elessair 0:f269e3021894 82 Push your commits:
elessair 0:f269e3021894 83 git push
elessair 0:f269e3021894 84
elessair 0:f269e3021894 85
elessair 0:f269e3021894 86 4 How to release lwIP
elessair 0:f269e3021894 87 ---------------------
elessair 0:f269e3021894 88
elessair 0:f269e3021894 89 First, tag the release using Git: (I use release number 1.4.1 throughout
elessair 0:f269e3021894 90 this example).
elessair 0:f269e3021894 91 git tag -a STABLE-1_4_1
elessair 0:f269e3021894 92
elessair 0:f269e3021894 93 Share the tag reference by pushing it to remote:
elessair 0:f269e3021894 94 git push origin STABLE-1_4_1
elessair 0:f269e3021894 95
elessair 0:f269e3021894 96 Prepare the release:
elessair 0:f269e3021894 97 cp -r lwip lwip-1.4.1
elessair 0:f269e3021894 98 rm -rf lwip-1.4.1/.git lwip-1.4.1/.gitattributes
elessair 0:f269e3021894 99
elessair 0:f269e3021894 100 Archive the current directory using tar, gzip'd, bzip2'd and zip'd.
elessair 0:f269e3021894 101 tar czvf lwip-1.4.1.tar.gz lwip-1.4.1
elessair 0:f269e3021894 102 tar cjvf lwip-1.4.1.tar.bz2 lwip-1.4.1
elessair 0:f269e3021894 103 zip -r lwip-1.4.1.zip lwip-1.4.1
elessair 0:f269e3021894 104
elessair 0:f269e3021894 105 Now, sign the archives with a detached GPG binary signature as follows:
elessair 0:f269e3021894 106 gpg -b lwip-1.4.1.tar.gz
elessair 0:f269e3021894 107 gpg -b lwip-1.4.1.tar.bz2
elessair 0:f269e3021894 108 gpg -b lwip-1.4.1.zip
elessair 0:f269e3021894 109
elessair 0:f269e3021894 110 Upload these files using anonymous FTP:
elessair 0:f269e3021894 111 ncftp ftp://savannah.gnu.org/incoming/savannah/lwip
elessair 0:f269e3021894 112 ncftp> mput *1.4.1.*
elessair 0:f269e3021894 113
elessair 0:f269e3021894 114 Additionally, you may post a news item on Savannah, like this:
elessair 0:f269e3021894 115
elessair 0:f269e3021894 116 A new 1.4.1 release is now available here:
elessair 0:f269e3021894 117 http://savannah.nongnu.org/files/?group=lwip&highlight=1.4.1
elessair 0:f269e3021894 118
elessair 0:f269e3021894 119 You will have to submit this via the user News interface, then approve
elessair 0:f269e3021894 120 this via the Administrator News interface.