diff --git a/mps/procedure/release-build/index.html b/mps/procedure/release-build/index.html index 120b4f924fe..a24afc3f17d 100644 --- a/mps/procedure/release-build/index.html +++ b/mps/procedure/release-build/index.html @@ -40,11 +40,13 @@

1. Introduction

-

This is the procedure for building a generic release of the Memory Pool System (an "mps-kit") from the version sources.

+

This is the procedure for building a generic release of the Memory +Pool System (an “MPS Kit”) from the version sources.

-

The intended readership of this document is Ravenbrook development staff. - (If you are a user of the MPS, and want to build object code from - an mps-kit, please see the readme.txt file in the kit).

+

The intended readership of this document is Ravenbrook development +staff. (If you are a user of the MPS, and want to build object code +from an MPS Kit, please see the readme.txt file in the +kit.)

This document is not confidential.

@@ -54,42 +56,67 @@

2. Procedure

-

2.1. Setting up for release

    -

  1. Choose a RELEASE name of the form "VERSION.N" (for example, -0.3.0). VERSION is the number of the version you're releasing. N is the -first unused release number (starting at zero). Look in the index of -releases (release/index.html) for existing release numbers for your -version.

    2. +

  2. Choose a RELEASE name of the form VERSION.N (for +example, 0.3.0), where VERSION is the number of the version +you’re releasing, and N is the first unused release number +(starting at zero). Look in the index of releases +(release/index.html) for existing release numbers for +your version.

    VERSION=VERSION
    +RELEASE=$VERSION.N
    3. -

  3. Ensure that version/VERSION/readme.txt +

  4. Ensure that version/$VERSION/readme.txt contains an up-to-date description of the release you intend to build and the correct release name.

    5. -

  5. In - version/VERSION/code/version.c, - set - MPS_RELEASE - to the correct value (see the rules in the comments), - and check strings that contain copyright dates, etc. -

    6. +

  6. In version/$VERSION/code/version.c, +set MPS_RELEASE to the correct value (see the rules in +the comments), and check strings that contain copyright dates, +etc.

  7. Submit readme.txt, -version.c, and other changed files -to Perforce before you continue.

    8. +version.c, and other changed files to Perforce before you +continue.

    -

  8. Determine the CHANGELEVEL at which you're going to make the -release. This will usually be the latest submitted changelevel on the -version branch; to get it, use p4 changes with a max of 1 (one):

    p4 changes -m 1 -version/VERSION/...
    9. +

  9. Determine the CHANGELEVEL at which you’re going to make +the release. This will usually be the latest submitted changelevel on +the version branch; to get it, use p4 changes with a max +of 1 (one):

    CHANGELEVEL=$(p4 changes -m 1 +version/$VERSION/... | cut -d' ' -f2)
-

2.2. MPS Kit Tarball and Zip file

+

2.2. Pre-release testing

+ +
    + +
  1. + +

    Sync the version sources to precisely the CHANGELEVEL you + determined in step 2.1.1, with no extraneous files, by using the + following procedure:

    + +
    + # (you may wish to check for opened files first)
    + p4 revert version/$VERSION/...
    + rm -rf version/$VERSION
    + p4 sync -f version/$VERSION/...@$CHANGELEVEL +
    + +

    Note: revert and sync -f are required, otherwise p4-opened or forced-writeable files may remain or be omitted; see [1].

    + +
    2. + +

  2. Run the test suite:

    (cd version/$VERSION && ./configure && make test)

    Check that the test suite passes.

    3. + +
+ + +

2.3. MPS Kit Tarball and Zip file

On a Unix box:

@@ -97,79 +124,78 @@ version/VERSION/...
  • -

    Sync the version sources to precisely the CHANGELEVEL you determined in step 2.1, with no extraneous files, by using the following procedure:

    +

    Sync the version sources to CHANGELEVEL by repeating the + procedure from step 2.2.1:

    - # (you may wish to check for opened files first)
    - p4 revert version/VERSION/...
    - rm -rf version/VERSION
    - p4 sync -f version/VERSION/...@CHANGELEVEL + p4 revert version/$VERSION/...
    + rm -rf version/$VERSION
    + p4 sync -f version/$VERSION/...@$CHANGELEVEL
    -

    (Note: "revert" and "sync -f" are required: otherwise p4-opened or forced-writeable files may remain or be omitted; see [1].)

    -
  • -

    Create a tarball and a zip file containing the MPS sources, and open it for add:

    +

    Create a tarball and a zip file containing the MPS sources, and + open it for add:

    - cp -R version/VERSION mps-kit-RELEASE
    - mkdir -p release/RELEASE
    - tar cf - mps-kit-RELEASE | gzip -c > release/RELEASE/mps-kit-RELEASE.tar.gz
    - zip -r release/RELEASE/mps-kit-RELEASE.zip mps-cet-kit-RELEASE - rm -r mps-kit-RELEASE
    - p4 add release/RELEASE/mps-kit-RELEASE.tar.gz - p4 add release/RELEASE/mps-kit-RELEASE.zip + KIT=mps-kit-$RELEASE
    + cp -R version/$VERSION $KIT
    + mkdir -p release/$RELEASE
    + tar cf - $KIT | gzip -c > release/$RELEASE/$KIT.tar.gz
    + zip -r release/$RELEASE/$KIT.zip $KIT
    + rm -r $KIT
    + p4 add release/$RELEASE/$KIT.tar.gz
    + p4 add release/$RELEASE/$KIT.zip
    • -

  • Submit the release files to Perforce with -the comment "MPS: adding the MPS Kit tarball and zip file for -release RELEASE."

    • +

  • Submit the release files to Perforce with the comment “MPS: +adding the MPS Kit tarball and zip file for +release RELEASE.”

    • -

    2.3. Registering the release

    +

    2.4. Registering the release

      -

    1. Edit the index of releases (release/index.html) and -add the release to the table, in a manner consistent with previous +

    2. Edit the index of releases (release/index.html) +and add the release to the table, in a manner consistent with previous releases.

      3. -

    3. Edit the index of versions (version/index.html) and -add the release to the list of releases for VERSION, in a manner -consistent with previous releases.

      4. +

    4. Edit the index of versions (version/index.html) +and add the release to the list of releases for VERSION, in a +manner consistent with previous releases.

      5. -

    5. Submit these changes with the comment "MPS: registered release -RELEASE."

      6. +

    6. Submit these changes with the comment “MPS: registered release +RELEASE.”

    7. - Edit the main MPS Project index page at - //info.ravenbrook.com/project/mps/index.html, + Edit the main MPS Project index page (index.html), to refer to the new release:

      8. -

    8. Visit the project updater, select "mps" from the dropdown, and hit "Find releases".

      9. +

    9. Visit +the project +updater, select “mps” from the dropdown, and hit “Find +releases”.

      10. -

    10. - Inform the project manager and staff by e-mail to mps-staff@ravenbrook.com. - Consider announcing the new release by e-mail to - mps-discussion@ravenbrook.com. -

      11. +

    11. Inform the project manager and staff by e-mail +to mps-staff@ravenbrook.com. +Consider announcing the new release by e-mail +to mps-discussion@ravenbrook.com.

    @@ -183,7 +209,7 @@ RELEASE."

    [1] - "revert ; rm ; sync -f"; + “revert ; rm ; sync -f”; RHSK; <URL: http://info.ravenbrook.com/mail/2008/10/16/13-08-20/0.txt>; 2008-10-16. @@ -200,7 +226,7 @@ RELEASE."

    [#REF_NAME#] - "#REF_TITLE#"; + “#REF_TITLE#”; #REF_AUTHOR#; <URL: #REF_URL#>; #REF_DATE#. @@ -247,17 +273,17 @@ RELEASE."

    - 2005-10-06..31 + 2005-10-06 RHSK - Clarify this procedure is for general mps-kit releases; correct cp -r to -R. Add: check version.c. + Clarify this procedure is for general MPS Kit releases; correct cp -r to -R. Add: check version.c. - 2006-01-19..30 + 2006-01-19 RHSK @@ -274,13 +300,13 @@ RELEASE."

    2007-07-05 RHSK - Releasename now also in w3build.bat. + Releasename now also in w3build.bat. 2008-01-07 RHSK - Release changelevel was in issue.cgi, now in data.py. + Release changelevel was in issue.cgi, now in data.py. @@ -299,12 +325,17 @@ RELEASE."

    RB - - - + Don’t copy the readme.txt to the release directory, since it no longer has that dual role; make the zip file on a Unix box with the zip utility, since compatibility has improved. + + + + + + 2013-03-08 + + GDR + + Add testing step (§2.2). @@ -313,7 +344,7 @@ RELEASE."

    C. Copyright and License

    -

    This document is copyright © 2002, 2005-2008 Ravenbrook Limited. All rights reserved. This is an open source license. Contact Ravenbrook for commercial licensing options.

    +

    This document is copyright © 2002–2013 Ravenbrook Limited. All rights reserved. This is an open source license. Contact Ravenbrook for commercial licensing options.

    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

    @@ -327,7 +358,7 @@ RELEASE."

    -

    This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability, fitness for a particular purpose, or non-infringement, are disclaimed. In no event shall the copyright holders and contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.

    +

    This software is provided by the copyright holders and contributors “as is” and any express or implied warranties, including, but not limited to, the implied warranties of merchantability, fitness for a particular purpose, or non-infringement, are disclaimed. In no event shall the copyright holders and contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.