Replaced cvs with git references.
authormarkus schnalke <meillo@marmaro.de>
Mon, 26 Mar 2012 19:27:37 +0000 (21:27 +0200)
committermarkus schnalke <meillo@marmaro.de>
Mon, 26 Mar 2012 19:27:37 +0000 (21:27 +0200)
Merged from nmh. Thanks to David Levine.

docs/README.developers

index de32185..83b240c 100644 (file)
@@ -88,6 +88,11 @@ the nmh repository:
 
     % git clone git://git.savannah.nongnu.org/nmh.git
 
 
     % git clone git://git.savannah.nongnu.org/nmh.git
 
+That will create a workspace called nmh. To update that workspace
+with changes to the master, cd to it and run:
+
+    % git pull
+
 
 -------------------------------------------------------
 nmh-local functions to use in preference to OS versions
 
 -------------------------------------------------------
 nmh-local functions to use in preference to OS versions
@@ -116,20 +121,18 @@ is to use something like "1.0.4-RC1"):
     % date +"%e %B %Y" > DATE
     (DATE should contain something like "30 December 2000")
 
     % date +"%e %B %Y" > DATE
     (DATE should contain something like "30 December 2000")
 
- 2. Put a comment like "Released nmh-1.0.4." in the ChangeLog.
+ 2. % git commit VERSION DATE; git push
 
 
- 3. % cvs commit ChangeLog VERSION DATE
+ 3. % git tag -a nmh-1_0_4 -m 'Releasing nmh-1_0_4.'
 
 
- 4. % cvs tag nmh-1_0_4
-    (cvs treats dots specially, so underscores are substituted here.)
+ 4. % make nmhdist
 
 
- 5. % make nmhdist
+ 5. Untar nmh-1.0.4.tar.gz and `diff -r' it vs. your workspace.  Make
+    sure no files got left out of the distribution that should be in it
+    (due to someone forgetting to update the DIST variables in the
+    Makefiles).
 
 
- 6. Untar nmh-1.0.4.tar.gz and `diff -r' it vs. your CVS tree.  Make sure no
-    files got left out of the distribution that should be in it (due to someone
-    forgetting to update the DIST variables in the Makefiles).
-
- 7. If you have root access on your machine, it's good at this point to do:
+ 6. If you have root access on your machine, it's good at this point to do:
 
     % chown -R 0:0 nmh-1.0.4
     % tar cvf nmh-1.0.4.tar nmh-1.0.4
 
     % chown -R 0:0 nmh-1.0.4
     % tar cvf nmh-1.0.4.tar nmh-1.0.4
@@ -140,26 +143,23 @@ is to use something like "1.0.4-RC1"):
     making it possible for that user to Trojan the nmh code before the system
     administrator finishes installing it.
 
     making it possible for that user to Trojan the nmh code before the system
     administrator finishes installing it.
 
- 8. Make sure your new tarball uncompresses and untars with no problem.  Make
+ 7. Make sure your new tarball uncompresses and untars with no problem.  Make
     sure you can configure, make, and install nmh from it.
 
     sure you can configure, make, and install nmh from it.
 
- 9. If all is well and your tarball is final, go back to your CVS tree and do:
+ 8. If all is well and your tarball is final, go back to your workspace and do:
 
     % echo 1.0.4+dev > VERSION
 
 
     % echo 1.0.4+dev > VERSION
 
-10. Put a comment like "Upped the version number to 1.0.4+dev until the next nmh
-    release." in the ChangeLog.
-
-11. % cvs commit ChangeLog VERSION
+ 9. % git commit VERSION; git push
 
 
-12. If possible, make an MD5 hash and/or a PGP signature of nmh-1.0.4.tar.gz.
+10. If possible, make an MD5 hash and/or a PGP signature of nmh-1.0.4.tar.gz.
     Assuming you have gpg set up, this should be:
     % gpg --output nmh-1.0.4.tar.gz.sig --detach-sig nmh-1.0.4.tar.gz
 
     You can verify the signature with
     % gpg --verify nmh-1.0.4.tar.gz.sig nmh-1.0.4.tar.gz
 
     Assuming you have gpg set up, this should be:
     % gpg --output nmh-1.0.4.tar.gz.sig --detach-sig nmh-1.0.4.tar.gz
 
     You can verify the signature with
     % gpg --verify nmh-1.0.4.tar.gz.sig nmh-1.0.4.tar.gz
 
-13. Upload the files to savannah. First make sure they are mode 664 so
+11. Upload the files to savannah. First make sure they are mode 664 so
     they will have the right permissions on the server end
     (see https://savannah.gnu.org/maintenance/SharedDownloadArea)
     % chmod 664 nmh-1.0.4.tar.gz*
     they will have the right permissions on the server end
     (see https://savannah.gnu.org/maintenance/SharedDownloadArea)
     % chmod 664 nmh-1.0.4.tar.gz*
@@ -167,13 +167,13 @@ is to use something like "1.0.4-RC1"):
     Then scp them across:
     % scp -p nmh-1.0.4.tar.gz* youruser@dl.sv.nongnu.org:/releases/nmh/
 
     Then scp them across:
     % scp -p nmh-1.0.4.tar.gz* youruser@dl.sv.nongnu.org:/releases/nmh/
 
-14. Update the http://www.nongnu.org/nmh/ homepage. (It lives in the 'webpages
-    repository'; see https://savannah.nongnu.org/cvs/?group=nmh)
+12. Update the http://www.nongnu.org/nmh/ homepage. (It lives in the CVS
+    'webpages repository'; see https://savannah.nongnu.org/cvs/?group=nmh)
 
 
-15. Add a news item to the savannah nmh page. You'll have to submit it first
+13. Add a news item to the savannah nmh page. You'll have to submit it first
     and then separately approve it (under News->Manage).
 
     and then separately approve it (under News->Manage).
 
-16. Send the release announcement email to the following places:
+14. Send the release announcement email to the following places:
      nmh-workers@nongnu.org
      nmh-announce@nongnu.org
      exmh-users@redhat.com
      nmh-workers@nongnu.org
      nmh-announce@nongnu.org
      exmh-users@redhat.com
@@ -190,9 +190,10 @@ is to use something like "1.0.4-RC1"):
     Preferably, the announcement should contain the MD5 hash generated above,
     and should be PGP-signed.  It should include the URL for the tarball as
     well as the URL of the website.  It should contain a brief summary of
     Preferably, the announcement should contain the MD5 hash generated above,
     and should be PGP-signed.  It should include the URL for the tarball as
     well as the URL of the website.  It should contain a brief summary of
-    visible changes, as well as the URL of the cvsweb diff page that would show
-    a detailed list of changes.  The changes between 1.2 and 1.3 would be
-    shown by:
+    visible changes, as well as the URL of the git diff page that would show
+    a detailed list of changes.  The changes between 1.5 and 1.4 would be
+    shown by [this is just a guess, I don't know anything about cgit, and
+    it assumes that we tag with nmh-x_x-release from now on]:
 
 
-        http://cvs.savannah.gnu.org/viewvc/nmh/ChangeLog?root=nmh&r1=1.215&r2=1.254.2.13
+        http://git.savannah.gnu.org/cgit/nmh.git/diff/?h=nmh-1_5-release?h=nmh-1_4-release