merge the formfield patch from ooo-build
[ooovba.git] / desktop / test / deployment / version / readme.txt
blob7d452fcc36032b2f5af1a142c93433989cdafda5
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  * 
5  * Copyright 2008 by Sun Microsystems, Inc.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * $RCSfile: readme.txt,v $
10  *
11  * $Revision: 1.5 $
12  *
13  * This file is part of OpenOffice.org.
14  *
15  * OpenOffice.org is free software: you can redistribute it and/or modify
16  * it under the terms of the GNU Lesser General Public License version 3
17  * only, as published by the Free Software Foundation.
18  *
19  * OpenOffice.org is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU Lesser General Public License version 3 for more details
23  * (a copy is included in the LICENSE file that accompanied this code).
24  *
25  * You should have received a copy of the GNU Lesser General Public License
26  * version 3 along with OpenOffice.org.  If not, see
27  * <http://www.openoffice.org/license.html>
28  * for a copy of the LGPLv3 License.
29  *
30  ************************************************************************/
32 There are three extensions in various versions:
34 1  version_XXX/plain.oxt has no dependencies and no license.
35 2a version_XXX/dependency.oxt has an unsatisfied dependency and no license.
36 2b version_nodependencies_XXX/dependency.oxt is identical to 2a but without the
37    dependency.
38 3  version_XXX/license.oxt has no dependencies and a license.
40 The different versions are:
42 A  version_none contains no version element (treated as version "0").
43 B  version_badelement contains a bad <version val="1"/> (not allowed by the
44    specification, but treated by the current implementation as version "0").
45 C  version_badvalue contains a bad <version value="1.a"/> (not allowed by the
46    specification, but treated by the current implementation as version "1").
47 D  version_0.0 contains <version value="0.0"/> (same as version "0").
48 E  version_1.2.3 contains <version value="1.2.3"/>.
49 F  version_1.2.4.7 contains <version value="1.2.4.7"/>.
50 G  version_1.02.4.7.0 contains <version value="1.02.4.7.0"/> (same as version
51    "1.2.4.7").
52 H  version_1.2.15.3 contains <version value="1.2.15.3"/>.
54 The total order among the various versions is thus
56   A = B = D < C < E < F = G < H.
58 Things to watch for:
60 - If version y of extension e is to be installed and version x < y of
61   extension e is already installed, then
62    unopkg add e
63   will replace x with y.
65 - If version y of extension e is to be installed and version x >= y of
66   extension e is already installed, then
67    unopkg add e
68   will fail with an error message.
70 - If version y of extension e is to be installed and any version x of
71   extension e is already installed, then
72    unopkg add -f e
73   will replace x with y.
75 - If version y of extension e is to be installed and any version x of
76   extension e is already installed, then
77    unopkg gui "Add..."
78   and
79    soffice "Tools - Package Manager... - Add..."
80   will query with a dialog whether to replace x with y.  The dialog will have
81   "OK" (replace) preselected if x < y, and "Cancel" otherwise.
83 - If replacing an installed version x of an extension e with a version y fails
84   because y has unsatisfied dependencies, or because y has a license to wich the
85   user does not agree, version x is left installed afterwards.
87 - Checking for already installed versions of an extension is only done within a
88   single layer (unopkg versus unopkg --shared; "My Packages" versus
89   "OpenOffice Packages" in unopkg gui/soffice), not across layers.