From f5a4d4d023a0bdaf1b57164f381cdf2620d49f04 Mon Sep 17 00:00:00 2001 From: Michael Wild Date: Wed, 3 Jun 2009 20:01:11 +0200 Subject: [PATCH] ENH: Updated INSTALL, ReleaseNotes and ChangeLog for v0.1.0rc4 Also moved common attributes into asciidoc.conf and made the code blocks substitute attributes by default such that the version number now can also be defined as such. Signed-off-by: Michael Wild --- ChangeLog | 18 ++++++++++++++++-- ChangeLog.html | 56 +++++++++++++++++++++++++++++++++++++++++++++++-------- INSTALL | 49 ++++++++++++++++++++++++------------------------ INSTALL.html | 44 +++++++++++++++++++++---------------------- README | 8 +++----- README.html | 12 ++++++------ ReleaseNotes | 10 +++++----- ReleaseNotes.html | 16 ++++++++-------- asciidoc.conf | 13 +++++++++++++ 9 files changed, 145 insertions(+), 81 deletions(-) diff --git a/ChangeLog b/ChangeLog index d9d766f35..224c486f3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,7 +1,7 @@ Change Log for FreeFOAM ======================= Michael Wild -v0.1.0rc3, 25 May 2009 +v{fullver}, {localdate} :Author Initials: MW :linkcss!: :numbered: @@ -12,9 +12,23 @@ It does not include changes made by the upstream developers (i.e. http://openfoam.org[OpenFOAM(R)]). For the detailed changes refer to the log provided by the http://repo.or.cz/w/freefoam.git[GIT repository]. +Changes in FreeFOAM 0.1.0rc4 +---------------------------- +* Improved building of METIS and ParMetis (no non-standard headers and + feature detection of mallinfo). +* Improved detection of backtrace() and backtrace_symbols() availability. +* Improved detection of SIGFPE handling capabilities. +* More flexible -doc and -srcDoc options using an index file. It is now + possible to use the online documentation and have FreeFOAM output + the location of the documentation file instead of trying to open it + using a browser. +* Fixed some bugs in the build system and some utility scripts. +* Merged with upstream (OpenFOAM-1.5.x), up to revision + linkrepo:openfoam[5f9a16]. + Changes in FreeFOAM 0.1.0rc3 ---------------------------- -* Fix typo in new dummyPrintStack.C. +* Fixed typo in new dummyPrintStack.C. Changes in FreeFOAM 0.1.0rc2 ---------------------------- diff --git a/ChangeLog.html b/ChangeLog.html index 9b7a43bb6..c79b80182 100644 --- a/ChangeLog.html +++ b/ChangeLog.html @@ -461,8 +461,8 @@ function generateToc(toclevels) {

Change Log for FreeFOAM

Michael Wild
<themiwi@users.sourceforge.net>
-version 0.1.0rc3, -25 May 2009 +version 0.1.0rc4, +2009-06-04
Table of Contents
@@ -477,17 +477,57 @@ It does not include changes made by the upstream developers (i.e. provided by the GIT repository.

-

1. Changes in FreeFOAM 0.1.0rc3

+

1. Changes in FreeFOAM 0.1.0rc4

  • -Fix typo in new dummyPrintStack.C. +Improved building of METIS and ParMetis (no non-standard headers and + feature detection of mallinfo). +

    +
  • +
  • +

    +Improved detection of backtrace() and backtrace_symbols() availability. +

    +
  • +
  • +

    +Improved detection of SIGFPE handling capabilities. +

    +
  • +
  • +

    +More flexible -doc and -srcDoc options using an index file. It is now + possible to use the online documentation and have FreeFOAM output + the location of the documentation file instead of trying to open it + using a browser. +

    +
  • +
  • +

    +Fixed some bugs in the build system and some utility scripts. +

    +
  • +
  • +

    +Merged with upstream (OpenFOAM-1.5.x), up to revision + 5f9a16. +

    +
  • +
+
+

2. Changes in FreeFOAM 0.1.0rc3

+
+
    +
  • +

    +Fixed typo in new dummyPrintStack.C.

-

2. Changes in FreeFOAM 0.1.0rc2

+

3. Changes in FreeFOAM 0.1.0rc2

  • @@ -511,7 +551,7 @@ Configure global.C instead of using preporcessor defines. This
-

3. Changes in FreeFOAM 0.1.0rc1

+

4. Changes in FreeFOAM 0.1.0rc1

  • @@ -645,8 +685,8 @@ Do not run XiFoam/moriyoshiHomogeneousPart2 when testing
diff --git a/INSTALL b/INSTALL index fd8a66723..ad7d99eb0 100644 --- a/INSTALL +++ b/INSTALL @@ -1,10 +1,8 @@ -FreeFOAM Installation Instructions for Version 0.1.0 -==================================================== +FreeFOAM Installation Instructions for Version {fullver} +======================================================== Michael Wild -v0.1.0, 25 May 2009 :Author Initials: MW -:linkcss!: -:numbered: +v{fullver}, {localdate} http://freefoam.sourceforge.net Building FreeFOAM @@ -18,19 +16,19 @@ Building FreeFOAM --------------------------------------------------------------------------- $ mkdir -p $HOME/Source $ cd $HOME/Source -$ wget http://switch.dl.sourceforge.net/sourceforge/freefoam/freefoam-0.1.0rc3.tar.bz2 -$ tar xjf freefoam-0.1.0rc3.tar.bz2 +$ wget http://master.dl.sourceforge.net/sourceforge/freefoam/freefoam-{fullver}.tar.bz2 +$ tar xjf freefoam-{fullver}.tar.bz2 --------------------------------------------------------------------------- - Create a build tree and _cd_ into it: + --------------- -$ mkdir $HOME/Source/freefoam-0.1.0rc3-build -$ cd $HOME/Source/freefoam-0.1.0rc3-build +$ mkdir $HOME/Source/freefoam-{fullver}-build +$ cd $HOME/Source/freefoam-{fullver}-build --------------- - Start CMake-configuration: + --------------- -$ ccmake $HOME/Source/freefoam-0.1.0rc3 +$ ccmake $HOME/Source/freefoam-{fullver} --------------- - Press the +c+ key. Use the arrow keys to navigate up and down and press +enter+ to edit a field. To commit the change, press +enter+ again, or +ESC+ @@ -42,7 +40,7 @@ $ ccmake $HOME/Source/freefoam-0.1.0rc3 +FF_USE_PVM+, respectively. You can also enable more than one of the options. + [NOTE] -Currently only MPI implementation is available. +Currently only the MPI implementation is available. + * Select the default Pstream implementation by setting +FF_DEFAULT_PSTREAM+ to one of 'dummy', 'mpi', 'pvm' or 'gamma'. This setting will only influence @@ -129,7 +127,7 @@ in the following places (in the specified order, picking the first hit): 1. Under the directory specified in the +$FREEFOAM_CONFIG_DIR+ environment variable -2. In '$HOME/.FreeFOAM/0.1' +2. In '$HOME/.FreeFOAM/{shortver}' 3. In '$HOME/.FreeFOAM' 4. In the installation directory of the configuration files. There are two possible places for this: @@ -139,7 +137,7 @@ in the following places (in the specified order, picking the first hit): '':: if you specified ++ as an absolute path. + -The default location is '/usr/local/etc/FreeFOAM/0.1.0'. +The default location is '/usr/local/etc/FreeFOAM-{ver}'. Selecting the Parallel Communications Library ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -221,9 +219,9 @@ You can use FreeFOAM without installing it first, directly from the build tree. However, this might take a little bit more effort to set up because most likely you will have to adjust the following environment variables: -PATH:: Must contain '$HOME/Source/freefoam-0.1.0rc3-build/bin' -LD_LIBRARY_PATH:: Must contain '$HOME/Source/freefoam-0.1.0rc3-build/lib/FreeFOAM-0.1.0' -FREEFOAM_CONFIG_DIR:: Should point to '$HOME/Source/freefoam-0.1.0rc3-build/etc' +PATH:: Must contain '$HOME/Source/freefoam-{fullver}-build/bin' +LD_LIBRARY_PATH:: Must contain '$HOME/Source/freefoam-{fullver}-build/lib/FreeFOAM-{ver}' +FREEFOAM_CONFIG_DIR:: Should point to '$HOME/Source/freefoam-{fullver}-build/etc' Where it is assumed that you followed the <>. If you used different paths for downloading and compiling FreeFOAM, you will have @@ -236,9 +234,9 @@ Running the tutorials Now you should be able to run the tutorial cases. For this copy the +tutorials+ directory to some convenient place: --------------- -$ mkdir -p $HOME/FreeFOAM/$LOGNAME-0.1/run -$ cp -r $HOME/Source/freefoam-0.1.0rc3-build/tutorials $HOME/FreeFOAM/$LOGNAME-0.1/run/ -$ cd $HOME/FreeFOAM/$LOGNAME-0.1/run/tutorials +$ mkdir -p $HOME/FreeFOAM/$LOGNAME-{shortver}/run +$ cp -r $HOME/Source/freefoam-{fullver}-build/tutorials $HOME/FreeFOAM/$LOGNAME-{shortver}/run/ +$ cd $HOME/FreeFOAM/$LOGNAME-{shortver}/run/tutorials --------------- And try to run e.g. the 'cavity' tutorial case: --------------- @@ -452,14 +450,14 @@ instructions on how to extend the search path. former can be achieved by: + -------------- -$ mkdir -p $HOME/.FreeFOAM/0.1 -$ cp $HOME/Source/freefoam-0.1.0rc3-build/etc/controlDict $HOME/.FreeFOAM/0.1 -$ cp $HOME/Source/freefoam-0.1.0rc3-build/etc/cellModels $HOME/.FreeFOAM/0.1 -$ cp -r $HOME/Source/freefoam-0.1.0rc3-build/etc/thermoData $HOME/.FreeFOAM/0.1 +$ mkdir -p $HOME/.FreeFOAM/{shortver} +$ cp $HOME/Source/freefoam-{fullver}-build/etc/controlDict $HOME/.FreeFOAM/{shortver} +$ cp $HOME/Source/freefoam-{fullver}-build/etc/cellModels $HOME/.FreeFOAM/{shortver} +$ cp -r $HOME/Source/freefoam-{fullver}-build/etc/thermoData $HOME/.FreeFOAM/{shortver} -------------- + The latter (and recommended) method is to set the environment variable -+FREEFOAM_CONFIG_DIR+ to '$HOME/Source/freefoam-0.1.0rc3-build/etc'. Adjust paths to the ++FREEFOAM_CONFIG_DIR+ to '$HOME/Source/freefoam-{fullver}-build/etc'. Adjust paths to the build tree to your actual setup. Starting Any FreeFOAM Application Fails Because Some Libraries Cannot Be Found @@ -481,7 +479,7 @@ installation directories: path. If you are trying to run from the build tree, you have to include -'$HOME/Source/freefoam-0.1.0rc3-build/lib/FreeFOAM-0.1.0' in the above mentioned search +'$HOME/Source/freefoam-{fullver}-build/lib/FreeFOAM-{ver}' in the above mentioned search paths (where you have to adjust the location of the build tree to your actual setup). @@ -582,6 +580,7 @@ strings naming directories in which the executables and libraries should be searched for. The individual paths are separated by a colon (+:+) character. To add the e.g. the directory '$HOME/bin' to the search path for executables, one would do the following: +[subs="verbatim"] ------- $ setenv PATH ${PATH}:${HOME}/bin ------- diff --git a/INSTALL.html b/INSTALL.html index f6556a783..e5613994a 100644 --- a/INSTALL.html +++ b/INSTALL.html @@ -4,7 +4,7 @@ -FreeFOAM Installation Instructions for Version 0.1.0 +FreeFOAM Installation Instructions for Version 0.1.0rc4