www.ravenbrook.com

How to make an MPS release for Configura.

This document tells you how to make a new release of the MPS for Configura.
It assumes that the source-code work (the reason for the new release) is in
master sources already.

Readership: MPS staff. Confidential: no. Status: rough notes, informally
peer-reviewed. Author: RHSK.

Background: refer to PQTCM ("Product Quality Through Change Management",
<http://www.ravenbrook.com/doc/1999/05/20/pqtcm/>) for background,
terminology, rationale, and usage guidance. This tells you what "a release"
actually is.

Peer documents:
<http://info.ravenbrook.com/project/mps/master/procedure/version-create/>.
<http://info.ravenbrook.com/project/mps/master/procedure/release-build/>.

__OVERVIEW__

Steps:

1. (optional) make a new version: see <procedure/version-create/>

2. check the diffs: eg. "p4 diff2 -q version/1.105/... version/1.106/...".

3. get the equipment ready: see __EQUIPMENT__ below.

4. test the new code: see <code/tool/testrunner.py>

5. build the release: see __BUILD__ below.

__EQUIPMENT__

You need a Windows box. I used a PC with P4, VisualC++, and cygwin on it
already.

Set-up a login and password if necessary. To prevent pwd expiry, use Start >
Programs > Admin Tools > User Manager. To make cmd windows tab-complete
filenames, do this: Start > Run > regedit. HKEY_CURRENT_USER > Software >
Microsoft > Command Processor > CompletionChar = 9.

If you want to access remotely from a Mac, use "Chicken of the VNC", eg.
2.02b2. You'll need the VNC session-password (not the same as your NT login
password). Remember how to escape from Full-screen: Cmd-Opt-Ctrl-`
(backquote); and how to right-click: depress and release Shift-key, then
click.

To copy ad-hoc files (like build output) to and from a Mac, mount the PC's
disk on your Mac. Finder > Go > Network > Network > Ravenbrook > PC. Be
patient: list of servers may take some seconds to fully update/populate. For
a machine in its own workgroup, it may be more like Finder > Go > Network >
Network > Workgroup > PC. By default XP has "simple file-sharing", so if you
share the whole disk you still don't share stuff in Documents and Settings.
To fix this: turn off "simple file-sharing" by clearing the check-box at
Control Panel > Folder Options > View > "Use simple file sharing
(Recommended)"; and go back to the share point (eg. C:\) > Properties >
Sharing > Permissions, and make it PC\Users who have access (not Everyone).

Start > Programs > P4Win. Set-up a P4 client. Set-up the client map. P4sync
to check it's working.

Or, for command-line p4, first need to do "p4 set" to set P4USER, P4CLIENT,
and P4PORT (eg. "p4 set P4USER=rhsk"). This sets things in the registry, so
it is persistent.

__BUILD__

Read all of
<http://info.ravenbrook.com/project/mps/master/procedure/release-build/>,
which is the normal release-build procedure. Keeping referring to it during
this procedure. The following notes are just a delta from it.

First, clean out the place code will be built in, and sync to the right
changelevel (the changelevel you have decided is going to be the release's
origin), 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: both "revert" and "sync -f" are required: otherwise p4-opened or
forced-writeable files may remain or be omitted).

cd code

Invoke \vc6path.bat.
(This sets up the path for VC6 builds, allowing the makefiles to simply invoke
"cl" etc, without knowing where it is. Most of this is already done by
Configura's cet2008b install script, but there is a problem with the order of
directories on PATH, which this batch file sorts out. Note: copy archived at
http://info.ravenbrook.com/mail/2009/09/24/15-51-21/0.txt)

Invoke w3build.bat.
(This is the Configura-specific build-script for the VC6 build. It ALSO sets
the "mpsreleasename" environment variable, which is required by "w3vc9.bat").

Invoke \vc9vars.bat.
(This sets up the path for VC9 builds. It is simply a copy of VC9's
"vcvars32.bat". It is okay to run it in a shell where you have previously
invoked \vc6path.bat -- VC9 locations are prepended to PATH etc, so take
precedence over any VC6 locations already there.)

Invoke w3vc9.bat.
(This is the Configura-specific build-script for the additional steps to
build VC9 object files, and copy them to the Configura-release directory.
It requires the "mpsreleasename" environment variable, set by "w3vc9.bat").

The outcome of w3build + w3vc9 is a release directory, called "rel-1_108_0"
or some such, eg:
$ find . '-type' d '-print'
.
./include
./lib
./lib/w3i3
./lib/w3i3/ci
./lib/w3i3/di
./lib/w3i3/hi
./lib/w3i3/we
./lib/w3i3m9
./lib/w3i3m9/ci
./lib/w3i3m9/di
./lib/w3i3m9/hi
./lib/w3i3m9/we
./src

Make a zip archive of the release directory. (PC needs Info-ZIP.).
Use this command:
"zip -r MMconfigura-A.BBB.C-DDDDDD.zip rel-1_108_0"
A.BBB.C is the release name. DDDDDD is the release origin changelevel.
(Alternatively, use the Windows GUI right-click > Send To > Compressed
(zipped) Folder, and rename it).

p4 add the archive under mps/release. (This is your first candidate build
for release A.BBB.C).

Test it. (Copy to new place and extract with "unzip
MMconfigura-A.BBB.C-DDDDDD.zip". Consider using tool/test-runner.py to run
various tests, repeatedly.)

Once successfully tested, update infosys. See
<http://info.ravenbrook.com/project/mps/master/procedure/release-build/>.
Remember to update issue.cgi.

Make sure it is sync'd to www.ravenbrook.com. (As of 2007, this should happen
automatically every minute). Then send an email with a pointer to the
release.

(Do not send it attached to an email: it may get stuck in a virus filter.)

END OF PROCEDURE

DOCUMENT HISTORY

2005-10-03 RHSK Created.
2006-12-27 RHSK Minor tweaks: drop incorrect release origin comment; www auto-syncs now.
2007-07-05 RHSK Use zip; GR prefers it. w3build.bat makes dir called rel-1_108_0.
2009-09-22 RHSK word wrap
2009-09-24 RHSK Both VC6 and VC9 builds; no tar archive.

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

1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3. Redistributions in any form must be accompanied by information on how
to obtain complete source code for this software and any
accompanying software that uses this software. The source code must
either be included in the distribution or be available for no more than
the cost of distribution plus a nominal fee, and must be freely
redistributable under reasonable conditions. For an executable file,
complete source code means the source code for all modules it contains.
It does not include source code for modules or files that typically
accompany the major components of the operating system on which the
executable file runs.

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.

$Id: //info.ravenbrook.com/project/mps/version/1.109/procedure/release-configura/index.txt#1 $