Changeset 69


Ignore:
Timestamp:
Feb 28, 2010 8:55:40 AM (11 years ago)
Author:
bradbell
Message:

[ckbs/trunk] Improve helper shell scripts.

svn_status.sh: remove some more work files from svn status list.
whatsnew.omh: fix cross reference link to ckbs (which changed).
ckbs.omh: Change download instrutions so will work with Coin automation.
copy_doc.sh: automatically bring ckbs web documentation up to date.
new_stable.sh: script to help create a new stable version.
build_doc.sh: exit if warnings or errors occur in documentation.

Location:
projects/ckbs/trunk
Files:
2 added
4 edited

Legend:

Unmodified
Added
Removed
  • projects/ckbs/trunk/build_doc.sh

    r61 r69  
    4242        cd ..
    4343fi
    44 if [ -d doc ]
     44if [ ! -e doc ]
    4545then
    46         echo "rm -r doc"
    47         rm -r doc
     46        echo "mkdir doc"
     47        mkdir doc
    4848fi
    49 echo "mkdir doc"
    50 mkdir doc
    5149#
    5250echo "cd doc"
     
    5452#
    5553# build the documentation
     54cmd="../$dir/src/omhelp"
     55log="../omhelp.log"
    5656for arg1 in "" -xml
    5757do
    5858        for arg2 in -noframe -printable
    5959        do
    60                 echo "../$dir/src/omhelp ../omh/ckbs.omh $arg1 $arg2 -debug"
    61                 ../$dir/src/omhelp ../omh/ckbs.omh $arg1 $arg2 -debug
     60                echo "omhelp omh/ckbs.omh $arg1 $arg2 -debug >& omhelp.log"
     61                if ! $cmd ../omh/ckbs.omh $arg1 $arg2 -debug >& ../omhelp.log
     62                then
     63                        echo "build_doc.sh: omhelp error, see omhelp.log"
     64                        exit 1
     65                fi
     66                if grep "^OMhelp Warning:" ../omhelp.log
     67                then
     68                        echo "build_doc.sh: omhelp warning, see omhelp.log"
     69                        exit 1
     70                fi
    6271        done
    6372done
  • projects/ckbs/trunk/omh/ckbs.omh

    r36 r69  
    66# -------------------------------------------------------------------
    77$begin ckbs$$
     8$dollar @$$
    89$rmark !$$
    910$spell
     11        Tarballs
     12        yyyymmdd
     13        yyyy mm dd
     14        www http https
     15        coin-or.org/svn/CoinBazaar
    1016        tarball
    1117        tgz
     
    3642%$$
    3743
    38 $section ckbs-0.20100118.0: A Constrained Kalman-Bucy Smoother$$
     44$section ckbs-0.20100228.0: A Constrained Kalman-Bucy Smoother$$
    3945
    4046$head MathML$$
     
    4551        $$
    4652        $href%
    47                 http://www.seanet.com/~bradbell/home.htm
     53                http://www.seanet.com/~bradbell/packages.htm
    4854        %$$
    4955
     
    5965        Octave
    6066%$$
     67While it will work under MS windows,
     68these download instructions are for the Unix operating system.
    6169
    62 $head Download Instructions$$
    63 Download the tarball $href%ckbs-0.20100118.0.tgz%$$.
    64 If you are using unix, or cygwin under Windows,
    65 you can extract the files from the tarball using the command
     70$head Download$$
     71
     72$subhead Using Subversion$$
     73If you have subversion, you can download a copy of the most recent
     74version of ckbs with the command
     75$codei%
     76        web="https://projects.coin-or.org/svn/CoinBazaar/projects/ckbs"
     77        svn checkout @web/trunk ckbs-0.20100228.0
     78%$$
     79You can download a previous release of ckbs with the command
     80$codei%
     81        svn checkout @web/releases/0.%yyyymmdd%.%r% ckbs-0.%yyyymmdd%.%r%
     82%$$
     83where $icode yyyy$$ is the year,
     84$icode mm$$ is the month,
     85$icode dd$$ is the day,
     86and $icode r$$ is the release number for the release you want.
     87In either case, this creates the directory
     88$codei%ckbs-0.%yyyymmdd%.%r%$$.
     89$pre
     90
     91$$
     92The release number ($icode r$$ above)
     93starts at zero and is incremented for bug fixes.
     94The date ($icode yyyymmdd$$ above)
     95is incremented with feature changes which are discussed by date
     96in the $cref/whatsnew/$$ section of this documentation
     97
     98$subhead Release Tarballs$$
     99If you do not have subversion you can download the tarball
     100$codei%ckbs-0.%yyyymmdd%.%r%.tgz%$$ from the release download directory
    66101$codep
    67         tar -xvzf ckbs-0.20100118.0.tgz
     102        http://www.coin-or.org/download/source/CoinBazaar
    68103$$
    69 This will
    70 create the directory $code ckbs-0.20100118.0$$.
    71 Otherwise (if you are using Windows) use
    72 $href%
    73         http://www.winzip.com%
    74         WinZip
     104You can extract the files from the tarball using the command
     105$codei%
     106        tar -xvzf ckbs-0.%yyyymmdd%.%r%.tgz
    75107%$$
    76 or some other program to decompress the archive and
    77 to create the $code ckbs-0.20100118.0$$
     108This will create the directory
     109$codei%ckbs-0.%yyyymmdd%.%r%$$.
    78110
    79111$head Test Install$$
    80112Using Matlab! or Octave, to change into the directory
    81 $codep
    82         ckbs-0.20100118.0/test
    83 $$
     113$codei%
     114        ckbs-0.%yyyymmdd%.%r%/test
     115%$$
    84116and run the program $code all_ok.m$$.
    85117It will print the test results for all the components of $code ckbs$$.
     
    87119$head Documentation$$
    88120A copy of the documentation for your version of ckbs can
    89 be viewed by loading
    90 $syntax%
    91         ckbs-0.20100118.0/doc/ckbs.xml
     121be built by executing the command
     122$codep
     123        ./build_doc.sh
     124$$
     125in the $code ckbs-0.%yyyymmdd%.%r%$$ directory.
     126You can then view the documentation by loading the file
     127$codei%
     128        ckbs-0.%yyyymmdd%.%r%/doc/ckbs.xml
    92129%$$
    93130into your browser.
  • projects/ckbs/trunk/omh/whatsnew.omh

    r35 r69  
    88$rmark !$$
    99$spell 
     10        yyyymmdd
     11        yyyy mm dd
    1012        ckbs
    1113        Matlab
     
    2426Its purpose is to assist you in learning about
    2527changes between versions.
     28
     29$head 10-02-28$$
     30Change $cref/download/ckbs/Download/$$ instructions
     31to correspond $href%http://www.coin-or.org%COIN-OR%$$ distribution
     32instead of form
     33$href%http://www.seanet.com/~bradbell%Brad Bell's home page%$$.
    2634
    2735$head 07-09-02$$
     
    142150$lnext
    143151The directory created when the
    144 $cref/download file/ckbs/Download Instructions/$$ was extracted
     152$cref/download file/ckbs/Download/Release Tarballs/$$ was extracted
    145153was $code ckbs$$ instead of $syntax%ckbs-%yy%-%mm%-%dd%$$.
    146154This has been fixed.
  • projects/ckbs/trunk/svn_status.sh

    r61 r69  
    1111        -e '/^[?] *junk$/d' \
    1212        -e '/^[?] *junk.sh$/d' \
     13        -e '/^[?] *omhelp.log$/d' \
    1314        -e '/^[?] *omhelp-[0-9][0-9]-[0-9][0-9]-[0-9][0-9]$/d' \
    14         -e '/^[?] *OMhelp.unix.tar.gz$/d'
     15        -e '/^[?] *OMhelp.unix.tar.gz$/d' \
     16        -e '/^[?] *temp$/d'
    1517       
Note: See TracChangeset for help on using the changeset viewer.