From 1e0f3b396a12aef6b5ff471a9f2651942c86b582 Mon Sep 17 00:00:00 2001 From: "Nate Bargmann, N0NB" Date: Sat, 7 Mar 2009 03:30:17 +0000 Subject: [PATCH] Update files for SVN information and commands. git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@2675 7ae35d74-ebe9-4afe-98af-79ac388436b8 --- README | 4 +-- README.betatester | 20 ++++++------ README.developer | 78 ++++++++++++++++++++++++----------------------- README.release | 16 +++++----- 4 files changed, 61 insertions(+), 57 deletions(-) diff --git a/README b/README index 87123f9da..4963165eb 100644 --- a/README +++ b/README @@ -1,6 +1,6 @@ Hamlib - (C) Frank Singleton 2000 (vk3fcs@ix.netcom.com) (C) Stephane Fillod 2000-2007 - (C) The Hamlib Group 2000-2008 + (C) The Hamlib Group 2000-2009 The purpose of this project is to provide stable, flexible, shared libraries that enable quicker development of Amateur @@ -88,7 +88,7 @@ available at the sourceforge.net site. Enjoy! Take a look at tests/README for more info on simple examples. Also, take a look at http://sourceforge.net/projects/hamlib/ -Here you will find a mail list, and the latest CVS releases. +Here you will find a mail list, and the latest releases. Feedback, questions, etc. about Hamlib are very welcome at the mail list: diff --git a/README.betatester b/README.betatester index f081078de..1a63e58da 100644 --- a/README.betatester +++ b/README.betatester @@ -19,17 +19,17 @@ Feedback and improvement requests are also valuable. First of all, you can start testing official releases. They are easier to test because they come in precompiled and packaged (.rpm, .deb) but they -have the drawback of being older than the CVS repository. Reports from these +have the drawback of being older than the SVN repository. Reports from these versions are still very appreciated, on hamlib-developer@lists.sourceforge.net mailing list. However, the development of Hamlib is still very active, so it's better to -test from the latest CVS version of the code. And, depending on feedback you +test from the latest SVN version of the code. And, depending on feedback you make, developers can commit a fix, so you can try out the change soon after, without waiting for the next official version. So to proceed, you will have first to obtain either a snapshot or a check out -of the latest sources from cvs, then rebuild the Hamlib package and finally +of the latest sources from SVN, then rebuild the Hamlib package and finally test it with your rig. Don't worry, it's much simpler than how it looks, despite the size of the package. @@ -41,15 +41,15 @@ Pre-requisite: So here we go: -* Daily CVS snapshots: +* Daily SVN trunk snapshots: -Download the latest snapshot from http://n0nb.users.sourceforge.net -You'll find a tar ball with a name like hamlib-1.2.8.1cvs-20090109.tar.gz, -i.e. a check out made 09 Jan 2009, ready for building using the familiar +Download the latest SVN trunk snapshot from http://n0nb.users.sourceforge.net +You'll find a tar ball with a name like hamlib-1.2.10svn-20090306.tar.gz, +i.e. a check out made 06 Mar 2009, ready for building using the familiar "three step" (see below). Each morning by about 1130z a new snapshot is generated and uploaded and the prior day's version is removed. -The advantage of the CVS snapshot is that you won't need as many tools +The advantage of the SVN snapshot is that you won't need as many tools installed to build Hamlib as the work of Autoconf, Automake, and Libtool have already been done. Most of the other packages listed in README.developer will be needed unless you tell the `configure' script to not build certain @@ -57,10 +57,10 @@ parts of Hamlib like documentation or scripting language bindings. See `configure --help' for more information. -* CVS checkout: +* SVN checkout: Please read the beginning of README.developer file, especially about how to -obtain a cvs checkout, what are the required tools and versions (very +obtain a SVN checkout, what are the required tools and versions (very important or make won't even work!), and how to use autogen.sh. diff --git a/README.developer b/README.developer index 0c6d1ecd8..af54e738d 100644 --- a/README.developer +++ b/README.developer @@ -1,9 +1,9 @@ Hamlib - (C) Frank Singleton 2000 (vk3fcs@ix.netcom.com) (C) Stephane Fillod 2000-2007 - (C) The Hamlib Group 2000-2008 + (C) The Hamlib Group 2000-2009 Take a look at http://sourceforge.net/projects/hamlib/ -Here you will find a mail list, and the latest CVS releases. +Here you will find a mail list, and the latest SVN releases. See README for frontend/backend outline. @@ -49,10 +49,10 @@ I expect that IP, USB, and other connectivity will follow afterwards. General Guidelines. ------------------- -0. The top level directory looks like this as of 06 Jan 2008 +0. The top level directory looks like this as of 06 Mar 2009 (Note, it has grown considerably). -~/test/hamlib $ tree -d -I CVS +~/test/hamlib $ tree -d -I .svn . |-- alinco |-- aor @@ -67,6 +67,8 @@ General Guidelines. |-- flexradio |-- fodtrack |-- gnuradio +|-- gs232a +|-- heathkit |-- icom |-- include | `-- hamlib @@ -81,6 +83,7 @@ General Guidelines. |-- lowe |-- macros |-- microtune +|-- miniVNA |-- pcr |-- perl |-- racal @@ -106,7 +109,7 @@ General Guidelines. |-- wj `-- yaesu -51 directories +54 directories 1. Building @@ -115,31 +118,29 @@ If you just want to recompile the library, please refer to the INSTALL file. This document introduces hacking the code of Hamlib. -1.1 Obtaining sources: anonymous (pserver) cvs checkout +1.1 Obtaining sources: SVN trunk checkout - cvs -d:pserver:anonymous@hamlib.cvs.sourceforge.net:/cvsroot/hamlib login - cvs -z3 -d:pserver:anonymous@hamlib.cvs.sourceforge.net:/cvsroot/hamlib co -P hamlib +svn co https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk hamlib + +N.B.: If the "trunk" subdirectory is ommited then the entire SVN +reposity will be downloaded! This includes all branches and tags that +have ever been created in the hostory of Hamlib. That is quite large, +abut 22 MiB as of this writing (March 2009). -When prompted for a password for anonymous, simply press the Enter key. The check out has only to be done the first time. After the initial retrieval, whenever you want to update your local version, issue the following command in the root directory of hamlib. - cvs -z3 update -Pd - -This provides a level of data compression (values are from 0, off, to 9, full, -feel free to experiment) deletes empty directories (yes some do exist :-) ) -and adds any new directories added to the repository since your last -checkout. + svn update -1.1.1 Obtaining more info on CVS +1.1.1 Obtaining more info on SVN -Check out the sourceforge page at https://sourceforge.net/cvs/?group_id=8305 -for more information about how to use the CVS repository of Hamlib. +Check out the sourceforge page at https://sourceforge.net/svn/?group_id=8305 +for more information about how to use the SVN repository of Hamlib. -A CVS manual is online at http://ximbiot.com/cvs/manual/ +A SVN manual is online at http://svnbook.red-bean.com/ 1.2. Requirements @@ -150,14 +151,14 @@ has access to a POSIXish system to port Hamlib. Contact us for help. That is, if you want to take part in the development of Hamlib, you'll need the following tools. Make sure you have at least the required -version or you won't even be able to build from the cvs checkout. +version or you won't even be able to build from the SVN checkout. * Gnu C or any C99 compliant compiler # gcc --version * Gnu make (or any modern one, BSD okay) # make --version * autoconf 2.54 # autoconf --version * automake 1.7 # automake --version * libtool 1.5 # libtool --version -* cvs and ssh for connection to cvs.sourceforge.net +* svn for connection to hamlib.svn.sourceforge.net Optional: * GNU C++ # g++ --version @@ -187,9 +188,9 @@ it's recommended to upgrade to automake 1.7, which is a lot more stable. 1.3. configure and build stage -It has to be known the CVS repository holds no autogenerated files, i.e. -configure, config.guess, etc. Hence after a fresh checkout, you'll have to -generate those files. +It is important to note that the SVN repository holds no autogenerated +files, i.e. configure, config.guess, Makefile, etc. Hence after a fresh +checkout, you'll have to generate those files. To proceed, first edit the autogen.sh, and set appropriately the AUTOCONF, AUTOHEADER, AUTOHEADER, and ACLOCAL variables with the required versions @@ -288,13 +289,15 @@ So far, Hamlib has been tested successfully under the following systems: make in topdir to rebuild all - 2.6. Commit your work (developer access to Hamlib CVS required): - $ cvs add mybackend + 2.6. Commit your work (developer access to Hamlib SVN required): + (Please let N0NB know if the commands below are incorrect) + $ svn add mybackend $ cd mybackend - $ cvs add Makefile.am mybackend.c mybackend.h - $ cvs commit -m "Initial release" Makefile.am mybackend.c mybackend.h + (The following command might not be necessary) + $ svn add Makefile.am mybackend.c mybackend.h + $ svn commit -m "Initial release" Makefile.am mybackend.c mybackend.h - Note: The `-m' switch passes a short message to the CVS repository + Note: The `-m' switch passes a short message to the SVN repository upon a commit. If a longer message is desired, do not use the `-m' option. The editor specified in the EDITOR or VISUAL environment variables will be started where a more detailed message @@ -323,9 +326,8 @@ So far, Hamlib has been tested successfully under the following systems: Run `make' in topdir to rebuild all. 3.8. Commit your work (once tests are satisfactory): - $ cd mybackend - $ cvs add mymodel.c - $ cvs commit -m "added to " Makefile.am mybackend.c mybackend.h mymodel.c + $ svn add mybackend/mymodel.c + $ svn commit -m "added to " Makefile.am mybackend.c mybackend.h mymodel.c Note: See Note in section 2.6 above. @@ -405,7 +407,7 @@ Portability issues to watch: 8.3 Submitting patches -Patches should be in unified format (diff -u), against CVS head or +Patches should be in unified format (diff -u), against SVN head or latest release. This format makes it easily readable. The patches are to be sent to the hamlib-developer mailing list. If the file is too big, you can send it as a compressed @@ -413,15 +415,15 @@ attachement. 8.3.1 Changelog -Caveat: The cvs2cl.pl script is used before each release to generate +Caveat: The svn2cl program is used before each release to generate the Changelog file so any changes made directly to it WILL BE LOST! -Simply summarize your changes when the files are committed to CVS or, +Simply summarize your changes when the files are committed to SVN or, if providing patches to the mailing list, provide a summary so the uploader can include it in the commit message. -8.4 CVS commit access +8.4 SVN commit access -Generally, volunteers can get access to SourceForge Hamlib CVS upon +Generally, volunteers can get access to SourceForge Hamlib SVN upon asking one of the project administrators. Sometimes we'll ask you! However, before your start commiting, the project admins would like @@ -430,7 +432,7 @@ the Hamlib approach (c.f. previous section on submitting a patch). Then you'll be able to commit by yourself to the backend you have maintainance of. Please follow the rules hereunder: - * Always keep the CVS repository in a compilable state. + * Always keep the SVN trunk repository in a compilable state. * Follow the coding guidelines * Touching the frontend (files in src/ and include/hamlib) always requires discussion beforehand on the hamlib-developer list. diff --git a/README.release b/README.release index dbad0e4e4..69b9ef88a 100644 --- a/README.release +++ b/README.release @@ -2,6 +2,8 @@ This file is a release HOWTO, more or less a reminder before releasing a new version of Hamlib. +TODO: With the switch to SVN SCM discuss the use of tags and branches + for releases. Before deciding release: ----------------------- @@ -10,7 +12,7 @@ Before deciding release: Basically, this is making sure the package will compile on a whole breed of systems (arch,OS,library,gcc,etc. combo), that there's no regression, and the API evolution is managed well. -* Announce cvs/version freeze on hamlib-developer mailing list, +* Announce CVN/version freeze on hamlib-developer mailing list, so developers have time to check in their contributions. * Update libtool: macros/{ltdl,libtool}.m4 @@ -23,11 +25,11 @@ Releasing Hamlib: * Update NEWS, TODO, AUTHORS * Update the version in the macro AC_INIT of configure.ac * Regenerate ChangeLog with: - TZ=UTC ./cvs2cl.pl -* Tag the CVS rep with version 'HAMLIB-x-y-z' + TZ=UTC svn2cl +* Tag the SVN rep with version 'HAMLIB-x-y-z' * Build source tarball: - cvs -d:ext:yourloginhere@hamlib.cvs.sourceforge.net:/cvsroot/hamlib co -P -r HAMLIB-x-y-z hamlib - sh autogen.sh --enable-maintainer-mode + svn co https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk hamlib + sh autogen.sh --enable-maintainer-mode make dist * Build Windows DLL from previous tarball, and .LIB, then create .zip file Rem: under Linux, you need the package mingw32 to cross-compile it, @@ -61,7 +63,7 @@ Releasing Hamlib: * Update http://hamlib.org web pages - Download section hamlib.org: html.hamlib/{manual,news,download}.html - cvs commit + svn commit wsmake scp *.html shell.sourceforge.net:/home/groups/h/ha/hamlib/htdocs/. support.html @@ -87,7 +89,7 @@ To advertise: Get ready for the next round: -* Bump version number and append 'cvs' to it in macro AC_INIT of configure.ac +* Bump version number and append 'svn' to it in macro AC_INIT of configure.ac * Update src/Makefile.am revision of -version-info