yade-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 2906
committer: jduriez <jduriez@c1solimara-l>
branch nick: yade
timestamp: Wed 2011-08-24 12:13:47 +0200
message:
  Few changes in doc (sphinx and Sconstruct's one) after https://answers.launchpad.net/yade/+question/169042
modified:
  SConstruct
  doc/sphinx/prog.rst


--
lp:yade
https://code.launchpad.net/~yade-dev/yade/trunk

Your team Yade developers is subscribed to branch lp:yade.
To unsubscribe from this branch go to https://code.launchpad.net/~yade-dev/yade/trunk/+edit-subscription

=== modified file 'SConstruct'
--- SConstruct	2011-04-26 16:02:57 +0000
+++ SConstruct	2011-08-24 10:13:47 +0000
@@ -90,7 +90,7 @@
 	('variant','Build variant, will be suffixed to all files, along with version.','' if profile=='default' else '-'+profile,None,lambda x:x),
 	BoolVariable('debug', 'Enable debugging information',0),
 	BoolVariable('gprof','Enable profiling information for gprof',0),
-	('optimize','Turn on optimizations (-1, 0 or 1); negative value sets optimization based on debugging: not optimize with debugging and vice versa.',-1,None,int),
+	('optimize','Turn on optimizations (-1, 0 or 1); with negative value (-1) optimization is based on debugging: not optimize with debugging (debug=True <=> optimize=False) and vice versa. With positive values optimization is performed (case of 1) or not (0) independent of debugging',-1,None,int),
 	EnumVariable('PGO','Whether to "gen"erate or "use" Profile-Guided Optimization','',['','gen','use'],{'no':'','0':'','false':''},1),
 	ListVariable('features','Optional features that are turned on','log4cxx,opengl,gts,openmp,vtk,qt4',names=['opengl','log4cxx','cgal','openmp','gts','vtk','gl2ps','qt4','sphere-padder','never_use_this_one','subdomains']),
 	('jobs','Number of jobs to run at the same time (same as -j, but saved)',2,None,int),

=== modified file 'doc/sphinx/prog.rst'
--- doc/sphinx/prog.rst	2011-05-03 15:04:37 +0000
+++ doc/sphinx/prog.rst	2011-08-24 10:13:47 +0000
@@ -32,7 +32,7 @@
 	 where to create ``build-\$SUFFIX`` directory 
 ``debug`` [*False* (0)]
 	add debugging symbols to output, enable stack traces on crash
-``optimize`` [*True* (1)]
+``optimize`` [-1, which means that the opposite of ``debug`` value is used]
 	optimize binaries (``#define NDEBUG``; assertions eliminated; ``YADE_CAST`` and ``YADE_PTR_CAST`` are static casts rather than dynamic; LOG_TRACE and LOG_DEBUG are eliminated)
 ``CPPPATH`` [``/usr/include/vtk-5.2:/usr/include/vtk-5.4``]
 	additional colon-separated paths for preprocessor (for atypical header locations). Required by some libraries, such as VTK (reflected by the default)