[cig-commits] commit: Some documentation cleaning

[Mercurial]

changeset:   248:f155cc3a20ad
branch:      1.4.x
user:        JulianGiordani
date:        Wed Jan 20 13:12:53 2010 +1100
files:       ChangeLog README XMLChanges_1.4
description:
Some documentation cleaning


diff -r d9f635194ab6 -r f155cc3a20ad ChangeLog
--- a/ChangeLog	Tue Jan 19 16:26:32 2010 +1100
+++ b/ChangeLog	Wed Jan 20 13:12:53 2010 +1100
@@ -1,7 +1,7 @@ ChangeLog for Underworld-1.4
 ChangeLog for Underworld-1.4
 
 * New configuration step in installation process, './configure.py -h' for help.
-* Changes to the XML user interface, see manual for details.
+* Changes to the XML user interface, see the file XMLChanges_1.4 for details.
 * Multigrid solver is now available. 
 * Superconvergent Patch Recovery (SPR) Method is now available.
 * Significant checkpointing improvements, hdf5 format is now the standard format, see manual for details.
diff -r d9f635194ab6 -r f155cc3a20ad README
--- a/README	Tue Jan 19 16:26:32 2010 +1100
+++ b/README	Wed Jan 20 13:12:53 2010 +1100
@@ -64,6 +64,8 @@ To run tests:
 * The test, PCDVCSuite, fails under optimised mode on 32-bit machines.
 * Significant warnings are produced in compile.... don't be alarmed, we are working on them.
 
+Please see XMLChanges_1.4, for details of important input file change for this release
+
 ========================
   CONTACT INFORMATION
 ========================
diff -r d9f635194ab6 -r f155cc3a20ad XMLChanges_1.4
--- a/XMLChanges_1.4	Tue Jan 19 16:26:32 2010 +1100
+++ b/XMLChanges_1.4	Wed Jan 20 13:12:53 2010 +1100
@@ -58,7 +58,12 @@ This adds verbosity to the plugins and r
 This adds verbosity to the plugins and requires the user to know what parameters to pass to a plugin. As with the “Components”, parameters passed in are error checked and the code will halt and report a problem if invalid parameters are found. This change is necessary for the code restructure of late 2009.
 
 ==============================================
-3. Declaring gLucifer
+3. Verticies ---- > Vertices
+==============================================
+The code now uses the correct spelling 'vertices' to define a list containing multiple vertex points. The previous, incorrect spelling was 'verticies'. Please check that your Shape definitions are consistent with this.
+
+==============================================
+4. Declaring gLucifer
 ==============================================
 If creating gLucifer visualisation and NOT including the template <include>glucifer/window.xml</include>, one must define