From: <sm...@us...> - 2008-07-24 13:49:20
|
Revision: 8582 http://plplot.svn.sourceforge.net/plplot/?rev=8582&view=rev Author: smekal Date: 2008-07-24 13:49:28 +0000 (Thu, 24 Jul 2008) Log Message: ----------- Added some remarks and fixed some mistakes which I encountered testing the new homepage. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2008-07-24 13:48:49 UTC (rev 8581) +++ trunk/README.Release_Manager_Cookbook 2008-07-24 13:49:28 UTC (rev 8582) @@ -47,19 +47,22 @@ svn export https://plplot.svn.sourceforge.net/svnroot/plplot/trunk \ plplot_source cd /tmp/plplotdoc/build -cmake +cmake \ -DWWW_USER=username \ -DWWW_GROUP=group \ -DWWW_HOST=localhost \ -DWWW_DIR=/var/www/plplot/htdocs/docbook-manual \ -DCMAKE_VERBOSE_MAKEFILE=ON \ -DDEFAULT_NO_BINDINGS=ON -DDEFAULT_NO_DEVICES=ON \ --DPREBUILD_DIST=ON +-DPREBUILD_DIST=ON \ -DBUILD_DOC=ON \ ../plplot_source \ >& cmake.out make prebuild_dist >& make_prebuild.out +Install the documentation on the local machine: +cd /tmp/plplotdoc/build/doc/docbook/src +make www-install 2. In the root directory of a throwaway copy of the PLplot source tree (say /tmp/plplotdoc/plplot_source from step 1 above) execute the following This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2008-07-25 00:15:20
|
Revision: 8590 http://plplot.svn.sourceforge.net/plplot/?rev=8590&view=rev Author: airwin Date: 2008-07-25 00:15:29 +0000 (Fri, 25 Jul 2008) Log Message: ----------- Update documentation about how to build the website. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2008-07-24 22:09:09 UTC (rev 8589) +++ trunk/README.Release_Manager_Cookbook 2008-07-25 00:15:29 UTC (rev 8590) @@ -32,14 +32,14 @@ (N.B. each with the same prefix for WWW_DIR but with a deliberately different suffix for WWW_DIR): - 1. Build a local version of the documentation and install it to the - local copy of the PLplot webpage. + 1a. Build a local version of the documentation. N.B. this build puts some documentation results into the source tree so we use a throwaway source tree for this. - N.B. this build completely removes WWW_DIR on the local machine - (localhost) so be careful how you specify the -DWWW_DIR option! + N.B. The make www-install command below completely removes WWW_DIR on + the local machine (localhost) so be careful how you specify + the -DWWW_DIR option. rm -rf /tmp/plplotdoc mkdir -p /tmp/plplotdoc/build @@ -60,27 +60,32 @@ >& cmake.out make prebuild_dist >& make_prebuild.out -Install the documentation on the local machine: -cd /tmp/plplotdoc/build/doc/docbook/src + 1b. Install that documentation to the local copy of the PLplot webpage. + N.B. this command completely removes WWW_DIR on the local machine + (localhost) so be careful how you specify the above -DWWW_DIR option. + +cd /tmp/plplotdoc/build make www-install - 2. In the root directory of a throwaway copy of the PLplot source tree (say - /tmp/plplotdoc/plplot_source from step 1 above) execute the following - command: + 2. Generate examples and screenshots of those examples. - N.B. this command completely removes WWW_DIR on the local machine - (localhost) so be careful how you specify WWW_DIR! + N.B. this command completely removes WWW_DIR/htdocs/examples-data + on the local machine (localhost) so be careful how you specify WWW_DIR! +cd /tmp/plplotdoc/plplot_source WWW_USER=username \ WWW_GROUP=group \ WWW_HOST=localhost \ WWW_DIR=/var/www/plplot \ -./scripts/htdocs-gen_plot-examples.sh +scripts/htdocs-gen_plot-examples.sh >& htdocs_gen.out - 3. Then, in /tmp/plplotdoc/plplot_source/www execute the following command: + 3. Generate the website (other than the documentation and examples + done above). + N.B. this command removes certain files and subdirectories of + WWW_DIR on the local machine (localhost) so be careful how you + specify WWW_DIR! - N.B. this command completely removes WWW_DIR on the local machine - (localhost) so be careful how you specify WWW_DIR! +cd /tmp/plplotdoc/plplot_source/www make \ WWW_USER=username \ WWW_GROUP=group \ @@ -252,7 +257,7 @@ messages. Install the documentation on the PLplot website: -cd /tmp/plplot-dist-prep/build_dir/doc/docbook/src +cd /tmp/plplot-dist-prep/build_dir make www-install Sign the release with your plplot Release Manager gpg key: This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2008-09-20 06:11:40
|
Revision: 8784 http://plplot.svn.sourceforge.net/plplot/?rev=8784&view=rev Author: airwin Date: 2008-09-20 06:11:29 +0000 (Sat, 20 Sep 2008) Log Message: ----------- Add in rsync instructions for uploading the website from a local version. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2008-09-19 20:12:17 UTC (rev 8783) +++ trunk/README.Release_Manager_Cookbook 2008-09-20 06:11:29 UTC (rev 8784) @@ -37,7 +37,7 @@ to verify your answers, then does all the rest of it (downloading a throwaway copy of the PLplot source code, building the documentation, installing the documentation, building the examples, running the examples, -installing the examples, and building the remainder of the website) +installing the examples, and installing the remainder of the website) automatically. I (AWI) tested this script using the four answers Summary: @@ -54,10 +54,22 @@ documentation is there and all the previous problems with source code accessibility for the Ada, f77, and OCaml examples are now fixed. -N.B. SourceForge is no longer ssh-accessible. The SF documentation says -you should use rsync to upload local websites (such as the one created by -the above script) to SF, but I haven't tried that yet. +Once you are satisfied with the locall website, you can upload it to +SourceForge with rsync. I give the directions here, although you may want +to do this later (see below) in the release process. +For the above WEBSITE_PREFIX, here is what worked for me from my computer +with the hostname of raven where that WEBSITE_PREFIX directory was +created. + +rsync -av --delete \ +/home/irwin/public_html/plplot/htdocs/* \ +airwin,pl...@we...:htdocs + +Adjust for your username and WEBSITE_PREFIX. The ",plplot" part of the +username makes sure you have the right group permissions and default website +directory location for PLplot. + (3) Creating a test tarball from trunk This optional step is only required if you have some concerns about how @@ -296,8 +308,7 @@ N.B. SourceForge is no longer ssh accessible. Therefore, once you are satisfied with the local website, use rsync to upload it to -SourceForge. (AWI: still reading the SF documentation about how to -do that.) +SourceForge (see above). Immediate preparation for next release cycle This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2008-09-23 00:00:24
|
Revision: 8796 http://plplot.svn.sourceforge.net/plplot/?rev=8796&view=rev Author: airwin Date: 2008-09-23 00:00:19 +0000 (Tue, 23 Sep 2008) Log Message: ----------- Tweak rsync cookbook. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2008-09-22 23:43:36 UTC (rev 8795) +++ trunk/README.Release_Manager_Cookbook 2008-09-23 00:00:19 UTC (rev 8796) @@ -63,13 +63,22 @@ created. rsync -av --delete \ -/home/irwin/public_html/plplot/htdocs/* \ +/home/irwin/public_html/plplot/htdocs/ \ airwin,pl...@we...:htdocs Adjust for your username and WEBSITE_PREFIX. The ",plplot" part of the username makes sure you have the right group permissions and default website -directory location for PLplot. +directory location for PLplot. +N.B. the trailing slash on the source directory is essential and means rsync +the contents of this directory with the contents of the destination htdocs +directory. Without the trailing slash you would rsync the the contents of +the source directory with the contents of the htdocs/htdocs destination +directory which is not what you want to do. + +N.B. the --dry-run option for rsync is a god-send and tells you exactly what +will happen without actually doing it. + (3) Creating a test tarball from trunk This optional step is only required if you have some concerns about how This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: Alan W. I. <ai...@us...> - 2008-09-23 17:44:55
|
Revision: 8783 http://plplot.svn.sourceforge.net/plplot/?rev=8783&view=rev Author: airwin Date: 2008-09-19 20:12:17 +0000 (Fri, 19 Sep 2008) Log Message: ----------- Update instructions about creating local website. Instructions for using the new SourceForge rsync method to upload that result to SourceForge are still to come. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2008-09-19 19:46:01 UTC (rev 8782) +++ trunk/README.Release_Manager_Cookbook 2008-09-19 20:12:17 UTC (rev 8783) @@ -24,80 +24,40 @@ (2) Installing a Local Copy of the PLplot Webpage. -It can be convenient for testing purposes to install a local copy of the -PLplot webpage (http://plplot.sourceforge.net/index.html) on your machine. -The first step is to install Apache and PHP (if you don't already have -them). You will also need to be able to build PLplot with the cairo device -driver. After you have installed these items do the following three steps -(N.B. each with the same prefix for WWW_DIR but with a deliberately different -suffix for WWW_DIR): +It can be convenient for testing purposes to generate and install from +scratch a local copy of the PLplot website on some ssh-accessible machine +(normally your local machine). - 1a. Build a local version of the documentation. - - N.B. this build puts some documentation results into the source tree so - we use a throwaway source tree for this. - - N.B. The make www-install command below completely removes WWW_DIR on - the local machine (localhost) so be careful how you specify - the -DWWW_DIR option. +All you have to do is run (on a Linux host that is capable of building the +documentation) -rm -rf /tmp/plplotdoc -mkdir -p /tmp/plplotdoc/build -cd /tmp/plplotdoc -svn export https://plplot.svn.sourceforge.net/svnroot/plplot/trunk \ -plplot_source -cd /tmp/plplotdoc/build -cmake \ --DWWW_USER=username \ --DWWW_GROUP=group \ --DWWW_HOST=localhost \ --DWWW_DIR=/var/www/plplot/htdocs/docbook-manual \ --DCMAKE_VERBOSE_MAKEFILE=ON \ --DDEFAULT_NO_BINDINGS=ON -DDEFAULT_NO_DEVICES=ON \ --DPREBUILD_DIST=ON \ --DBUILD_DOC=ON \ -../plplot_source \ ->& cmake.out -make prebuild_dist >& make_prebuild.out - - 1b. Install that documentation to the local copy of the PLplot webpage. - N.B. this command completely removes WWW_DIR on the local machine - (localhost) so be careful how you specify the above -DWWW_DIR option. +scripts/generate_website.sh -cd /tmp/plplotdoc/build -make www-install +with no arguments. The script asks you four questions, gives you a chance +to verify your answers, then does all the rest of it (downloading a +throwaway copy of the PLplot source code, building the documentation, +installing the documentation, building the examples, running the examples, +installing the examples, and building the remainder of the website) +automatically. I (AWI) tested this script using the four answers - 2. Generate examples and screenshots of those examples. +Summary: +USERNAME = irwin +GROUPNAME = irwin +HOSTNAME = raven +WEBSITE_PREFIX = /home/irwin/public_html/plplot - N.B. this command completely removes WWW_DIR/htdocs/examples-data - on the local machine (localhost) so be careful how you specify WWW_DIR! +(raven is my local computer name, and /home/irwin/public_html is a location +where I can put various websites). I have both apache and PHP installed on +my local machine. Therefore, when I browse +http://raven/~irwin/plplot/htdocs/ (the website corresponding to the above +file prefix location), the result looks good. In particular, the Ada plplot +documentation is there and all the previous problems with source code +accessibility for the Ada, f77, and OCaml examples are now fixed. -cd /tmp/plplotdoc/plplot_source -WWW_USER=username \ -WWW_GROUP=group \ -WWW_HOST=localhost \ -WWW_DIR=/var/www/plplot \ -scripts/htdocs-gen_plot-examples.sh >& htdocs_gen.out +N.B. SourceForge is no longer ssh-accessible. The SF documentation says +you should use rsync to upload local websites (such as the one created by +the above script) to SF, but I haven't tried that yet. - 3. Generate the website (other than the documentation and examples - done above). - N.B. this command removes certain files and subdirectories of - WWW_DIR on the local machine (localhost) so be careful how you - specify WWW_DIR! - -cd /tmp/plplotdoc/plplot_source/www -make \ -WWW_USER=username \ -WWW_GROUP=group \ -WWW_HOST=localhost \ -WWW_DIR=/var/www/plplot/htdocs - -Where username and group are your username and group. - -If everything works as it should, you should be able to browse the local -site at: -http://127.0.0.1/plplot/htdocs/index.html - (3) Creating a test tarball from trunk This optional step is only required if you have some concerns about how @@ -256,10 +216,6 @@ to tags/vX_Y_Z in the merge process. These can be determined by commit messages. -Install the documentation on the PLplot website: -cd /tmp/plplot-dist-prep/build_dir -make www-install - Sign the release with your plplot Release Manager gpg key: gpg --default-key YYYYYYYY --detach-sign --armor /tmp/plplot-dist-prep/plplot-X.X.X.tar.gz @@ -328,16 +284,22 @@ Click on submit. Update the project web page, including the examples: -edit www/index.html to include a link to the latest release. -edit www/examples/index.html.in to reflect the current release number. +edit www/index.php to include a link to the latest release. +edit www/examples.php to reflect the current release number. svn commit the updated pages. -Create a directory containing a fresh svn checkout of PLplot, including the -www scripts. Run the following commands in that directory: -./scripts/htdocs-gen_plot-examples.sh -cd www -make +Generate and install a local copy of the website using +scripts/generate_website.sh + +(see comments above for exactly what this script does). + +N.B. SourceForge is no longer ssh accessible. Therefore, +once you are satisfied with the local website, use rsync to upload it to +SourceForge. (AWI: still reading the SF documentation about how to +do that.) + + Immediate preparation for next release cycle a. Append the README.release file from the current release onto the front of This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2008-10-25 19:28:23
|
Revision: 8966 http://plplot.svn.sourceforge.net/plplot/?rev=8966&view=rev Author: airwin Date: 2008-10-25 19:28:19 +0000 (Sat, 25 Oct 2008) Log Message: ----------- Tweak spelling. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2008-10-25 03:05:58 UTC (rev 8965) +++ trunk/README.Release_Manager_Cookbook 2008-10-25 19:28:19 UTC (rev 8966) @@ -54,7 +54,7 @@ documentation is there and all the previous problems with source code accessibility for the Ada, f77, and OCaml examples are now fixed. -Once you are satisfied with the locall website, you can upload it to +Once you are satisfied with the local website, you can upload it to SourceForge with rsync. I give the directions here, although you may want to do this later (see below) in the release process. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2011-03-17 19:46:09
|
Revision: 11638 http://plplot.svn.sourceforge.net/plplot/?rev=11638&view=rev Author: airwin Date: 2011-03-17 19:45:57 +0000 (Thu, 17 Mar 2011) Log Message: ----------- Make local website first since the source-tree changes associated with that process get into our release. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2011-03-17 19:15:22 UTC (rev 11637) +++ trunk/README.Release_Manager_Cookbook 2011-03-17 19:45:57 UTC (rev 11638) @@ -1,15 +1,121 @@ INDEX -(1) Creating a PLplot Release. -(2) Install and test a local copy of the PLplot website. -(3) Upload the local website to SourceForge. +(1) Install and test a local copy of the PLplot website. +(2) Upload the local website to SourceForge. +(3) Creating a PLplot Release. +(4) Publicity for the release announcement. +(5) Immediate preparation for next release cycle + (A1) GNU Privacy Guard (gpg). (A2) Creating a test tarball from trunk. +(1) Install and test a local copy of the PLplot website: ---- Main --- +(N.B. this step needs to be done first to insure the associated source tree +updates get into the release tarball, the svn tags version of the release, +and associated commit messages get into the ChangeLog for the +release.) -(1) Creating a PLplot Release: +You should always generate and install from scratch a local copy of the +PLplot website on some ssh-accessible machine (normally your local machine). +If necessary, update the examples list in +scripts/htdocs-gen_plot-examples.sh. That list is used to generate the +website example-related files and copy the results to the website. The list +automatically controls what example source code is configured (for source +code that needs that), as well as what example plots and example thumbnails +are generated. The list also automatically controls what examples-related +files are copied to the website. + +Update the project web page, including the examples: edit +www/examples.php to reflect the forthcoming release version number and +any changes to the examples themselves (i.e. pages added or removed +from an existing example or entirely new examples). + +Edit PROJECT_NUMBER in doc/Doxyfile.in to reflect the upcoming release +version number. (The doxygen documentation is now part of our +release so it is important to get the version number correct.) + +Run (on a Linux host that is capable of building the documentation +for the source tree that has all local changes) + +scripts/generate_website.sh + +with no arguments. The script asks you four questions, gives you a chance +to verify your answers, then does all the rest of it (downloading a +throwaway copy of the PLplot source code, building the documentation, +generating the announcements that are part of the base website, uploading +the base website, uploading the documentation, building the examples, +running the examples, uploading the example source code and example results) +automatically. I (AWI) tested this script using the four answers + +Summary: +USERNAME = irwin +GROUPNAME = irwin +HOSTNAME = raven +WEBSITE_PREFIX = /home/irwin/public_html/plplot + +(raven is my local computer name, and /home/irwin/public_html is a location +where I can put various websites). You can check for errors (e.g., due +to missing commands that need to be installed) by running + +find /tmp/plplotdoc -name '*.out' |xargs grep -i error + +You should install both apache and PHP on your computer. For Debian Testing +(a.k.a. squeeze) that is done (as root) by installing libapache2-mod-php5 +and enabling user directories using the command + +a2enmod userdir + +and editing /etc/apache2/mods-available/php5.conf as indicated in that +file to allow user directories for php. I am not sure, but I believe +from some google results I found that editing of that file is also +necessary on modern versions of Ubuntu in order to allow php-based websites +like that of PLplot to work when installed in local user directories. + +(When user directories are enabled this way, for the above case +/home/irwin/public_html/plplot/htdocs, browses as +http://raven/~irwin/plplot/htdocs/.) + +I test http://raven/~irwin/plplot/htdocs/ by clicking on most links, checking +the documentation looks good, checking the examples look good and the +source code for each language for examples is accessible, etc. + +N.B. scripts/generate_website.sh uses the local source tree where that +script resides (including all local changes) as the source tree for +generating the local website. So there is no need to commit every +above example and version change until you are completely satisfied +with the local website. But after you _are_ satisfied with the +local website you should commit all your changes so they are available +for generating the tarball and ChangeLog (see below) for this release. + +(2) Upload the local website to SourceForge: + +Once you are satisfied with the local website, you should upload it to +SourceForge with rsync. + +For the above WEBSITE_PREFIX, here is what worked for me from my computer +with the hostname of raven where that WEBSITE_PREFIX directory was +created. + +rsync -av --delete \ +/home/irwin/public_html/plplot/htdocs/ \ +airwin,pl...@we...:htdocs + +Adjust for your username and WEBSITE_PREFIX. The ",plplot" part of the +username makes sure you have the right group permissions and default website +directory location for PLplot. + +N.B. the trailing slash on the source directory is essential and means rsync +the contents of this directory with the contents of the destination htdocs +directory. Without the trailing slash you would rsync the the contents of +the source directory with the contents of the htdocs/htdocs destination +directory which is not what you want to do. + +N.B. the --dry-run option for rsync is a god-send and tells you exactly what +will happen without actually doing it. + +(3) Creating a PLplot Release: + Update the README.release file. Update the docbook documentation to reflect any new drivers or new @@ -20,7 +126,9 @@ follow the instructions in this file for updating the SOVERSION, the minor number and the patch number. -IMPORTANT: commit all local changes to the repository. +IMPORTANT: commit all local changes to the repository so they +will be reflected in the ChangeLog, tagged version of the release, +and release tarball. Prepare the ChangeLog.release file to keep track of all changes made for the release. (This destroys the ChangeLog.release file @@ -167,123 +275,22 @@ the release numbers. -Immediate preparation for next release cycle +(4) Publicity for the release announcement. +Jerry: macresearch.org + +Barbara Irwin: linuxtoday.com, lwn.net, lxer.com + +(5) Immediate preparation for next release cycle + a. Append the README.release file from the current release onto the front of the OLD-README.release file. This is done to preserve a record of the significant changes between versions of PLplot. b. Update README.release file to reflect significant changes made between the current release and the last release. -Update the web page following the instructions in sections (2) and (3) -Publicity for the release announcement. -Jerry: macresearch.org - -Barbara Irwin: linuxtoday.com, lwn.net, lxer.com - - -(2) Install and test a local copy of the PLplot website: - -You should always generate and install from scratch a local copy of the -PLplot website on some ssh-accessible machine (normally your local machine). - -If necessary, update the examples list in -scripts/htdocs-gen_plot-examples.sh. That list is used to generate the -website example-related files and copy the results to the website. The list -automatically controls what example source code is configured (for source -code that needs that), as well as what example plots and example thumbnails -are generated. The list also automatically controls what examples-related -files are copied to the website. - -Update the project web page, including the examples: edit -www/examples.php to reflect the forthcoming release version number and -any changes to the examples themselves (i.e. pages added or removed -from an existing example or entirely new examples). - -Edit PROJECT_NUMBER in doc/Doxyfile.in to reflect the release -version number. - -The above changes may be committed now or later in the release process -(see "IMPORTANT: commit all local changes to the repository." below) -since the script, scripts/generate_website.sh uses the local source -tree where that script resides (including all local changes) as the -source tree for generating the website.) - -Run (on a Linux host that is capable of building the documentation -for the source tree that has all local changes) - -scripts/generate_website.sh - -with no arguments. The script asks you four questions, gives you a chance -to verify your answers, then does all the rest of it (downloading a -throwaway copy of the PLplot source code, building the documentation, -generating the announcements that are part of the base website, uploading -the base website, uploading the documentation, building the examples, -running the examples, uploading the example source code and example results) -automatically. I (AWI) tested this script using the four answers - -Summary: -USERNAME = irwin -GROUPNAME = irwin -HOSTNAME = raven -WEBSITE_PREFIX = /home/irwin/public_html/plplot - -(raven is my local computer name, and /home/irwin/public_html is a location -where I can put various websites). You can check for errors (e.g., due -to missing commands that need to be installed) by running - -find /tmp/plplotdoc -name '*.out' |xargs grep -i error - -You should install both apache and PHP on your computer. For Debian Testing -(a.k.a. squeeze) that is done (as root) by installing libapache2-mod-php5 -and enabling user directories using the command - -a2enmod userdir - -and editing /etc/apache2/mods-available/php5.conf as indicated in that -file to allow user directories for php. I am not sure, but I believe -from some google results I found that editing of that file is also -necessary on modern versions of Ubuntu in order to allow php-based websites -like that of PLplot to work when installed in local user directories. - -(When user directories are enabled this way, for the above case -/home/irwin/public_html/plplot/htdocs, browses as -http://raven/~irwin/plplot/htdocs/.) - -I test http://raven/~irwin/plplot/htdocs/ by clicking on most links, checking -the documentation looks good, checking the examples look good and the -source code for each language for examples is accessible, etc. - - -(3) Upload the local website to SourceForge: - -Once you are satisfied with the local website, you should upload it to -SourceForge with rsync. - -For the above WEBSITE_PREFIX, here is what worked for me from my computer -with the hostname of raven where that WEBSITE_PREFIX directory was -created. - -rsync -av --delete \ -/home/irwin/public_html/plplot/htdocs/ \ -airwin,pl...@we...:htdocs - -Adjust for your username and WEBSITE_PREFIX. The ",plplot" part of the -username makes sure you have the right group permissions and default website -directory location for PLplot. - -N.B. the trailing slash on the source directory is essential and means rsync -the contents of this directory with the contents of the destination htdocs -directory. Without the trailing slash you would rsync the the contents of -the source directory with the contents of the htdocs/htdocs destination -directory which is not what you want to do. - -N.B. the --dry-run option for rsync is a god-send and tells you exactly what -will happen without actually doing it. - - --- Appendix --- (A1) GNU Privacy Guard (gpg) This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2008-10-26 16:31:18
|
Revision: 8973 http://plplot.svn.sourceforge.net/plplot/?rev=8973&view=rev Author: airwin Date: 2008-10-26 16:31:14 +0000 (Sun, 26 Oct 2008) Log Message: ----------- Clarify the directions on the optional test generation of the website. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2008-10-26 04:32:13 UTC (rev 8972) +++ trunk/README.Release_Manager_Cookbook 2008-10-26 16:31:14 UTC (rev 8973) @@ -22,9 +22,10 @@ (where 6C58D1AC is replaced with the appropriate value from the list-keys command) -(2) Installing a Local Copy of the PLplot Webpage. +(2) (Optional) Installing a Local Test Copy of the PLplot Webpage -It can be convenient for testing purposes to generate and install from +If there has been any changes in the documentation, examples, or the base +website itself, it is probably a good idea to generate and install from scratch a local copy of the PLplot website on some ssh-accessible machine (normally your local machine). @@ -36,8 +37,9 @@ with no arguments. The script asks you four questions, gives you a chance to verify your answers, then does all the rest of it (downloading a throwaway copy of the PLplot source code, building the documentation, -installing the documentation, building the examples, running the examples, -installing the examples, and installing the remainder of the website) +generating the announcements that are part of the base website, uploading +the base website, uploading the documentation, building the examples, +running the examples, uploading the example source code and example results) automatically. I (AWI) tested this script using the four answers Summary: @@ -55,8 +57,11 @@ accessibility for the Ada, f77, and OCaml examples are now fixed. Once you are satisfied with the local website, you can upload it to -SourceForge with rsync. I give the directions here, although you may want -to do this later (see below) in the release process. +SourceForge with rsync. I give the directions here, although you will +probably want to do this later (see below) in the actual release process +since there is some release link and version information that needs to +be updated for the actual release (see below) as opposed to this optional +test of the website generation. For the above WEBSITE_PREFIX, here is what worked for me from my computer with the hostname of raven where that WEBSITE_PREFIX directory was @@ -79,9 +84,9 @@ N.B. the --dry-run option for rsync is a god-send and tells you exactly what will happen without actually doing it. -(3) Creating a test tarball from trunk +(3) (Optional) Creating a test tarball from trunk -This optional step is only required if you have some concerns about how +This step is only required if you have some concerns about how recent changes may have affected the generated source tarball, and you want to generate that tarball and test it _before_ you create a tag for the release. (The release process for the tag below also generates a tarball This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hba...@us...> - 2008-12-15 02:22:04
|
Revision: 9108 http://plplot.svn.sourceforge.net/plplot/?rev=9108&view=rev Author: hbabcock Date: 2008-12-15 01:49:26 +0000 (Mon, 15 Dec 2008) Log Message: ----------- Update upload instructions. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2008-12-15 01:13:55 UTC (rev 9107) +++ trunk/README.Release_Manager_Cookbook 2008-12-15 01:49:26 UTC (rev 9108) @@ -253,19 +253,18 @@ Edit ChangeLog.release to be the appropriate date range (i.e. only the changes that were made since the last release should be included). +(See also: +http://alexandria.wiki.sourceforge.net/File+Release+System+-+Offering+Files+for+Download) Upload the plplot-X.X.X.tar.gz.* files to the SF upload section -ftp upload.sourceforge.net #username is ftp, password is your e-mail address -cd incoming -bin +sftp frs.sourceforge.net +cd uploads put plplot-X.X.X.tar.gz put plplot-X.X.X.tar.gz.asc quit -ftp does not provide any feedback re upload progress, so again, be patient. - Prepare a file release: Login to sf.net. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hba...@us...> - 2008-12-19 17:50:29
|
Revision: 9206 http://plplot.svn.sourceforge.net/plplot/?rev=9206&view=rev Author: hbabcock Date: 2008-12-19 17:50:25 +0000 (Fri, 19 Dec 2008) Log Message: ----------- Added a note about the location of intermediate output files for building the webpage. Updated instructions for getting the right version information on the webpage. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2008-12-19 17:12:37 UTC (rev 9205) +++ trunk/README.Release_Manager_Cookbook 2008-12-19 17:50:25 UTC (rev 9206) @@ -84,6 +84,10 @@ N.B. the --dry-run option for rsync is a god-send and tells you exactly what will happen without actually doing it. +N.B. log files for the website build can be found in the /tmp/plplotdoc/build +directory. This can be useful for finding problems with the build of the +website. + (3) (Optional) Creating a test tarball from trunk This step is only required if you have some concerns about how @@ -309,7 +313,6 @@ Click on submit. Update the project web page, including the examples: -edit www/index.php to include a link to the latest release. edit www/examples.php to reflect the current release number. svn commit the updated pages. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hba...@us...> - 2008-12-24 19:09:39
|
Revision: 9228 http://plplot.svn.sourceforge.net/plplot/?rev=9228&view=rev Author: hbabcock Date: 2008-12-24 19:09:36 +0000 (Wed, 24 Dec 2008) Log Message: ----------- Added a note about updating examples.php to reflect the current status of the examples in terms of number of pages, new examples, etc. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2008-12-24 18:41:29 UTC (rev 9227) +++ trunk/README.Release_Manager_Cookbook 2008-12-24 19:09:36 UTC (rev 9228) @@ -313,7 +313,9 @@ Click on submit. Update the project web page, including the examples: -edit www/examples.php to reflect the current release number. +edit www/examples.php to reflect the current release number and any changes +to the examples themselves (i.e. new examples and/or pages added or removed +from an existing example). svn commit the updated pages. Generate and install a local copy of the website using This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2009-01-20 22:27:03
|
Revision: 9361 http://plplot.svn.sourceforge.net/plplot/?rev=9361&view=rev Author: airwin Date: 2009-01-20 22:19:54 +0000 (Tue, 20 Jan 2009) Log Message: ----------- Insert complete instructions about updating examples lists relevant to the website generation. Reorganize work flow so website generation is only done once just before the formal file release at SourceForge. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2009-01-20 22:08:51 UTC (rev 9360) +++ trunk/README.Release_Manager_Cookbook 2009-01-20 22:19:54 UTC (rev 9361) @@ -1,8 +1,9 @@ INDEX (1) GNU Privacy Guard (gpg). -(2) Installing a Local Copy of the PLplot Webpage. -(3) Creating a test tarball from trunk. -(4) Creating a PLplot Release. +(2) Creating a test tarball from trunk. +(3) Install and test a local copy of the PLplot website. +(4) Upload the local website to SourceForge. +(5) Creating a PLplot Release. (1) GNU Privacy Guard (gpg) @@ -22,74 +23,8 @@ (where 6C58D1AC is replaced with the appropriate value from the list-keys command) -(2) (Optional) Installing a Local Test Copy of the PLplot Webpage +(2) (Optional) Creating a test tarball from trunk -If there has been any changes in the documentation, examples, or the base -website itself, it is probably a good idea to generate and install from -scratch a local copy of the PLplot website on some ssh-accessible machine -(normally your local machine). - -All you have to do is run (on a Linux host that is capable of building the -documentation) - -scripts/generate_website.sh - -with no arguments. The script asks you four questions, gives you a chance -to verify your answers, then does all the rest of it (downloading a -throwaway copy of the PLplot source code, building the documentation, -generating the announcements that are part of the base website, uploading -the base website, uploading the documentation, building the examples, -running the examples, uploading the example source code and example results) -automatically. I (AWI) tested this script using the four answers - -Summary: -USERNAME = irwin -GROUPNAME = irwin -HOSTNAME = raven -WEBSITE_PREFIX = /home/irwin/public_html/plplot - -(raven is my local computer name, and /home/irwin/public_html is a location -where I can put various websites). I have both apache and PHP installed on -my local machine. Therefore, when I browse -http://raven/~irwin/plplot/htdocs/ (the website corresponding to the above -file prefix location), the result looks good. In particular, the Ada plplot -documentation is there and all the previous problems with source code -accessibility for the Ada, f77, and OCaml examples are now fixed. - -Once you are satisfied with the local website, you can upload it to -SourceForge with rsync. I give the directions here, although you will -probably want to do this later (see below) in the actual release process -since there is some release link and version information that needs to -be updated for the actual release (see below) as opposed to this optional -test of the website generation. - -For the above WEBSITE_PREFIX, here is what worked for me from my computer -with the hostname of raven where that WEBSITE_PREFIX directory was -created. - -rsync -av --delete \ -/home/irwin/public_html/plplot/htdocs/ \ -airwin,pl...@we...:htdocs - -Adjust for your username and WEBSITE_PREFIX. The ",plplot" part of the -username makes sure you have the right group permissions and default website -directory location for PLplot. - -N.B. the trailing slash on the source directory is essential and means rsync -the contents of this directory with the contents of the destination htdocs -directory. Without the trailing slash you would rsync the the contents of -the source directory with the contents of the htdocs/htdocs destination -directory which is not what you want to do. - -N.B. the --dry-run option for rsync is a god-send and tells you exactly what -will happen without actually doing it. - -N.B. log files for the website build can be found in the /tmp/plplotdoc/build -directory. This can be useful for finding problems with the build of the -website. - -(3) (Optional) Creating a test tarball from trunk - This step is only required if you have some concerns about how recent changes may have affected the generated source tarball, and you want to generate that tarball and test it _before_ you create a tag for the @@ -144,8 +79,85 @@ where "display" is the general image viewer from the imagemagick suite of programmes. -(4) Creating a PLplot Release +(3) Install and test a local copy of the PLplot website. +You should always generate and install from scratch a local copy of the +PLplot website on some ssh-accessible machine (normally your local machine). + +If necessary, update the examples list in +scripts/htdocs-gen_plot-examples.sh. That list is used to generate the +website example-related files and copy the results to the website. The list +automatically controls what example source code is configured (for source +code that needs that), as well as what example plots and example thumbnails +are generated. The list also automatically controls what examples-related +files are copied to the website. + +Update the project web page, including the examples: edit www/examples.php +to reflect the forthcoming release number and any changes to the examples +themselves (i.e. pages added or removed from an existing example or entirely +new examples). + +svn commit the updated pages since the script below downloads directly +from the svn repository rather than working with any local files. + +Run (on a Linux host that is capable of building the documentation) + +scripts/generate_website.sh + +with no arguments. The script asks you four questions, gives you a chance +to verify your answers, then does all the rest of it (downloading a +throwaway copy of the PLplot source code, building the documentation, +generating the announcements that are part of the base website, uploading +the base website, uploading the documentation, building the examples, +running the examples, uploading the example source code and example results) +automatically. I (AWI) tested this script using the four answers + +Summary: +USERNAME = irwin +GROUPNAME = irwin +HOSTNAME = raven +WEBSITE_PREFIX = /home/irwin/public_html/plplot + +(raven is my local computer name, and /home/irwin/public_html is a location +where I can put various websites). I have both apache and PHP installed on +my local machine. Therefore, when I browse +http://raven/~irwin/plplot/htdocs/ (the website corresponding to the above +file prefix location), the result looks good. In particular, the Ada plplot +documentation is there and all the previous problems with source code +accessibility for the Ada, f77, and OCaml examples are now fixed. + +(4) Upload the local website to SourceForge. + +Once you are satisfied with the local website, you should upload it to +SourceForge with rsync. + +For the above WEBSITE_PREFIX, here is what worked for me from my computer +with the hostname of raven where that WEBSITE_PREFIX directory was +created. + +rsync -av --delete \ +/home/irwin/public_html/plplot/htdocs/ \ +airwin,pl...@we...:htdocs + +Adjust for your username and WEBSITE_PREFIX. The ",plplot" part of the +username makes sure you have the right group permissions and default website +directory location for PLplot. + +N.B. the trailing slash on the source directory is essential and means rsync +the contents of this directory with the contents of the destination htdocs +directory. Without the trailing slash you would rsync the the contents of +the source directory with the contents of the htdocs/htdocs destination +directory which is not what you want to do. + +N.B. the --dry-run option for rsync is a god-send and tells you exactly what +will happen without actually doing it. + +N.B. log files for the website build can be found in the /tmp/plplotdoc/build +directory. This can be useful for finding problems with the build of the +website. + +(5) Creating a PLplot Release + Update the README.release file. Update the docbook documentation to reflect any new drivers or new @@ -176,7 +188,6 @@ archive. Look for the thread titled "PLplot 5.7.2 is now available" dated Jan 22/23 2007. - Based on suggestions in the svn manual, the PLplot svn archive is configured as follows: @@ -234,7 +245,6 @@ above command finishes executing you should go to this directory and verify that the examples build and that plplot_test.sh executes without errors. - In the event that problems are found in PLplot during the release process, corrections should be made to trunk/ and then merged into the tags/vX_Y_Z branch as follows: @@ -303,7 +313,7 @@ monitoring the PLplot releases. Prepare the release notes: -Return the PLplot project page +Return to the PLplot project page Select Admin -> News Click on submit to create a new news item. Load an old release news item in another browser window and use that as a @@ -312,23 +322,6 @@ changed). Click on submit. -Update the project web page, including the examples: -edit www/examples.php to reflect the current release number and any changes -to the examples themselves (i.e. new examples and/or pages added or removed -from an existing example). -svn commit the updated pages. - -Generate and install a local copy of the website using - -scripts/generate_website.sh - -(see comments above for exactly what this script does). - -N.B. SourceForge is no longer ssh accessible. Therefore, -once you are satisfied with the local website, use rsync to upload it to -SourceForge (see above). - - Immediate preparation for next release cycle a. Append the README.release file from the current release onto the front of This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hba...@us...> - 2009-05-03 22:32:18
|
Revision: 9896 http://plplot.svn.sourceforge.net/plplot/?rev=9896&view=rev Author: hbabcock Date: 2009-05-03 22:32:11 +0000 (Sun, 03 May 2009) Log Message: ----------- Updated the release manager cookbook to reflect some changes in how things are done on the SF website. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2009-05-03 21:36:57 UTC (rev 9895) +++ trunk/README.Release_Manager_Cookbook 2009-05-03 22:32:11 UTC (rev 9896) @@ -283,8 +283,9 @@ Login to sf.net. Go to the PLplot project page. -Select file releases in the drop down admin menu at the top of the page. -Click add release at the bottom of the page. +Select "Download" from the list of links at the top of the page. +Click "Manage Packages / Releases" on the downloads page. +Click add release in the middle of the page. Enter the new release name and click "create this release". N.B. Release names guide our users to the release they want when they browse @@ -314,7 +315,7 @@ Prepare the release notes: Return to the PLplot project page -Select Admin -> News +Select Summary -> News Click on submit to create a new news item. Load an old release news item in another browser window and use that as a template for creating your new release news item. Make sure that you get @@ -330,4 +331,6 @@ b. Update README.release file to reflect significant changes made between the current release and the last release. +Update the web page following the instructions in sections (3) and (4) + DONE!!! This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2009-06-03 15:43:26
|
Revision: 10029 http://plplot.svn.sourceforge.net/plplot/?rev=10029&view=rev Author: airwin Date: 2009-06-03 15:43:17 +0000 (Wed, 03 Jun 2009) Log Message: ----------- Add specific reminders about who is doing publicity where for the release announcement. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2009-06-03 08:12:27 UTC (rev 10028) +++ trunk/README.Release_Manager_Cookbook 2009-06-03 15:43:17 UTC (rev 10029) @@ -333,4 +333,10 @@ Update the web page following the instructions in sections (3) and (4) +Publicity for the release announcement. + +Jerry: macresearch.org + +Barbara Irwin: linuxtoday.com, lwn.net, lxer.com + DONE!!! This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hba...@us...> - 2009-09-06 21:05:06
|
Revision: 10377 http://plplot.svn.sourceforge.net/plplot/?rev=10377&view=rev Author: hbabcock Date: 2009-09-06 21:04:55 +0000 (Sun, 06 Sep 2009) Log Message: ----------- Updated release instructions for the latest changes in the SF release infrastructure. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2009-09-06 20:40:17 UTC (rev 10376) +++ trunk/README.Release_Manager_Cookbook 2009-09-06 21:04:55 UTC (rev 10377) @@ -126,6 +126,7 @@ documentation is there and all the previous problems with source code accessibility for the Ada, f77, and OCaml examples are now fixed. + (4) Upload the local website to SourceForge. Once you are satisfied with the local website, you should upload it to @@ -156,6 +157,7 @@ directory. This can be useful for finding problems with the build of the website. + (5) Creating a PLplot Release Update the README.release file. @@ -226,7 +228,7 @@ cd tags/vX_Y_Z svn commit -m "Adding a tag for the X.Y.Z release." -cd to tags/ and enter the following command: +cd to tags/ and enter the following commands: export WWW_USER=your_sf_user_name ../trunk/scripts/make_tarball.sh -c -i /tmp/vX_Y_Z -t vX_Y_Z 2>&1 | tee build.log @@ -267,62 +269,38 @@ Edit ChangeLog.release to be the appropriate date range (i.e. only the changes that were made since the last release should be included). -(See also: -http://alexandria.wiki.sourceforge.net/File+Release+System+-+Offering+Files+for+Download) -Upload the plplot-X.X.X.tar.gz.* files to the SF upload section - -sftp frs.sourceforge.net -cd uploads -put plplot-X.X.X.tar.gz -put plplot-X.X.X.tar.gz.asc -quit - - Prepare a file release: Login to sf.net. -Go to the PLplot project page. -Select "Download" from the list of links at the top of the page. -Click "Manage Packages / Releases" on the downloads page. -Click add release in the middle of the page. -Enter the new release name and click "create this release". +Go to the PLplot SourceForge project page. -N.B. Release names guide our users to the release they want when they browse -our file release area. The source release names should be of the form -"5.x.y Source" (e.g., "5.6.1 Source"). The reason for this suggestion is to -keep source release names distinct from binary release names. +Upload the Release: +Select Project Admin / File Manager. +Right click on the plplot folder & select "New folder" from the pop-up menu. +Enter the release name as the "New folder name:", e.g. X.Y.Z Source. +Right click on the release folder & select "Uploads here". +Click on "Upload File" under File Manager & upload the source tarball and +the signature file. +Concatenate the README.release and ChangeLog.release files into a single +README.release file. +Click on "Upload File" again to upload the concatenated README.release file. +Click on this file and mark it as "Release Note". +Click on the source tarball & the signature file & select README.release in +the "Release Notes for this file" drop down menu. -In the file release GUI (Step1): -Browse to README.release in "Upload Release Notes". -Browse to ChangeLog.release in "Upload Change Log". -Select "preserve my pre-formatted text" -Click "Submit/Refresh" -In the file release GUI (Step2): -Select (and only select) the uploaded plplot files. -Click "Add Files and/or Refresh View" +Create a news item for the Release: +Select Develop / News +Click "Admin", select any older News Item and copy the test. +Click "Submit" + Enter "PLplot Release X.Y.Z" as the subject. + Paste in the text from the older release as the Details. + Be sure to update the text as appropriate, particularly + the release numbers. -In the edit file in release GUI (Step3): -For plplot-X.X.X.tar.gz select "any" for the processor type and "source.gz" for -the file type. -For plplot-X.X.X.tar.gz.asc select "any" for the processor type and -"other source" for the file type. -In the e-mail notification GUI (Step4): -Select that you are sure that you want to send an e-mail to those who are -monitoring the PLplot releases. -Prepare the release notes: -Return to the PLplot project page -Select Summary -> News -Click on submit to create a new news item. -Load an old release news item in another browser window and use that as a -template for creating your new release news item. Make sure that you get -the link to the release notes correct (none of the other links need to be -changed). -Click on submit. - Immediate preparation for next release cycle a. Append the README.release file from the current release onto the front of This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hba...@us...> - 2010-07-15 17:23:44
|
Revision: 11088 http://plplot.svn.sourceforge.net/plplot/?rev=11088&view=rev Author: hbabcock Date: 2010-07-15 17:23:38 +0000 (Thu, 15 Jul 2010) Log Message: ----------- Updates our document describing the release process to reflect recent changes at SF. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2010-07-13 21:18:52 UTC (rev 11087) +++ trunk/README.Release_Manager_Cookbook 2010-07-15 17:23:38 UTC (rev 11088) @@ -277,17 +277,23 @@ Upload the Release: Select Project Admin / File Manager. -Right click on the plplot folder & select "New folder" from the pop-up menu. +Click on the plplot folder & select "New folder" from the pop-up menu (the gear like +thing to the left of the plplot folder icon). Enter the release name as the "New folder name:", e.g. X.Y.Z Source. -Right click on the release folder & select "Uploads here". -Click on "Upload File" under File Manager & upload the source tarball and -the signature file. +Click on the release folder pop-up menu & select "Upload here", upload the +release and the gpg signature file from /tmp/plplot-dist-prep/. This can +take a few minutes without much feedback. Concatenate the README.release and ChangeLog.release files into a single README.release file. Click on "Upload File" again to upload the concatenated README.release file. Click on this file and mark it as "Release Note". -Click on the source tarball & the signature file & select README.release in -the "Release Notes for this file" drop down menu. +Click on the source tarball & the signature file pop menu icon and select +Properties. +Select README.release in the "Release Notes for this file" drop down menu. +Click on "Select All" for the platform set as default download (only do this +for the source tarball). +Click on the release folder pop-up menu icon, select properties and set +the release notes for the folder. Create a news item for the Release: This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2010-07-24 17:06:23
|
Revision: 11105 http://plplot.svn.sourceforge.net/plplot/?rev=11105&view=rev Author: airwin Date: 2010-07-24 17:06:17 +0000 (Sat, 24 Jul 2010) Log Message: ----------- Update instructions for website generation and testing. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2010-07-23 20:33:05 UTC (rev 11104) +++ trunk/README.Release_Manager_Cookbook 2010-07-24 17:06:17 UTC (rev 11105) @@ -119,14 +119,31 @@ WEBSITE_PREFIX = /home/irwin/public_html/plplot (raven is my local computer name, and /home/irwin/public_html is a location -where I can put various websites). I have both apache and PHP installed on -my local machine. Therefore, when I browse -http://raven/~irwin/plplot/htdocs/ (the website corresponding to the above -file prefix location), the result looks good. In particular, the Ada plplot -documentation is there and all the previous problems with source code -accessibility for the Ada, f77, and OCaml examples are now fixed. +where I can put various websites). You can check for errors (e.g., due +to missing commands that need to be installed) by running +find /tmp/plplotdoc -name '*.out' |xargs grep -i error +You should install both apache and PHP on your computer. For Debian Testing +(a.k.a. squeeze) that is done (as root) by installing libapache2-mod-php5 +and enabling user directories using the command + +a2enmod userdir + +and editing /etc/apache2/mods-available/php5.conf as indicated in that +file to allow user directories for php. I am not sure, but I believe +from some google results I found that editing of that file is also +necessary on modern versions of Ubuntu in order to allow php-based websites +like that of PLplot to work when installed in local user directories. + +(When user directories are enabled this way, for the above case +/home/irwin/public_html/plplot/htdocs, browses as +http://raven/~irwin/plplot/htdocs/.) + +I test http://raven/~irwin/plplot/htdocs/ by clicking on most links, checking +the documentation looks good, checking the examples look good and the +source code for each language for examples is accessible, etc. + (4) Upload the local website to SourceForge. Once you are satisfied with the local website, you should upload it to @@ -153,11 +170,6 @@ N.B. the --dry-run option for rsync is a god-send and tells you exactly what will happen without actually doing it. -N.B. log files for the website build can be found in the /tmp/plplotdoc/build -directory. This can be useful for finding problems with the build of the -website. - - (5) Creating a PLplot Release Update the README.release file. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2010-11-22 07:39:24
|
Revision: 11346 http://plplot.svn.sourceforge.net/plplot/?rev=11346&view=rev Author: airwin Date: 2010-11-22 07:39:17 +0000 (Mon, 22 Nov 2010) Log Message: ----------- Tweak directions to set PLplot release version number of doxygen-generated documentation. Also, tweak directions to account for the important change in scripts/generate_website.sh which copies all files under svn control (including all local changes to those files) from the source tree that includes that script. This change, means for example, that as a matter of convenience the release manager (or anybody else) does not have to commit local changes in order to generate and test the website based on those local changes. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2010-11-22 01:32:44 UTC (rev 11345) +++ trunk/README.Release_Manager_Cookbook 2010-11-22 07:39:17 UTC (rev 11346) @@ -92,16 +92,23 @@ are generated. The list also automatically controls what examples-related files are copied to the website. -Update the project web page, including the examples: edit www/examples.php -to reflect the forthcoming release number and any changes to the examples -themselves (i.e. pages added or removed from an existing example or entirely -new examples). +Update the project web page, including the examples: edit +www/examples.php to reflect the forthcoming release version number and +any changes to the examples themselves (i.e. pages added or removed +from an existing example or entirely new examples). -svn commit the updated pages since the script below downloads directly -from the svn repository rather than working with any local files. +Edit PROJECT_NUMBER in doc/Doxyfile.in to reflect the release +version number. -Run (on a Linux host that is capable of building the documentation) +The above changes may be committed now or later in the release process +(see "Using svn, commit the above changes" below) since the +script, scripts/generate_website.sh uses the local source +tree where that script resides (including all local changes) +as the source tree for generating the website.) +Run (on a Linux host that is capable of building the documentation +for the source tree that has all local changes) + scripts/generate_website.sh with no arguments. The script asks you four questions, gives you a chance This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2010-11-23 18:36:59
|
Revision: 11349 http://plplot.svn.sourceforge.net/plplot/?rev=11349&view=rev Author: airwin Date: 2010-11-23 18:36:52 +0000 (Tue, 23 Nov 2010) Log Message: ----------- Update instructions for preparing ChangeLog.release file so that it will appear both in the trunk and the tagged release. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2010-11-22 08:22:36 UTC (rev 11348) +++ trunk/README.Release_Manager_Cookbook 2010-11-23 18:36:52 UTC (rev 11349) @@ -101,10 +101,10 @@ version number. The above changes may be committed now or later in the release process -(see "Using svn, commit the above changes" below) since the -script, scripts/generate_website.sh uses the local source -tree where that script resides (including all local changes) -as the source tree for generating the website.) +(see "IMPORTANT: commit all local changes to the repository." below) +since the script, scripts/generate_website.sh uses the local source +tree where that script resides (including all local changes) as the +source tree for generating the website.) Run (on a Linux host that is capable of building the documentation for the source tree that has all local changes) @@ -189,8 +189,25 @@ follow the instructions in this file for updating the SOVERSION, the minor number and the patch number. -Using svn, commit the above changes. +IMPORTANT: commit all local changes to the repository. +Prepare the ChangeLog.release file to keep track of all changes +made for the release. (This destroys the ChangeLog.release file +from the previous release.) + +# This makes the BASE used below correct. +svn update +svn log --revision BASE:<LAST_RELEASE_REVISION> --verbose >| ChangeLog.release + +where <LAST_RELEASE_REVISION> stands for the last revision number of +the previous release which can be found, e.g., by browsing +http://plplot.svn.sourceforge.net/viewvc/plplot/tags + +Check that ChangeLog.release is in the appropriate date range (i.e. only the +changes that were made since the last release should be included) then +(IMPORTANT) commit it so it will also be available for the tagged +release version, the release tarball, etc. + (While it is useful to have the correct time on your computer, this is no longer strictly necessary). Verify that your computer has the right date and time using the command date. @@ -266,9 +283,10 @@ above command finishes executing you should go to this directory and verify that the examples build and that plplot_test.sh executes without errors. -In the event that problems are found in PLplot during the release process, -corrections should be made to trunk/ and then merged into the tags/vX_Y_Z -branch as follows: +In the event that problems are found in PLplot during the release +process, corrections should be made to trunk/, the ChangeLog.release +file recreated and committed (see instructions above). Then merge the +trunk version into the tags/vX_Y_Z branch as follows: cd tags/vX_Y_Z svn merge -r A:B /path/to/trunk @@ -282,13 +300,6 @@ A list of your GPG keys can be obtained using the command "gpg --list-keys". -Prepare the ChangeLog file (in the trunk/ directory): -svn log -v > ChangeLog.release - -Edit ChangeLog.release to be the appropriate date range (i.e. only the -changes that were made since the last release should be included). - - Prepare a file release: Login to sf.net. @@ -325,7 +336,6 @@ the release numbers. - Immediate preparation for next release cycle a. Append the README.release file from the current release onto the front of This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hba...@us...> - 2010-12-19 23:26:48
|
Revision: 11379 http://plplot.svn.sourceforge.net/plplot/?rev=11379&view=rev Author: hbabcock Date: 2010-12-19 23:26:40 +0000 (Sun, 19 Dec 2010) Log Message: ----------- Put the various sections of the release manager cookbook into a more logical order. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2010-12-18 19:11:30 UTC (rev 11378) +++ trunk/README.Release_Manager_Cookbook 2010-12-19 23:26:40 UTC (rev 11379) @@ -1,184 +1,15 @@ INDEX -(1) GNU Privacy Guard (gpg). -(2) Creating a test tarball from trunk. -(3) Install and test a local copy of the PLplot website. -(4) Upload the local website to SourceForge. -(5) Creating a PLplot Release. +(1) Creating a PLplot Release. +(2) Install and test a local copy of the PLplot website. +(3) Upload the local website to SourceForge. +(A1) GNU Privacy Guard (gpg). +(A2) Creating a test tarball from trunk. -(1) GNU Privacy Guard (gpg) -A brief summary of developer relevant gpg commands, see also: -http://webber.dewinter.com/gnupg_howto/ -man gpg +--- Main --- -create a new key: -gpg --gen-key +(1) Creating a PLplot Release: -list keys so that you can find the ID of the key you created: -gpg --list-keys - -upload your (public) key to GPG key server so that others can obtain it to -verify your signature on the release tarball. -gpg --send-keys 6C58D1AC -(where 6C58D1AC is replaced with the appropriate value from the list-keys -command) - -(2) (Optional) Creating a test tarball from trunk - -This step is only required if you have some concerns about how -recent changes may have affected the generated source tarball, and you want -to generate that tarball and test it _before_ you create a tag for the -release. (The release process for the tag below also generates a tarball -from the tag directory and tests it which is why this trunk version of the -same is optional.) - -cd /tmp -/path-to-trunk-source/scripts/make_tarball.sh \ --w https://plplot.svn.sourceforge.net/svnroot/plplot --c -i /tmp/trunk_install -t trunk 2>&1 | tee build.log - -The above exports the current trunk -and uses - -/tmp/plplot-dist-prep/build_dir - -to build the distribution source tarball - -and uses - -/tmp/plplot-dist-prep/ctest_build_dir - -to configure and build PLplot from the unpacked tarball, ctest the build -tree, and install the built PLplot in /tmp/trunk_install - -Here are the *.out files generated by this process which should be checked. - -/tmp/plplot-dist-prep/build_dir/cmake.out -/tmp/plplot-dist-prep/build_dir/make_prebuild_dist.out -/tmp/plplot-dist-prep/build_dir/make_package_source.out -/tmp/plplot-dist-prep/ctest_build_dir/cmake.out -/tmp/plplot-dist-prep/ctest_build_dir/make.out -/tmp/plplot-dist-prep/ctest_build_dir/ctest.out -/tmp/plplot-dist-prep/ctest_build_dir/make_install.out - -Here is how the install location should be checked: - -cd /tmp/trunk_install/share/plplotX.Y.Z/examples -make >& make_examples.out -./plplot-test.sh --help #to see what kinds of tests can be run -./plplot-test.sh --device=psc -./plplot-test.sh --device=pscairo -./plplot-test.sh --device=pngcairo -./plplot-test.sh --device=png - -etc. Check the results with, e.g., - -display x01c.pngcairo.01 -display x08c.pscairo - -where "display" is the general image viewer from the imagemagick suite -of programmes. - -(3) Install and test a local copy of the PLplot website. - -You should always generate and install from scratch a local copy of the -PLplot website on some ssh-accessible machine (normally your local machine). - -If necessary, update the examples list in -scripts/htdocs-gen_plot-examples.sh. That list is used to generate the -website example-related files and copy the results to the website. The list -automatically controls what example source code is configured (for source -code that needs that), as well as what example plots and example thumbnails -are generated. The list also automatically controls what examples-related -files are copied to the website. - -Update the project web page, including the examples: edit -www/examples.php to reflect the forthcoming release version number and -any changes to the examples themselves (i.e. pages added or removed -from an existing example or entirely new examples). - -Edit PROJECT_NUMBER in doc/Doxyfile.in to reflect the release -version number. - -The above changes may be committed now or later in the release process -(see "IMPORTANT: commit all local changes to the repository." below) -since the script, scripts/generate_website.sh uses the local source -tree where that script resides (including all local changes) as the -source tree for generating the website.) - -Run (on a Linux host that is capable of building the documentation -for the source tree that has all local changes) - -scripts/generate_website.sh - -with no arguments. The script asks you four questions, gives you a chance -to verify your answers, then does all the rest of it (downloading a -throwaway copy of the PLplot source code, building the documentation, -generating the announcements that are part of the base website, uploading -the base website, uploading the documentation, building the examples, -running the examples, uploading the example source code and example results) -automatically. I (AWI) tested this script using the four answers - -Summary: -USERNAME = irwin -GROUPNAME = irwin -HOSTNAME = raven -WEBSITE_PREFIX = /home/irwin/public_html/plplot - -(raven is my local computer name, and /home/irwin/public_html is a location -where I can put various websites). You can check for errors (e.g., due -to missing commands that need to be installed) by running - -find /tmp/plplotdoc -name '*.out' |xargs grep -i error - -You should install both apache and PHP on your computer. For Debian Testing -(a.k.a. squeeze) that is done (as root) by installing libapache2-mod-php5 -and enabling user directories using the command - -a2enmod userdir - -and editing /etc/apache2/mods-available/php5.conf as indicated in that -file to allow user directories for php. I am not sure, but I believe -from some google results I found that editing of that file is also -necessary on modern versions of Ubuntu in order to allow php-based websites -like that of PLplot to work when installed in local user directories. - -(When user directories are enabled this way, for the above case -/home/irwin/public_html/plplot/htdocs, browses as -http://raven/~irwin/plplot/htdocs/.) - -I test http://raven/~irwin/plplot/htdocs/ by clicking on most links, checking -the documentation looks good, checking the examples look good and the -source code for each language for examples is accessible, etc. - -(4) Upload the local website to SourceForge. - -Once you are satisfied with the local website, you should upload it to -SourceForge with rsync. - -For the above WEBSITE_PREFIX, here is what worked for me from my computer -with the hostname of raven where that WEBSITE_PREFIX directory was -created. - -rsync -av --delete \ -/home/irwin/public_html/plplot/htdocs/ \ -airwin,pl...@we...:htdocs - -Adjust for your username and WEBSITE_PREFIX. The ",plplot" part of the -username makes sure you have the right group permissions and default website -directory location for PLplot. - -N.B. the trailing slash on the source directory is essential and means rsync -the contents of this directory with the contents of the destination htdocs -directory. Without the trailing slash you would rsync the the contents of -the source directory with the contents of the htdocs/htdocs destination -directory which is not what you want to do. - -N.B. the --dry-run option for rsync is a god-send and tells you exactly what -will happen without actually doing it. - -(5) Creating a PLplot Release - Update the README.release file. Update the docbook documentation to reflect any new drivers or new @@ -344,7 +175,7 @@ b. Update README.release file to reflect significant changes made between the current release and the last release. -Update the web page following the instructions in sections (3) and (4) +Update the web page following the instructions in sections (2) and (3) Publicity for the release announcement. @@ -352,4 +183,179 @@ Barbara Irwin: linuxtoday.com, lwn.net, lxer.com -DONE!!! + +(2) Install and test a local copy of the PLplot website: + +You should always generate and install from scratch a local copy of the +PLplot website on some ssh-accessible machine (normally your local machine). + +If necessary, update the examples list in +scripts/htdocs-gen_plot-examples.sh. That list is used to generate the +website example-related files and copy the results to the website. The list +automatically controls what example source code is configured (for source +code that needs that), as well as what example plots and example thumbnails +are generated. The list also automatically controls what examples-related +files are copied to the website. + +Update the project web page, including the examples: edit +www/examples.php to reflect the forthcoming release version number and +any changes to the examples themselves (i.e. pages added or removed +from an existing example or entirely new examples). + +Edit PROJECT_NUMBER in doc/Doxyfile.in to reflect the release +version number. + +The above changes may be committed now or later in the release process +(see "IMPORTANT: commit all local changes to the repository." below) +since the script, scripts/generate_website.sh uses the local source +tree where that script resides (including all local changes) as the +source tree for generating the website.) + +Run (on a Linux host that is capable of building the documentation +for the source tree that has all local changes) + +scripts/generate_website.sh + +with no arguments. The script asks you four questions, gives you a chance +to verify your answers, then does all the rest of it (downloading a +throwaway copy of the PLplot source code, building the documentation, +generating the announcements that are part of the base website, uploading +the base website, uploading the documentation, building the examples, +running the examples, uploading the example source code and example results) +automatically. I (AWI) tested this script using the four answers + +Summary: +USERNAME = irwin +GROUPNAME = irwin +HOSTNAME = raven +WEBSITE_PREFIX = /home/irwin/public_html/plplot + +(raven is my local computer name, and /home/irwin/public_html is a location +where I can put various websites). You can check for errors (e.g., due +to missing commands that need to be installed) by running + +find /tmp/plplotdoc -name '*.out' |xargs grep -i error + +You should install both apache and PHP on your computer. For Debian Testing +(a.k.a. squeeze) that is done (as root) by installing libapache2-mod-php5 +and enabling user directories using the command + +a2enmod userdir + +and editing /etc/apache2/mods-available/php5.conf as indicated in that +file to allow user directories for php. I am not sure, but I believe +from some google results I found that editing of that file is also +necessary on modern versions of Ubuntu in order to allow php-based websites +like that of PLplot to work when installed in local user directories. + +(When user directories are enabled this way, for the above case +/home/irwin/public_html/plplot/htdocs, browses as +http://raven/~irwin/plplot/htdocs/.) + +I test http://raven/~irwin/plplot/htdocs/ by clicking on most links, checking +the documentation looks good, checking the examples look good and the +source code for each language for examples is accessible, etc. + + +(3) Upload the local website to SourceForge: + +Once you are satisfied with the local website, you should upload it to +SourceForge with rsync. + +For the above WEBSITE_PREFIX, here is what worked for me from my computer +with the hostname of raven where that WEBSITE_PREFIX directory was +created. + +rsync -av --delete \ +/home/irwin/public_html/plplot/htdocs/ \ +airwin,pl...@we...:htdocs + +Adjust for your username and WEBSITE_PREFIX. The ",plplot" part of the +username makes sure you have the right group permissions and default website +directory location for PLplot. + +N.B. the trailing slash on the source directory is essential and means rsync +the contents of this directory with the contents of the destination htdocs +directory. Without the trailing slash you would rsync the the contents of +the source directory with the contents of the htdocs/htdocs destination +directory which is not what you want to do. + +N.B. the --dry-run option for rsync is a god-send and tells you exactly what +will happen without actually doing it. + + +--- Appendix --- + +(A1) GNU Privacy Guard (gpg) +A brief summary of developer relevant gpg commands, see also: +http://webber.dewinter.com/gnupg_howto/ +man gpg + +create a new key: +gpg --gen-key + +list keys so that you can find the ID of the key you created: +gpg --list-keys + +upload your (public) key to GPG key server so that others can obtain it to +verify your signature on the release tarball. +gpg --send-keys 6C58D1AC +(where 6C58D1AC is replaced with the appropriate value from the list-keys +command) + + +(A2) (Optional) Creating a test tarball from trunk + +This step is only required if you have some concerns about how +recent changes may have affected the generated source tarball, and you want +to generate that tarball and test it _before_ you create a tag for the +release. (The release process for the tag below also generates a tarball +from the tag directory and tests it which is why this trunk version of the +same is optional.) + +cd /tmp +/path-to-trunk-source/scripts/make_tarball.sh \ +-w https://plplot.svn.sourceforge.net/svnroot/plplot +-c -i /tmp/trunk_install -t trunk 2>&1 | tee build.log + +The above exports the current trunk +and uses + +/tmp/plplot-dist-prep/build_dir + +to build the distribution source tarball + +and uses + +/tmp/plplot-dist-prep/ctest_build_dir + +to configure and build PLplot from the unpacked tarball, ctest the build +tree, and install the built PLplot in /tmp/trunk_install + +Here are the *.out files generated by this process which should be checked. + +/tmp/plplot-dist-prep/build_dir/cmake.out +/tmp/plplot-dist-prep/build_dir/make_prebuild_dist.out +/tmp/plplot-dist-prep/build_dir/make_package_source.out +/tmp/plplot-dist-prep/ctest_build_dir/cmake.out +/tmp/plplot-dist-prep/ctest_build_dir/make.out +/tmp/plplot-dist-prep/ctest_build_dir/ctest.out +/tmp/plplot-dist-prep/ctest_build_dir/make_install.out + +Here is how the install location should be checked: + +cd /tmp/trunk_install/share/plplotX.Y.Z/examples +make >& make_examples.out +./plplot-test.sh --help #to see what kinds of tests can be run +./plplot-test.sh --device=psc +./plplot-test.sh --device=pscairo +./plplot-test.sh --device=pngcairo +./plplot-test.sh --device=png + +etc. Check the results with, e.g., + +display x01c.pngcairo.01 +display x08c.pscairo + +where "display" is the general image viewer from the imagemagick suite +of programmes. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <hba...@us...> - 2011-08-01 18:32:02
|
Revision: 11836 http://plplot.svn.sourceforge.net/plplot/?rev=11836&view=rev Author: hbabcock Date: 2011-08-01 18:31:54 +0000 (Mon, 01 Aug 2011) Log Message: ----------- Update release manager docs to reflect ongoing changes at SF. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2011-08-01 18:30:57 UTC (rev 11835) +++ trunk/README.Release_Manager_Cookbook 2011-08-01 18:31:54 UTC (rev 11836) @@ -72,6 +72,8 @@ necessary on modern versions of Ubuntu in order to allow php-based websites like that of PLplot to work when installed in local user directories. +You will also need to install "xml-to" (in the xml-to debian package). + (When user directories are enabled this way, for the above case /home/irwin/public_html/plplot/htdocs, browses as http://raven/~irwin/plplot/htdocs/.) @@ -222,6 +224,10 @@ above command finishes executing you should go to this directory and verify that the examples build and that plplot_test.sh executes without errors. +The build will fail (without any warning messages on the console) if you +do not have the necessary tools to build the documentation. It is a good +idea to verify that you can build the documentation (-DBUILD_DOC=ON). + In the event that problems are found in PLplot during the release process, corrections should be made to trunk/, the ChangeLog.release file recreated and committed (see instructions above). Then merge the @@ -245,24 +251,17 @@ Go to the PLplot SourceForge project page. Upload the Release: -Select Project Admin / File Manager. -Click on the plplot folder & select "New folder" from the pop-up menu (the gear like -thing to the left of the plplot folder icon). +Select Files. +Click on the plplot folder & select "Add folder". Enter the release name as the "New folder name:", e.g. X.Y.Z Source. -Click on the release folder pop-up menu & select "Upload here", upload the +Click on the release folder pop-up menu & select "upload", upload the release and the gpg signature file from /tmp/plplot-dist-prep/. This can take a few minutes without much feedback. Concatenate the README.release and ChangeLog.release files into a single README.release file. -Click on "Upload File" again to upload the concatenated README.release file. -Click on this file and mark it as "Release Note". -Click on the source tarball & the signature file pop menu icon and select -Properties. -Select README.release in the "Release Notes for this file" drop down menu. -Click on "Select All" for the platform set as default download (only do this -for the source tarball). -Click on the release folder pop-up menu icon, select properties and set -the release notes for the folder. +Upload the concatenated README.release file. +Click on the "i" or "info" button to mark the tar.gz file as the default +file to download for all platforms. Create a news item for the Release: This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2011-08-09 22:42:06
|
Revision: 11866 http://plplot.svn.sourceforge.net/plplot/?rev=11866&view=rev Author: airwin Date: 2011-08-09 22:42:00 +0000 (Tue, 09 Aug 2011) Log Message: ----------- Drop remarks about updating PROJECT_NUMBER in doc/Doxygen.in since that is now a configured item. Move Remarks about adjusting computer time to an Appendix (A3). Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2011-08-09 22:40:36 UTC (rev 11865) +++ trunk/README.Release_Manager_Cookbook 2011-08-09 22:42:00 UTC (rev 11866) @@ -5,8 +5,9 @@ (4) Publicity for the release announcement. (5) Immediate preparation for next release cycle -(A1) GNU Privacy Guard (gpg). -(A2) Creating a test tarball from trunk. +(A1) GNU Privacy Guard (gpg) +(A2) Creating a test tarball from trunk +(A3) Correct computer time (1) Install and test a local copy of the PLplot website: @@ -31,10 +32,6 @@ any changes to the examples themselves (i.e. pages added or removed from an existing example or entirely new examples). -Edit PROJECT_NUMBER in doc/Doxyfile.in to reflect the upcoming release -version number. (The doxygen documentation is now part of our -release so it is important to get the version number correct.) - Run (on a Linux host that is capable of building the documentation for the source tree that has all local changes) @@ -149,24 +146,6 @@ (IMPORTANT) commit it so it will also be available for the tagged release version, the release tarball, etc. -(While it is useful to have the correct time on your computer, this is no -longer strictly necessary). -Verify that your computer has the right date and time using the command date. -The easiest way to make sure the time and date are correct is to do the -following: -1. Install the debian ntpdate package. -2. Execute the command "/usr/sbin/ntpdate pool.ntp.org", which you will - have to do as root. -This will immediately change your system clock. It is not recommended if you -have other apps running on your system that expect time to increase in a -smooth and linear fashion. - -If you would like your computer to always have the correct time and date, you -can install the debian ntp package, which must be properly configured to work. -Some notes about how to do this can be found in the PLplot mailing list -archive. Look for the thread titled "PLplot 5.7.2 is now available" dated -Jan 22/23 2007. - Based on suggestions in the svn manual, the PLplot svn archive is configured as follows: @@ -365,3 +344,24 @@ where "display" is the general image viewer from the imagemagick suite of programmes. + +(A3) Correct computer time + +(While it is useful to have the correct time on your computer, this is no +longer strictly necessary). +Verify that your computer has the right date and time using the command date. +The easiest way to make sure the time and date are correct is to do the +following: +1. Install the debian ntpdate package. +2. Execute the command "/usr/sbin/ntpdate pool.ntp.org", which you will + have to do as root. +This will immediately change your system clock. It is not recommended if you +have other apps running on your system that expect time to increase in a +smooth and linear fashion. + +If you would like your computer to always have the correct time and date, you +can install the debian ntp package, which must be properly configured to work. +Some notes about how to do this can be found in the PLplot mailing list +archive. Look for the thread titled "PLplot 5.7.2 is now available" dated +Jan 22/23 2007. + This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2011-08-18 19:04:00
|
Revision: 11888 http://plplot.svn.sourceforge.net/plplot/?rev=11888&view=rev Author: airwin Date: 2011-08-18 19:03:54 +0000 (Thu, 18 Aug 2011) Log Message: ----------- Update broken link for GPG minihowto. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2011-08-16 19:49:14 UTC (rev 11887) +++ trunk/README.Release_Manager_Cookbook 2011-08-18 19:03:54 UTC (rev 11888) @@ -273,7 +273,7 @@ (A1) GNU Privacy Guard (gpg) A brief summary of developer relevant gpg commands, see also: -http://webber.dewinter.com/gnupg_howto/ +http://dewinter.com/gnupg_howto/english/GPGMiniHowto.html man gpg create a new key: This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2012-11-17 17:34:48
|
Revision: 12274 http://plplot.svn.sourceforge.net/plplot/?rev=12274&view=rev Author: airwin Date: 2012-11-17 17:34:42 +0000 (Sat, 17 Nov 2012) Log Message: ----------- The actual name of the command (and Debian package name) is "xmlto" not "xml-to". Also add some explanation of why the xmlto package must be installed in order to generate the website. Slightly update the apache configuration steps. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2012-11-16 21:29:14 UTC (rev 12273) +++ trunk/README.Release_Manager_Cookbook 2012-11-17 17:34:42 UTC (rev 12274) @@ -32,6 +32,12 @@ any changes to the examples themselves (i.e. pages added or removed from an existing example or entirely new examples). +You also need to install "xmlto" (in the xmlto debian package). +xmlto is used to generate some of our older release announcements for +the website, and could also be used to generate present release +announcements for the website if desired. See www/announce/README for +just how easy this step would be. + Run (on a Linux host that is capable of building the documentation for the source tree that has all local changes) @@ -69,8 +75,11 @@ necessary on modern versions of Ubuntu in order to allow php-based websites like that of PLplot to work when installed in local user directories. -You will also need to install "xml-to" (in the xml-to debian package). +After the above changes, you must restart the apache server. On +Debian this is done with +service apache2 restart + (When user directories are enabled this way, for the above case /home/irwin/public_html/plplot/htdocs, browses as http://raven/~irwin/plplot/htdocs/.) This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ai...@us...> - 2013-09-30 00:07:50
|
Revision: 12553 http://sourceforge.net/p/plplot/code/12553 Author: airwin Date: 2013-09-30 00:07:44 +0000 (Mon, 30 Sep 2013) Log Message: ----------- Interim snapshot commit of the many changes I have made to the release process. However, there is still more edits that will need to be made before this is ready for release. Modified Paths: -------------- trunk/README.Release_Manager_Cookbook Modified: trunk/README.Release_Manager_Cookbook =================================================================== --- trunk/README.Release_Manager_Cookbook 2013-09-29 20:59:14 UTC (rev 12552) +++ trunk/README.Release_Manager_Cookbook 2013-09-30 00:07:44 UTC (rev 12553) @@ -1,51 +1,207 @@ INDEX -(1) Install and test a local copy of the PLplot website. -(2) Upload the local website to SourceForge. -(3) Creating a PLplot Release. +(1) Prepare documentation +(2) Check and potentially fix internal consistency +(3) Update website-related files +(4) Preliminary install and test of a local copy of the PLplot website +(5) Prepare a preliminary version of the ChangeLog file for this release +(6) Prepare the README.release file or press those who have made +(7) Version changes. +(8) Install and test a local copy of the PLplot website +(9) Comprehensive test of PLplot. +(10) Upload the local website to SourceForge: +(5) Prepare a file release: (4) Publicity for the release announcement. (5) Immediate preparation for next release cycle + (A1) GNU Privacy Guard (gpg) (A2) Creating a test tarball from trunk (A3) Correct computer time -(1) Install and test a local copy of the PLplot website: +N.B. the order of steps below is important because of the +dependencies between the steps. -(N.B. this step needs to be done first to insure the associated source tree -updates get into the release tarball, the svn tags version of the release, -and associated commit messages get into the ChangeLog for the -release.) +(1) Prepare documentation -You should always generate and install from scratch a local copy of the -PLplot website on some ssh-accessible machine (normally your local machine). +This step does not depend on other steps. +The steps below entitled + +"Check and potentially fix internal consistency" and +"Install and test a local copy of the PLplot website" + +depend on this step. + +Update the doxygen documentation (in our source code) and DocBook +documentation (in doc/docbook/src) to reflect any changes (new drivers +or new PLplot functionality) in the current release cycle. Or +alternatively, press those who made the changes to update the +documentation. + +Generate and test our doxygen form of documentation following the +instructions in doc/README.doxygen. Generate and test our Docbook +documentation following the instructions in +doc/docbook/README.developers. + +(2) Check and potentially fix internal consistency + +This step depends on the step above entitled + +"Prepare documentation". + +This step potentially affects the swig-generated bindings and +the f95, tcl, and ocaml bindings. Thus, the steps below entitled + +"" + +may depend on this step. + +Some of the files in the source tree are generated from other files +in the source tree using build-system targets. All targets that +have "check" in the name prefix are these kind of targets. So to get +a complete list of such targets, execute + +make help |grep '... check' + +in the build tree. The current such list of targets is + +... check_swig_documentation +... check_f95_parameters +... check_tcl_parameters +... check_plplot_h.inc + +Note, one of these targets (check_plplot_h.inc) only exists if the +-DGENERATE_PLPLOT_H_INC=ON cmake option is used which in turn requires +that at least the OCaml version of the Perl regular expression library +be installed. (On debian the associated package name is +libpcre-ocaml-dev.) Normally, GENERATE_PLPLOT_H_INC is OFF by default +to reduce build dependencies, but to make the complete list of such +targets available you should run the cmake command with the +-DGENERATE_PLPLOT_H_INC=ON option and make sure there are no +OCaml-related warnings in the results. + +To actually do the internal consistency checks, run each of the above +targets which typically generate a file in the build tree which is +then compared (using the Unix cmp command) with the file that is being +checked in the source tree. If the two files are inconsistent (which +can be caused by documentation updates, for example), the cmp command +complains, and you should follow up by doing a diff between the two +files to confirm that the changes are reasonable followed by copying +the build-tree version of the file on top of the source-tree version +and committing the source-tree version. When this process is completed, +all the above targets should run with no cmp or other errors/warnings +at all, e.g., + +software@raven> make check_swig_documentation check_f95_parameters check_tcl_parameters check_plplot_h.inc +Check that swig_documentation.i is consistent with doc/docbook/src/api.xml +Built target check_swig_documentation +Check that plplot_parameters.h is consistent with the #defines in bindings/swig-support/plplotcapi.i +Built target check_f95_parameters +Check that plplot_parameters.h is consistent with the #defines in bindings/swig-support/plplotcapi.i +Built target check_tcl_parameters +Check that plplot_h.inc is consistent with touchup.ml and plplot_h +Built target check_plplot_h.inc + +(3) Update website-related files + +This step does not depend on other steps. + +The step below entitled + +"Install and test a local copy of the PLplot website" + +depends on this step. + If necessary, update the examples list in scripts/htdocs-gen_plot-examples.sh. That list is used to generate the -website example-related files and copy the results to the website. The list -automatically controls what example source code is configured (for source -code that needs that), as well as what example plots and example thumbnails -are generated. The list also automatically controls what examples-related -files are copied to the website. +website example-related files and copy the results to the website. The +list automatically controls what example source code is configured +(for source code that needs that), as well as what example plots and +example thumbnails are generated. The list also automatically +controls what examples-related files are copied to the website. Update the project web page, including the examples: edit www/examples.php to reflect the forthcoming release version number and any changes to the examples themselves (i.e. pages added or removed from an existing example or entirely new examples). -You also need to install "xmlto" (in the xmlto debian package). -xmlto is used to generate some of our older release announcements for -the website, and could also be used to generate present release -announcements for the website if desired. See www/announce/README for -just how easy this step would be. +Note, the xmlto package that must be installed in order to generate +the DocBook documentation (see doc/docbook/README.developers referred +to above) is also used to generate some of our older release +announcements for the website, and could also be used to generate +present release announcements for the website if desired. See +www/announce/README for just how easy this step would be. -Run (on a Linux host that is capable of building the documentation -for the source tree that has all local changes) +(4) Preliminary install and test of a local copy of the PLplot website +This step depends on the steps above entitled + +"Prepare documentation" and +"Update website-related files" + +but does not depend on any steps below. + +Follow the directions in the step below entitled + +"Install and test a local copy of the PLplot website" + +exactly which should produce a final tested local version of the +website except that the RELEASE_DATE might be wrong. + +(5) Prepare a preliminary version of the ChangeLog file for this release + +# This makes the BASE used below correct. +svn update + +svn log --revision BASE:<LAST_RELEASE_REVISION> --verbose >| ChangeLog.release_preliminary + +where <LAST_RELEASE_REVISION> stands for the last revision number of +the previous release which can be determined e.g., by viewing the +ChangeLog.release file from the previous release. Note the "_preliminary" +suffix to distinguish this from the final result below. + + +(6) Prepare the README.release file or press those who have made +changes in this release cycle to update that file. + +To double-check that file is complete with regards to all major +developments during this release cycle, skim all the commit messages in +ChangeLog.release_preliminary determined above. + +(7) Version changes. + +Version of PLplot updated above in www/examples.php. In addition, +update cmake/modules/plplot_version.cmake to reflect the current +RELEASE_DATE (which affects the documentation build) and +version. Also, follow the instructions in that file for updating the +SOVERSION, the minor number and the patch number for each versioned +library created by the PLplot build. + +(8) Install and test a local copy of the PLplot website + +This step depends on the steps above entitled + +"Prepare documentation", +"Update website-related files", and +"Version changes" (since the documentation build depends on the +release date). + +The step below entitled + +"" + +depends on this one. + +To build the local form of the website (including both the doxygen and +DocBook forms of our documentation) run (on a Linux host that is +capable of building the documentation for the source tree that has all +local changes) + scripts/generate_website.sh with no arguments. The script asks you four questions, gives you a chance to verify your answers, then does all the rest of it (downloading a -throwaway copy of the PLplot source code, building the documentation, +throwaway copy of the PLplot source code, building the doxygen and DocBook documentation, generating the announcements that are part of the base website, uploading the base website, uploading the documentation, building the examples, running the examples, uploading the example source code and example results) @@ -63,8 +219,8 @@ find /tmp/plplotdoc -name '*.out' |xargs grep -i error -You should install both apache and PHP on your computer. For Debian Testing -(a.k.a. squeeze) that is done (as root) by installing libapache2-mod-php5 +You should install both apache and PHP on your computer. For Debian stable +(a.k.a. wheezy) that is done (as root) by installing libapache2-mod-php5 and enabling user directories using the command a2enmod userdir @@ -84,77 +240,66 @@ /home/irwin/public_html/plplot/htdocs, browses as http://raven/~irwin/plplot/htdocs/.) -I test http://raven/~irwin/plplot/htdocs/ by clicking on most links, checking -the documentation looks good, checking the examples look good and the -source code for each language for examples is accessible, etc. +I test http://raven/~irwin/plplot/htdocs/ by clicking on most links, +checking the documentation looks good, checking the examples are +complete and look good and the source code for each language for +examples is accessible, etc. Some iterations with the +steps above entitled +"Prepare documentation" and +"Update website-related files" + +will likely be required. + N.B. scripts/generate_website.sh uses the local source tree where that script resides (including all local changes) as the source tree for generating the local website. So there is no need to commit every -above example and version change until you are completely satisfied +documentation, example, and version change until you are completely satisfied with the local website. But after you _are_ satisfied with the local website you should commit all your changes so they are available for generating the tarball and ChangeLog (see below) for this release. -(2) Upload the local website to SourceForge: +(9) Comprehensive test of PLplot. -Once you are satisfied with the local website, you should upload it to -SourceForge with rsync. +Do comprehensive test of the interactive results then the noninteractive +results. -For the above WEBSITE_PREFIX, here is what worked for me from my computer -with the hostname of raven where that WEBSITE_PREFIX directory was -created. +scripts/comprehensive_test.sh --do_ctest no --do_test_noninteractive no +scripts/comprehensive_test.sh --do_test_interactive no -rsync -av --delete \ -/home/irwin/public_html/plplot/htdocs/ \ -airwin,pl...@we...:htdocs +Enter results of these and all other tests of this release into +README.release. -Adjust for your username and WEBSITE_PREFIX. The ",plplot" part of the -username makes sure you have the right group permissions and default website -directory location for PLplot. +(10) Create ChangeLog.release -N.B. the trailing slash on the source directory is essential and means rsync -the contents of this directory with the contents of the destination htdocs -directory. Without the trailing slash you would rsync the the contents of -the source directory with the contents of the htdocs/htdocs destination -directory which is not what you want to do. +N.B. commit all local changes to the repository so they will be +reflected in the ChangeLog, tagged version of the release, and release +tarball. And if there are committed changes after this one (except +possibly for commits of this file, README.Release_Manager_Cookbook), +repeat this step so the ChangeLog.release commit is the last trunk +commit for this release cycle (with the exception of the current +file). -N.B. the --dry-run option for rsync is a god-send and tells you exactly what -will happen without actually doing it. - -(3) Creating a PLplot Release: - -Update the README.release file. - -Update the docbook documentation to reflect any new drivers or new -functionality that has been added to PLplot. Or alternatively, press those -who made the changes to update the documentation. - -Update cmake/module/plplot_version.cmake to reflect the current version. Also, -follow the instructions in this file for updating the SOVERSION, the minor -number and the patch number. - -IMPORTANT: commit all local changes to the repository so they -will be reflected in the ChangeLog, tagged version of the release, -and release tarball. - Prepare the ChangeLog.release file to keep track of all changes -made for the release. (This destroys the ChangeLog.release file -from the previous release.) +made for the release. Use the following commands: # This makes the BASE used below correct. svn update + svn log --revision BASE:<LAST_RELEASE_REVISION> --verbose >| ChangeLog.release -where <LAST_RELEASE_REVISION> stands for the last revision number of -the previous release which can be found, e.g., by browsing -http://plplot.svn.sourceforge.net/viewvc/plplot/tags +(This destroys the ChangeLog.release file +from the previous release.) LAST_REVISION should be the same as in +the generation of the preliminary version of this file above. Check that ChangeLog.release is in the appropriate date range (i.e. only the changes that were made since the last release should be included) then (IMPORTANT) commit it so it will also be available for the tagged -release version, the release tarball, etc. +release version, the release tarball, etc. This should be the +last commit for the trunk version of PLplot (see remarks above +about when it is necessary to repeat this step). +(11) Creating a PLplot Release: Based on suggestions in the svn manual, the PLplot svn archive is configured as follows: @@ -233,8 +378,34 @@ A list of your GPG keys can be obtained using the command "gpg --list-keys". -Prepare a file release: +(2) Upload the local website to SourceForge: +Once you are satisfied with the local website, you should upload it to +SourceForge with rsync. + +For the above WEBSITE_PREFIX, here is what worked for me from my computer +with the hostname of raven where that WEBSITE_PREFIX directory was +created. + +rsync -av --delete \ +/home/irwin/public_html/plplot/htdocs/ \ +airwin,pl...@we...:htdocs + +Adjust for your username and WEBSITE_PREFIX. The ",plplot" part of the +username makes sure you have the right group permissions and default website +directory location for PLplot. + +N.B. the trailing slash on the source directory is essential and means rsync +the contents of this directory with the contents of the destination htdocs +directory. Without the trailing slash you would rsync the the contents of +the source directory with the contents of the htdocs/htdocs destination +directory which is not what you want to do. + +N.B. the --dry-run option for rsync is a god-send and tells you exactly what +will happen without actually doing it. + +(5) Prepare a file release: + Login to sf.net. Go to the PLplot SourceForge project page. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |