1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.2 -->
<HTML>
<HEAD>
<TITLE>relup</TITLE>
<SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
<STYLE TYPE="text/css">
<!--
.REFBODY { margin-left: 13mm }
.REFTYPES { margin-left: 8mm }
-->
</STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
<IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>relup</H1>
</CENTER>
<H3>FILE</H3>
<DIV CLASS=REFBODY>
relup
</DIV>
<H3>FILE SUMMARY</H3>
<DIV CLASS=REFBODY>
Release upgrade file
</DIV>
<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>
<P>The <STRONG>release upgrade file</STRONG> describes how a release is
upgraded in a running system.
<P>This file is automatically generated by
<CODE>systools:make_relup/3,4</CODE>, using a release resource file
(<CODE>.rel</CODE>), application resource files (<CODE>.app</CODE>) and
application upgrade files (<CODE>.appup</CODE>) as input.
</DIV>
<H3>FILE SYNTAX</H3>
<DIV CLASS=REFBODY>
<P>In a target system, the release upgrade file should be located in
the <CODE>OTP_ROOT/erts-EVsn/Vsn</CODE> directory.
<P>The <CODE>relup</CODE> file contains one single Erlang term, which
defines the instructions used to upgrade the release. The file has
the following syntax:
<PRE>
{Vsn,
[{UpFromVsn, Descr, Instructions}, ...],
[{DownToVsn, Descr, Instructions}, ...]}.
</PRE>
<P>
<UL>
<LI>
<CODE>Vsn = string()</CODE> is the current version of the release.<BR>
</LI>
<LI>
<CODE>UpFromVsn = string()</CODE> is an earlier version of the release
to upgrade from.<BR>
</LI>
<LI>
<CODE>Descr = term()</CODE> is a user defined parameter passed
from the <CODE>systools:make_relup/3,4</CODE> function. It will
be used in the return value of
<CODE>release_handler:install_release/1,2</CODE>.<BR>
</LI>
<LI>
<CODE>Instructions</CODE> is a list of low-level release upgrade
instructions, see <CODE>appup(4)</CODE>.<BR>
It consists of the release upgrade instructions from
the respective application upgrade files (high-level instructions
are translated to low-level instructions), in the same order
as in the start script.<BR>
</LI>
<LI>
<CODE>DownToVsn = string()</CODE> is an earlier version of the release
to downgrade to.<BR>
</LI>
</UL>
<P>When upgrading from <CODE>UpFromVsn</CODE> with
<CODE>release_handler:install_release/1,2</CODE>, there does not have to be
an exact match of versions, but <CODE>UpFromVsn</CODE> can be a sub-string
of the current release version.
</DIV>
<H3>SEE ALSO</H3>
<DIV CLASS=REFBODY>
<P>app(4), appup(4), rel(4), release_handler(3), systools(3)
</DIV>
<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Gunilla Hugosson - support@erlang.ericsson.se<BR>
</DIV>
<CENTER>
<HR>
<SMALL>sasl 2.0<BR>
Copyright © 1991-2004
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>
|
