From e10079c3793da3d0f6d76adaf38422cba63bc427 Mon Sep 17 00:00:00 2001 From: Siri Hansen Date: Mon, 28 Nov 2011 10:39:15 +0100 Subject: Fix minor faults in documentation of release handling Fix typos or minor faults. Move out code listing of target_system.erl, and use codeinclude statement to include this file from sasl/examples directory. --- lib/sasl/doc/src/release_handler.xml | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) (limited to 'lib/sasl') diff --git a/lib/sasl/doc/src/release_handler.xml b/lib/sasl/doc/src/release_handler.xml index bd4a513750..e3438ede41 100644 --- a/lib/sasl/doc/src/release_handler.xml +++ b/lib/sasl/doc/src/release_handler.xml @@ -64,10 +64,10 @@ downgraded to the specified version by evaluating the instructions in relup. An installed release can be made permanent. There can only be one permanent release in - the system, and this is the release that is used if the system is - restarted. An installed release, except the permanent one, can be - removed. When a release is removed, all files that - belong to that release only are deleted.

+ the system, and this is the release that is used if the system + is restarted. An installed release, except the permanent one, + can be removed. When a release is removed, all files + that belong to that release only are deleted.

Each version of the release has a status. The status can be unpacked, current, permanent, or old. There is always one latest release which either has status @@ -107,16 +107,17 @@ old reboot_old permanent restarted. This is taken care of automatically if Erlang is started as an embedded system. Read about this in Embedded System. In this case, the system configuration file sys.config is mandatory.

-

A new release may restart the system. Which program to use is - specified by the SASL configuration parameter start_prg - which defaults to $ROOT/bin/start.

+

The installation of a new release may restart the system. Which + program to use is specified by the SASL configuration + parameter start_prg which defaults + to $ROOT/bin/start.

The emulator restart on Windows NT expects that the system is started using the erlsrv program (as a service). Furthermore the release handler expects that the service is named NodeName_Release, where NodeName is the first part of the Erlang nodename (up to, but not including - the "@") and Release is the current release of - the application. The release handler furthermore expects that a + the "@") and Release is the current version of + the release. The release handler furthermore expects that a program like start_erl.exe is specified as "machine" to erlsrv. During upgrading with restart, a new service will be registered and started. The new service will be set to @@ -484,7 +485,7 @@ release_handler:set_unpacked(RelFile, [{myapp,"1.0","/home/user"},...]). release_handler to end up in an inconsistent state.

No persistent information is updated, why these functions can be used on any Erlang node, embedded or not. Also, using these - functions does not effect which code will be loaded in case of + functions does not affect which code will be loaded in case of a reboot.

If the upgrade or downgrade fails, the application may end up in an inconsistent state.

-- cgit v1.2.3