DOC: Fix etc/controlDict.in::parRunTemplate variables doc
[freefoam.git] / ChangeLog
blob5517418c9caf094043bf39e05a3e62b391baae7d
1 Change Log for {project}
2 ========================
3 Michael Wild <themiwi@users.sourceforge.net>
4 v{fullver}, {localdate}
5 :Author Initials: MW
6 :linkcss!:
7 :numbered:
8 {homepage}
10 :openfoam: http://openfoam.org[OpenFOAM(R)]
11 :repo: http://repo.or.cz/w/freefoam.git[GIT repository]
12 :opencfd: http://opencfd.co.uk[OpenCFD(R) Ltd.]
14 This file describes the most important changes made between {project} versions.
15 It does not include changes made by the upstream developers (i.e.  {openfoam}).
16 For the detailed changes refer to the log provided by the {repo}.
18 Changes in {project} 0.1.0rc5
19 -----------------------------
20 * Merged with upstream (OpenFOAM-1.6.x and OpenFOAM-1.7.x),
21   up to revision linkrepo:openfoam17[d08d3c].
22 * Changed API-doc URL to be versioned.
23 * Updated the design of the API-doc to match the homepage.
24 * Generate a doc-index mapping application names to HTML file names.
25 * Removed obsolete shell scripts.
26 * Create manpages from the header comments.
27 * Updated/fixed/extended header comments.
28 * Added manpages for the scripts.
29 * Translated all scripts to Python.
30 * foamCalc accepts options properly.
31 * Added work-arounds for old GCC compilers (pre-4.4).
32 * Removed the ParaView plugins.
33 * Reworked build system.
34 * metisDecomp and scotchDecomp were extracted into separate libraries.
35 * zlib can now be auto-downloaded and built if not available.
36 * Print a spiffy feature summary after the configuration finished.
37 * Added a rudimentary wmake compatibility layer and a simplistic wmake-to-CMake
38   conversion script.
39 * Drive the tutorial-cases using CTest.
40 * Added template script for setting up a CDash client.
41 * Removed gammaPstream as Gamma appears to be dead.
42 * Ported the online OpenFOAM-UserGuide to AsciiDoc source and create XHTML and
43   PDF documents from it.
44 * Fixed various static initialization issues.
45 * Fixed many minor bugs and added numerous small improvements.
47 Changes in {project} 0.1.0rc4
48 -----------------------------
49 * Improved building of METIS and ParMetis (no non-standard headers and
50   feature detection of mallinfo).
51 * Improved detection of backtrace() and backtrace_symbols() availability.
52 * Improved detection of SIGFPE handling capabilities.
53 * More flexible -doc and -srcDoc options using an index file. It is now
54   possible to use the online documentation and have {project} output
55   the location of the documentation file instead of trying to open it
56   using a browser.
57 * Fixed some bugs in the build system and some utility scripts.
58 * Merged with upstream (OpenFOAM-1.5.x), up to revision
59   linkrepo:openfoam[5f9a16].
61 Changes in {project} 0.1.0rc3
62 -----------------------------
63 * Fixed typo in new dummyPrintStack.C.
65 Changes in {project} 0.1.0rc2
66 -----------------------------
67 * Only print stack trace if the system supports it and then only don't
68   try to shell-escape and use addr2line for file/line information.
69 * Use full version number for default installation directory names and
70   use the hyphen to separate it from the directory name instead of creating a
71   subdirectory.
72 * Configure global.C instead of using preporcessor defines. This
73   solves unnecessary recompiles of the complete OpenFOAM library.
75 Changes in {project} 0.1.0rc1
76 -----------------------------
77 * CMake based build system
78 * New, automatically created include-structure in the build tree,
79   corresponding to the install tree:
82   <binary_dir>/
83     include/
84       OpenFOAM/
85         Scalar.H -> includes <source_dir>/src/OpenFOAM/primitives/Scalar/Scalar.H
86         Scalar.C -> includes <source_dir>/src/OpenFOAM/primitives/Scalar/Scalar.C
87         ..
88       finiteVolume/
89         ..
90       compressibleRASModels/
91         ..
92       incompressibleRASModels/
93         ..
94       compressibleLESModels/
95         ..
96       incompressibleLESModels/
97         ..
98       ..
100 * All source files (with a few exceptions) use the new
101   ++#include <libname/filename>++ scheme
102 * Renamed files/directories with ambiguous names (distinguish only through
103   capitalization)
104 * Applied B. Gschaider's Mac OS X Patches versions 1 and 3
105 * Made the interfaces of sig{Fpe,Int,Quit,Segv} OS-agnostic
106 * Moved 'Pstream' implementations into loadable modules
107 * Configurable search path for plugins
108 * Removed all dependencies on environment variables
109 * Removed wmake build system and shell init scripts
110 * Removed obsolete, useless and black-magick scripts from +bin/+
111 * Adapted Doxygen creation to {project}
112 * Use a user-configurable template string for running parallel jobs with 'foamJob'
113 * Moved non-essential utility scripts to +data/utilities+
114 * Moved +bin/tools+ into +data/shellFunctions+
115 * Turned +bin/{newSource,newSourceTemplate}+ into shell-functions
116 * Added +\~{project}/+ to be expanded like +~OpenFOAM/+
117 * Improved 'dotFoam()' search for config files
118 * Rebranded source templates, Doxygen doc, 'IOobject::writeBanner()' and the
119   scripts in +bin/+
120 * Do not run +XiFoam/moriyoshiHomogeneousPart2+ when testing
122 ''''''''''''''''''''''''''''
123 {openfoam} is a registered trademark of {opencfd}
125 //////////////////////////////////////////////////////////////////
126 Process with: asciidoc -a toc -f data/asciidoc/html.conf ChangeLog
128 Vim users, this is for you:
129 vim: ft=asciidoc sw=2 expandtab fenc=utf-8
130 //////////////////////////////////////////////////////////////////