5 "Eclipse Public License v1.0" which accompanies this distribution, |
5 "Eclipse Public License v1.0" which accompanies this distribution, |
6 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". |
6 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". |
7 |
7 |
8 Release notes for Orb |
8 Release notes for Orb |
9 ================================================ |
9 ================================================ |
10 version 0.1.5 |
10 version 0.1.7 |
11 |
11 Updates to Doxygen (Doxygen version 1.6.2-20100106_dita_0.1.26-Doxygen version 1.6.2-20100106_dita_0.1.45) |
|
12 Fixed defect - links to inherited members are to the wrong file. |
|
13 Added option: CLEAR_INCLUDE_CACHE - This clears the include cache after each component has been read so that the include files will be read again. |
|
14 Fixed generate 0.5.0 DOCTYPE declarations. |
|
15 Removed flushing of include cache as this was correct but expensive. |
|
16 #define CLEAR_G_ALLINCLUDES 0 |
|
17 Updated DTDs to version 0.5.0 |
|
18 Added esock_dll generated by Doxygen version 1.6.2-20100106_dita_0.1.38 |
|
19 Fixes for removing duplicates when #including. |
|
20 Aligned with version 0.5 of the DTDs. |
|
21 Added -d includes to dump out the include graph. |
|
22 DTDs updated to verison 0.5.0. |
|
23 Fixed DITA generator so that cxxInterface etc. is not written out. |
|
24 Major fix to improve linking to #included files. |
|
25 Added XML_DITA_OMIT_DUPLICATE_MEMBERS = YES to doxtemplate.txt |
|
26 |
|
27 version 0.1.6 |
|
28 Updates to Doxygen (Doxygen version 1.6.2-20100106_dita_0.1.18-Doxygen version 1.6.2-20100106_dita_0.1.24) |
|
29 Updated to create more compatible Dita Open Toolkit output |
|
30 Updated with option to not omit classes with incomplete function definitions (by default it does) |
|
31 keyref attributes now href attributes (conditionally compiled) |
|
32 Updates to Post Processing: |
|
33 XSLT for transforming Doxygen output to DITA Reference dtd updated for better formating in Dita Open toolkit |
|
34 Updated for more informative logging on stdout/stderr during post processing |
|
35 Updated toolchain to partially support cross referencing |
|
36 Included map creation support for non-distributed system definition 3 files |
|
37 |
|
38 version 0.1.5.1 |
|
39 Doxygen version 1.6.2-20100106_dita_0.1.15 |
|
40 Fixed bug in element prefix creator that was generating spurious element names. |
|
41 Added addittional file extensions for Symbian like code. |
|
42 Fixed memory leak. |
|
43 Added extra reporting. |
|
44 Added error checking to post processing batch script and ditaot/mode option |
|
45 Updated file renamer to support dita open toolkit file names |
|
46 Updated guidiser to support dita open toolkit ids |
|
47 |
12 System Requirements |
48 System Requirements |
13 =================== |
49 =================== |
14 |
50 |
15 For information on installing all listed below see "install_orb.txt" |
51 For information on installing all listed below see "install_orb.txt" |
16 |
52 |
17 * Symbian Build System v2 version 2.10.0 |
53 * Symbian Build System v2 version 2.10.0 |
18 * RVCT 2.2 onwards |
54 * RVCT 2.2 onwards |
19 * epoc32 tree (Symbian Platform SDK/PDK) |
55 * epoc32 tree (Symbian Platform SDK/PDK) |
|
56 * 1GB memory per Symbian build system thread running doxygen.exe |
|
57 * 8GB free disk space |
20 |
58 |
21 Known issues |
59 Known issues v0.1.7 |
22 ============ |
60 =================== |
|
61 Missing content |
|
62 --------------- |
|
63 Some classes have no members. There are approximately 1600 exported classes using the NONSHARABLE_CLASS macro. Doxygen is handling macros in |
|
64 implementation files but not those in #included files. |
23 |
65 |
24 Doxygen produces a dialog box that appears under certain error conditions. |
66 Still losing whole components due to DITA-OT memory issues. This results in large groups of missing links. |
25 The dialog indicates that an error has occured with doxygen and this suspends the |
|
26 execution of doxygen until the ok button is pressed on the dialog. |
|
27 If doxygen is being run by a continuous integration system this dialog may be hidden. |
|
28 Invalid C++ is one known cause of this problem. |
|
29 |
67 |
30 Doxygen has been known to take many days to run the full Symbian OS source. |
68 Misplaced content |
31 It is suspected that this is due to a large amount of page faults when ram runs low. |
69 ----------------- |
32 Each doxygen process can use 500mb of ram and Raptor runs one doxygen process for each cpu. |
70 There is an issue with content in the wrong components. Critically this leaves some libraries empty. |
33 The space required for the working directory used by doxygen is greater than 80Gb. |
|
34 Please take this into consideration when choosing a build environment for Orb. |
|
35 |
71 |
|
72 Potential issues |
|
73 ---------------- |
|
74 There are still out of memory issues in DITA-OT, which are exacerbated by the “classes in wrong components” issue that is causing the maps |
|
75 of some components to be larger than they should be. |
|
76 |
|
77 Missing targets |
|
78 --------------- |
|
79 Missing targets caused by command lines that are too long. Orb outputs a file (meta.xml) which outputs all the includes using echo. |
|
80 Unfortunately there is a character limit on the command line so the entire echo doesn't get printed which means that the file is invalid. |
|
81 |
|
82 |
|
83 |
|
84 |