Build with debug symbols enabled.
[oweals/cde.git] / cde / README-2.1.10
1
2 **********************************************************************
3 NOTE: CDE/MOTIF IS LICENSED SOFTWARE.  SOURCE AND OBJECT CODE IS NOT
4 TO BE DISTRIBUTED TO THIRD PARTIES EXCEPT AS PROVIDED BY THE TERMS OF
5 YOUR LICENSE AGREEMENT.  PASSIVE DISTRIBUTION TO UNIDENTIFIED PARTIES,
6 SUCH AS MAKING FILES AVAILABLE FOR UNRESTRICTED ELECTRONIC FILE
7 TRANSFER, IS STRICTLY PROHIBITED BY THE LICENSE.
8
9 THESE RESTRICTIONS APPLY TO ANY PARTY TO WHOM THE SOFTWARE HAS BEEN
10 DISTRIBUTED.
11 **********************************************************************
12
13 THE PURPOSE OF THIS RELEASE
14
15         This is the first maintenance release for CDE and Motif 2.1.
16         It was designed to resolve as many defects as possible from the
17         project's defect database, with a concentration for CDE on dtmail
18         problems.  This maintenance release resolves 523 problem reports 
19         against CDE and Motif 2.1.
20
21
22         The Open Group encourages the reporting of all bugs found in CDE
23         and Motif regardless of the platform or hardware configuration in 
24         which the bug is found.  However, The Open Group will commit to 
25         accept (and repair according to priority) only those bugs that can 
26         be replicated on the current reference configurations.  
27
28
29
30 DOWNLOAD INSTRUCTIIONS
31
32         This section describes how to unload the release archives
33         available at this ftp site, including information about how much 
34         disk space is required.
35
36         The CDE/Motif 2.1.10 release is provided as compressed tar archives.  
37
38
39
40         README-2.1.10         - this file
41
42         cde.tar.Z             - a compressed tar file of the 
43                                 CDE 2.1.10 source code
44
45         cde-test.tar.Z        - a compressed tar file of the 
46                                 CDE 2.1.10 tests
47
48         cde-test-misc.tar.Z   - a compressed tar file of 
49                                 test results for CDE/Motif 2.1.10
50
51         motif.tar.Z           - a compressed tar file of the 
52                                 MOTIF 2.1.10 source code
53
54         motif-test-misc.tar.Z - a compressed tar file of 
55                                 test results for Motif 2.1.10
56
57
58 27 Mb   motif-test-misc
59
60         The CDE/Motif 2.1.10 release is in the form of a sparse tree; that 
61         is, it contains only files that have been modified in either CDE or 
62         Motif since the 2.1 release.  If you are a CDE licensee you will 
63         receive files for both CDE and Motif.  If you are a Motif-only 
64         licensee you will receive files just for Motif.
65
66         To download the archives from the ftp site you will need approximately
67         18.5 megabytes (for CDE licensees) or 9.3 megabytes (for Motif-only 
68         licensees) of disk space to hold just the compressed archives.  Once the 
69         archives have been downloaded they should be first uncompressed and then 
70         untarred (see instructions below).  The uncompressed archives require 
71         approximately 91 (CDE) or 37 (Motif-only) megabytes.  After untarring 
72         the archives, you will need an additional 96 (CDE) or 52 (Motif-only) 
73         megabytes of space to hold the unloaded directories.  Once the tar 
74         operation has completed you may wish to remove the tar archive files 
75         (*tar).
76
77
78         MOTIF-only      CDE/Motif
79         
80         Mb              Mb              Files                           
81         --              --              -----                   
82         (9.3            18.5            compressed archives )
83         
84         37              91              archives after uncompress
85         52              96              untarred archives
86         
87         89              187             Total 
88         
89          
90         After ftp-ing the files to your machine, you should first uncompress
91         the compressed (*.Z) files with the command:
92         
93                 uncompress <filename>.Z
94         
95         Once the tar archives have been uncompressed, you can untar each
96         with the command:
97         
98                 tar xvf <filename>.tar
99         
100         This command will preserve the .tar file while unloading its contents
101         into your current working directory.  If you wish to list a table of
102         contents of the tar file before actually unloading it you can do so
103         with the command:
104         
105                 tar tvf <filename>.tar
106         
107
108 INSTALLING THIS RELEASE
109
110         This release is made up of a "sparse tree" of files that have changed
111         since release 2.1. The new versions of the files should replace the
112         corresponding CDE or Motif 2.1 versions of the files in your source 
113         tree. 
114
115
116         After the release is unloaded, you can use, for example, cp -R command
117         to copy the sources from the current directory into your source tree.
118         This release creates several new files.  If you are using a symbolic
119         link tree, you will need to create new links for them.
120
121         Please see the Release Notes from 2.1 for instructions on building
122         a full release tree.
123         
124
125 IMPORTANT CHANGES IN THIS RELEASE
126
127
128         The majority of changes in this release are for general defect
129         repair in the code and tests.  Additionally, some focused work
130         was performed in the following areas described below: 
131
132                 X11R6.4 and XtMalloc
133                 Dtmail maintenance
134                 Japanese Translations
135
136
137 Defect Repair
138
139         This patch release resolves 523 problem reports against CDE and 
140         Motif 2.1.  Each of these defects were resolved in one of three
141         ways: fixed (problem was recreated and repaired), duplicate 
142         (problem was already reported and recorded in defect database), 
143         or cancelled (problem could not be recreated in current code
144         base).  The breakdown by component and resolution type is:
145
146         FIXED:  Total 326  
147
148                 CDE Code: 160           Motif Code: 91
149                     Doc:    2                 Test: 18
150                     Test:  55           
151                 -------------           --------------
152                 Total:    217           Total:     109
153
154
155         DUPLICATE:  Total 51
156
157                 CDE Code:  30           Motif Code: 10
158                     Doc:    4                 Test:  1
159                     Test:   6           
160                 -------------           --------------
161                 Total:     40           Total:      11
162
163         CANCEL:  Total 146
164
165                 CDE Code:  45           Motif Code: 49
166                     Test:  36                 Test: 14
167                                               Doc:   2
168                 -------------           --------------
169                 Total:     81           Total:      65
170
171         
172         For more information on the bugs resolved, see the file 
173         CLOSEDBUGS in this release.
174
175
176 X11R6.4 and XtMalloc
177
178         The Open Group is comitted to a unified desktop technology
179         (X, Motif and CDE).  Therefore we built and tested CDE and
180         Motif 2.1.10 against a pre-release version of X11R6.4.  Once
181         the final release of X11R6.4 is ready we will build and test
182         with it.  We do not expect to find any problems running with
183         the production version but will provide any fixes if 
184         necessary.
185
186         One important change that went into the X11R6.4 release was 
187         to fix the behavior of XtMalloc.  The specification clearly 
188         state that XtMalloc should behave like the underlying malloc
189         when passed a size of 0 (zero).  The old XtMalloc would
190         allocate space, even if it was passed a size of 0.  In X11R6.4 
191         XtMalloc no longer has this behavior.  On some platforms this
192         can cause failures with faulty code that depends on that 
193         behavior.
194
195         We have found such calls in both the CDE and Motif code through 
196         our test cycle and by visual inspection and have repaired them
197         along the way.  There is the potential for additional problems
198         of this form - developers should be alert to this possibility.
199
200         If developers want the old behavior of XtMalloc then they should 
201         define both MALLOC_0_RETURNS_NULL and XTMALLOC_BC in their
202         site.def file.
203  
204
205 Dtmail maintenance
206
207         In addition to intensive efforts to fix outstanding defects
208         throughout CDE and Motif, we paid special attention to problems
209         in the CDE 2.1.10 Mailer.  These problems include the following:
210
211         - Support for X11R6 Session Management Protocol
212         - Unified mailbox menus
213         - Support for mail aliases
214         - Support for mail retrieval from standard mail servers
215
216
217    Support for X11R6 Session Management Protocol 
218
219         The CDE 2.1.10 Mailer now supports the basic elements of the 
220         X11R6 Session Management Protocol including responding to 
221         interactive and non-interactive SaveYourself requests as well 
222         as Die requests.  For non-interactive SaveYourself requests, 
223         the Mailer simply saves the size and location of all the 
224         mailbox and compose windows.  Deleted messages in mailboxes are 
225         retained.  For interactive SaveYourself requests, the Mailer may 
226         display dialogs asking the user to verify that deleted messages 
227         should be expunged or that the contents of compose windows
228         should be deleted.
229
230
231    Unified file selection menus
232
233         The CDE 2.1.10 Mailer now provides a consistent set of menus 
234         and file selection boxes for all operations involving mailboxes.  
235         These operations include Mailbox->Open, Message->CopyTo, and Move.  
236         Previously, each of these commands had its own file selection box.  
237         Changes made in one FSB were not reflected in any of the others.  
238         In addition, the Mailbox->Open command did not provide users with 
239         the menu of predefined mailboxes as in the Message->CopyTo, and 
240         Move commands.  In the CDE 2.1.10 Mailer the operation of all 
241         three commands has been made completely consistent from the user's
242         perspective.
243
244         Similar fixes were made for all operations involving files 
245         including Message->SaveAsText and Attachments->SaveAs.
246
247
248    Support for mail aliases
249
250         Popup menus containing the user's predefined aliases were added to 
251         the address fields (To:, Cc:, and Bcc:) in the message composer 
252         dialogs.  The user can now add an addressee to one of these fields 
253         simply by selecting from the menu of aliases.
254
255
256    Support for mail retrieval from standard mail servers
257
258         The CDE 2.1.10 Mailer has been fixed to support retrieving mail 
259         from standard mail servers.  Supported Mail Server protocols 
260         include POP2, POP3, APOP, and IMAP.  However, to date, only the 
261         POP3 has been well tested at The Open Group.
262
263
264 Japanese Translations
265
266         Deliverables of the CDE 2.1 project included translations of
267         all documentation.  The Japanese translations were not received
268         in time for the 2.1 release but were delivered at the beginning
269         of this year.  They were made available electronically at that
270         time to licensees and have also been included in this 2.1.10 
271         release.  This includes Japanese manual pages and books.
272
273
274 BUG LISTS
275
276         In the release archive there are two files, OPENBUGS and 
277         CLOSEDBUGS, which contain, respectively, the list of all bugs 
278         from any version of CDE or Motif not yet closed, and all bugs 
279         from CDE or Motif fixed in this patch release.
280
281
282 BUILDING MOTIF FOR YOUR SYSTEM
283
284         This release requires no changes in the build process. Please
285         refer to the Release Notes for more information. 
286
287
288 REFERENCE PLATFORMS
289
290         The Open Group has used a number of platforms during the
291         development of the 2.1.10 release.  However, the following
292         reference platforms are the only ones where the complete
293         test cycle was run.  Test results appear below.
294
295
296    CDE and Motif:
297         HP9000/7xx running HP-UX 10.20
298         Digital Alpha 3000 running Digital Unix 4.0
299
300    Motif-only:
301         Sun SPARCstation running Solaris 2.4
302                 using the SC 4.0 C compiler and SC 4.1 C++ compilers
303
304
305 TEST RESULTS SUMMARY
306
307         Since this is a general availability release, it has undergone 
308         the full quality assurance cycle at The Open Group.  The test
309         cycle includes running the following test suites:
310
311                 MVS  - Motif Validation Suite
312                 QATS - Motif Quality Assurance Test Suite
313                 CDE Regression Tests
314                 CDE Performance Tests
315                 Memory Tests
316
317         The results of these test runs can be found in the release
318         archive under cde-test-misc/reports/cde2.1.10.