changeset 10732:8c0a388722bd octave-forge

control: doc fixes
author paramaniac
date Sun, 26 Aug 2012 18:16:46 +0000
parents 0345c92dd5b7
children 43748916cab9
files main/control/inst/test_control.m
diffstat 1 files changed, 8 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/main/control/inst/test_control.m	Sun Aug 26 15:46:40 2012 +0000
+++ b/main/control/inst/test_control.m	Sun Aug 26 18:16:46 2012 +0000
@@ -18,20 +18,21 @@
 ## -*- texinfo -*-
 ## @deftypefn {Script File} {} test_control
 ## Execute all available tests at once.
-## The Octave control package is based on the @uref{http://www.slicot.org, SLICOT} library.
-## SLICOT needs a LAPACK library which is also a prerequisite for Octave itself.
+## The Octave control package is based on the @uref{http://www.slicot.org, @acronym{SLICOT}} library.
+## @acronym{SLICOT} needs @acronym{BLAS} and @acronym{LAPACK} libraries which are also prerequisite for Octave itself.
 ## In case of failing test, it is highly recommended to use
-## @uref{http://www.netlib.org/lapack/, Netlib's reference LAPACK}
-## for building Octave.  Using ATLAS may lead to sign changes
-## in some entries in the state-space matrices.
+## @uref{http://www.netlib.org/blas/, Netlib's reference @acronym{BLAS}} and
+## @uref{http://www.netlib.org/lapack/, @acronym{LAPACK}}
+## for building Octave.  Using @acronym{ATLAS} may lead to sign changes
+## in some entries of the state-space matrices.
 ## In general, these sign changes are not 'wrong' and can be regarded as
 ## the result of state transformations.  Such state transformations
 ## (but not input/output transformations) have no influence on the
 ## input-output behaviour of the system.  For better numerics,
 ## the control package uses such transformations by default when
 ## calculating the frequency responses and a few other things.
-## However, arguments like the Hankel singular Values (HSV) must not change.
-## Differing HSVs and failing algorithms are known for using Framework Accelerate
+## However, arguments like the Hankel singular Values (@acronym{HSV}) must not change.
+## Differing @acronym{HSV}s and failing algorithms are known for using Framework Accelerate
 ## from Mac OS X 10.7.
 ## @end deftypefn