Mercurial > forge
changeset 9395:dc6942faefe4 octave-forge
Package restructuring
author | mmarzolla |
---|---|
date | Sat, 04 Feb 2012 11:10:35 +0000 |
parents | 99c84b77abf3 |
children | cbc1e106d2dd |
files | main/queueing/DESCRIPTION main/queueing/DESCRIPTION.in main/queueing/INSTALL main/queueing/Makefile main/queueing/NEWS main/queueing/doc/INSTALL main/queueing/doc/Makefile main/queueing/doc/README main/queueing/doc/installation.txi main/queueing/doc/queueing.html main/queueing/doc/queueing.pdf |
diffstat | 11 files changed, 242 insertions(+), 216 deletions(-) [+] |
line wrap: on
line diff
--- a/main/queueing/DESCRIPTION Fri Feb 03 22:34:20 2012 +0000 +++ b/main/queueing/DESCRIPTION Sat Feb 04 11:10:35 2012 +0000 @@ -3,12 +3,16 @@ Date: 2012-02-03 Author: Moreno Marzolla <marzolla@cs.unibo.it> Maintainer: Moreno Marzolla <marzolla@cs.unibo.it> -Title: Queueing Networks and Markov chains analysis package for GNU Octave -Description: This package provides functions - for analyzing single station queueing systems, - Queueing Network and Markov chains. Open, closed and mixed - networks with single or multiple job classes are supported; - exact and approximate solution techniques are available. +Title: Queueing networks and Markov chains analysis package for GNU Octave +Description: The queueing toolbox provides functions for queueing + networks and Markov chains analysis. This package can be used + to compute steady-state performance measures for open, closed and mixed + networks with single or multiple job classes. Mean Valud Analysis (MVA), + convolution and various bounding techniques are implemented. Various + transient and steady-state performance measures for Markov chains can als + be computed (including state occupancy probabilities, mean time to absorption, + time-averaged sojourn times), both for continuous-time and discrete-time + chains. Categories: Misc Depends: octave (>= 3.0.0) Autoload: yes
--- a/main/queueing/DESCRIPTION.in Fri Feb 03 22:34:20 2012 +0000 +++ b/main/queueing/DESCRIPTION.in Sat Feb 04 11:10:35 2012 +0000 @@ -3,12 +3,16 @@ Date: VERSIONDATE Author: Moreno Marzolla <marzolla@cs.unibo.it> Maintainer: Moreno Marzolla <marzolla@cs.unibo.it> -Title: Queueing Networks and Markov chains analysis package for GNU Octave -Description: This package provides functions - for analyzing single station queueing systems, - Queueing Network and Markov chains. Open, closed and mixed - networks with single or multiple job classes are supported; - exact and approximate solution techniques are available. +Title: Queueing networks and Markov chains analysis package for GNU Octave +Description: The queueing toolbox provides functions for queueing + networks and Markov chains analysis. This package can be used + to compute steady-state performance measures for open, closed and mixed + networks with single or multiple job classes. Mean Valud Analysis (MVA), + convolution and various bounding techniques are implemented. Various + transient and steady-state performance measures for Markov chains can als + be computed (including state occupancy probabilities, mean time to absorption, + time-averaged sojourn times), both for continuous-time and discrete-time + chains. Categories: Misc Depends: octave (>= 3.0.0) Autoload: yes
--- a/main/queueing/INSTALL Fri Feb 03 22:34:20 2012 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,167 +0,0 @@ -This file documents the installation procedure of the `queueing' -toolbox. - - `queueing' is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License, version 3 or -later, as published by the Free Software Foundation. - - Note: This file (`INSTALL') is automatically generated from - `doc/installation.txi' in the `queueing' sources. Do not modify - this document directly, as changes will be lost. Modify the source - `doc/installation.txi' instead. - -1 Installing the queueing toolbox -********************************* - -1.1 Installation through Octave package management system -========================================================= - -The most recent version of `queueing' is 1.0.0 and can be downloaded -from - -`http://www.moreno.marzolla.name/software/queueing/queueing-1.0.0.tar.gz' - - To install `queueing' in the system-wide location, such that all -functions are automatically available when Octave starts, you can use -`pkg install' command. At the Octave prompt, type the following: - - octave:1> pkg install queueing-1.0.0.tar.gz - - (Note: you may need to start Octave as root in order to allow the -installation to copy the files to the target locations). After this, -all functions will be readily available each time Octave starts, -without the need to tweak the search path. To uninstall `queueing', use -the `pkg uninstall queueing' command. - - If you do not have root access, you can do a local installation by -issuing the following command at the Octave prompt: - - octave:1> pkg install -local queueing-1.0.0.tar.gz - - This will install `queueing' within the user's home directory, and -the package will be available to that user only. *Note:* Octave version -3.2.3 as shipped with Ubuntu 10.04 seems to ignore `-local' and always -tries to install the package on the system directory. - -1.2 Manual installation -======================= - -If you want to install `queueing' in a custom location, you can -download the source tarball from the URL above, and unpack it somewhere: - - tar xfz queueing-1.0.0.tar.gz - cd queueing-1.0.0/ - - Copy all `.m' files from the `inst/' directory to some target -location. Then, you can start Octave with the `-p' option to add the -target location to the search path, so that Octave will find all -`queueing' functions automatically: - - octave -p _/path/to/queueing_ - - For example, if all `queueing' m-files are in `/usr/local/queueing', -you can start Octave as follows: - - octave -p `/usr/local/queueing' - - If you want, you can add the following line to `~/.octaverc': - - addpath("_/path/to/queueing_"); - -so that the path `/usr/local/queueing' is automatically added to the -search path each time Octave is started, and you no longer need to -specify the `-p' option on the command line. - -1.3 Content of the source distribution -====================================== - -The `queueing' source distribution contains the following -subdirectories: - -`doc/' - Documentation source. Most of the documentation is extracted from - the comment blocks of individual function files from the `inst/' - directory. - -`inst/' - This directory contains the m-files which implement the various - Queueing Network algorithms provided by `queueing'. As a - notational convention, the names of source files containing - functions for Queueing Networks start with the `qn' prefix; the - name of source files containing functions for Continuous-Time - Markov Chains (CTMSs) start with the `ctmc' prefix, and the names - of files containing functions for Discrete-Time Markov Chains - (DTMCs) start with the `dtmc' prefix. - -`test/' - This directory contains the test functions used to invoke all - tests on all function files. - -`scripts/' - This directory contains some utility scripts mostly from GNU - Octave, which extract the documentation from the - specially-formatted comments in the m-files. - -`examples/' - This directory contains examples which are automatically extracted - from the `demo' blocks of the function files. - -`devel/' - This directory contains function files which are either not working - properly, or need additional testing before they can be moved to - the `inst/' directory. - - - The `queueing' package ships with a Makefile which can be used to -produce the documentation (in PDF and HTML format), and automatically -execute all function tests. Specifically, the following targets are -defined: - -`all' - Running `make' (or `make all') on the top-level directory builds - the programs used to extract the documentation from the comments - embedded in the m-files, and then produce the documentation in PDF - and HTML format (`doc/queueing.pdf' and `doc/queueing.html', - respectively). - -`check' - Running `make check' will execute all tests contained in the - m-files. If you modify the code of any function in the `inst/' - directory, you should run the tests to ensure that no errors have - been introduced. You are also encouraged to contribute new tests, - especially for functions which are not adequately validated. - -`clean' -`distclean' -`dist' - The `make clean', `make distclean' and `make dist' commands are - used to clean up the source directory and prepare the distribution - archive in compressed tar format. - - -1.4 Using the queueing toolbox -============================== - -You can use all functions by simply invoking their name with the -appropriate parameters; the `queueing' package should display an error -message in case of missing/wrong parameters. You can display the help -text for any function using the `help' command. For example: - - octave:2> help qnmvablo - - prints the documentation for the `qnmvablo' function. Additional -information can be found in the `queueing' manual, which is available -in PDF format in `doc/queueing.pdf' and in HTML format in -`doc/queueing.html'. - - Within GNU Octave, you can also run the test and demo blocks -associated to the functions, using the `test' and `demo' commands -respectively. To run all the tests of, say, the `qnmvablo' function: - - octave:3> test qnmvablo - -| PASSES 4 out of 4 tests - - To execute the demos of the `qnclosed' function, use the following: - - octave:4> demo qnclosed -
--- a/main/queueing/Makefile Fri Feb 03 22:34:20 2012 +0000 +++ b/main/queueing/Makefile Sat Feb 04 11:10:35 2012 +0000 @@ -4,7 +4,7 @@ DISTNAME=$(PROGNAME)-$(VERSIONNUM) SUBDIRS=inst scripts examples doc test devel -DISTFILES=COPYING NEWS Makefile DESCRIPTION INSTALL +DISTFILES=COPYING NEWS DESCRIPTION DISTSUBDIRS=inst doc .PHONY: clean check
--- a/main/queueing/NEWS Fri Feb 03 22:34:20 2012 +0000 +++ b/main/queueing/NEWS Sat Feb 04 11:10:35 2012 +0000 @@ -1,8 +1,5 @@ -Summary of important user-visible changes for releases of the queueing package - -=============================================================================== -queueing-1.0.0 Release Date: 2012-02-03 Release Manager: Moreno Marzolla -=============================================================================== +Summary of important user-visible changes for queueing-1.0.0 +------------------------------------------------------------------------------ ** First release of the queueing package
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/main/queueing/doc/INSTALL Sat Feb 04 11:10:35 2012 +0000 @@ -0,0 +1,172 @@ +This file documents the installation procedure of the `queueing' +toolbox. + + `queueing' is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License, version 3 or +later, as published by the Free Software Foundation. + + Note: This file (`INSTALL') is automatically generated from + `doc/installation.txi' in the `queueing' sources. Do not modify + this document directly, as changes will be lost. Modify the source + `doc/installation.txi' instead. + +1 Installing the queueing toolbox +********************************* + +1.1 Installation through Octave package management system +========================================================= + +The most recent version of `queueing' is 1.0.0 and can be downloaded +from Octave-forge + + `http://octave.sourceforge.net/' + + The package Web page is + + `http://www.moreno.marzolla.name/software/queueing/' + + To install `queueing' in the system-wide location, such that all +functions are automatically available when Octave starts, you can use +`pkg install' command. At the Octave prompt, type the following: + + octave:1> pkg install queueing-1.0.0.tar.gz + + (Note: you may need to start Octave as root in order to allow the +installation to copy the files to the target locations). After this, +all functions will be readily available each time Octave starts, +without the need to tweak the search path. To uninstall `queueing', use +the `pkg uninstall queueing' command. + + If you do not have root access, you can do a local installation by +issuing the following command at the Octave prompt: + + octave:1> pkg install -local queueing-1.0.0.tar.gz + + This will install `queueing' within the user's home directory, and +the package will be available to that user only. *Note:* Octave version +3.2.3 as shipped with Ubuntu 10.04 seems to ignore `-local' and always +tries to install the package on the system directory. + +1.2 Manual installation +======================= + +If you want to install `queueing' in a custom location, you can +download the source tarball from the URL above, and unpack it somewhere: + + tar xfz queueing-1.0.0.tar.gz + cd queueing-1.0.0/ + + Copy all `.m' files from the `inst/' directory to some target +location. Then, you can start Octave with the `-p' option to add the +target location to the search path, so that Octave will find all +`queueing' functions automatically: + + octave -p _/path/to/queueing_ + + For example, if all `queueing' m-files are in `/usr/local/queueing', +you can start Octave as follows: + + octave -p `/usr/local/queueing' + + If you want, you can add the following line to `~/.octaverc': + + addpath("_/path/to/queueing_"); + +so that the path `/usr/local/queueing' is automatically added to the +search path each time Octave is started, and you no longer need to +specify the `-p' option on the command line. + +1.3 Content of the source distribution +====================================== + +The `queueing' package source code in the Subversion repository +contains the following subdirectories (some of which are not included +in the installation archive): + +`doc/' + Documentation source. Most of the documentation is extracted from + the comment blocks of individual function files from the `inst/' + directory. + +`inst/' + This directory contains the m-files which implement the various + Queueing Network algorithms provided by `queueing'. As a + notational convention, the names of source files containing + functions for Queueing Networks start with the `qn' prefix; the + name of source files containing functions for Continuous-Time + Markov Chains (CTMSs) start with the `ctmc' prefix, and the names + of files containing functions for Discrete-Time Markov Chains + (DTMCs) start with the `dtmc' prefix. + +`test/' + This directory contains the test functions used to invoke all + tests on all function files. + +`scripts/' + This directory contains some utility scripts mostly from GNU + Octave, which extract the documentation from the + specially-formatted comments in the m-files. + +`examples/' + This directory contains examples which are automatically extracted + from the `demo' blocks of the function files. + +`devel/' + This directory contains function files which are either not working + properly, or need additional testing before they are moved to the + `inst/' directory. + + + The `queueing' package ships with a Makefile which can be used to +produce the documentation (in PDF and HTML format), and automatically +execute all function tests. Specifically, the following targets are +defined: + +`all' + Running `make' (or `make all') on the top-level directory builds + the programs used to extract the documentation from the comments + embedded in the m-files, and then produce the documentation in PDF + and HTML format (`doc/queueing.pdf' and `doc/queueing.html', + respectively). + +`check' + Running `make check' will execute all tests contained in the + m-files. If you modify the code of any function in the `inst/' + directory, you should run the tests to ensure that no errors have + been introduced. You are also encouraged to contribute new tests, + especially for functions which are not adequately validated. + +`clean' +`distclean' +`dist' + The `make clean', `make distclean' and `make dist' commands are + used to clean up the source directory and prepare the distribution + archive in compressed tar format. + + +1.4 Using the queueing toolbox +============================== + +You can use all functions by simply invoking their name with the +appropriate parameters; the `queueing' package should display an error +message in case of missing/wrong parameters. You can display the help +text for any function using the `help' command. For example: + + octave:2> help qnmvablo + + prints the documentation for the `qnmvablo' function. Additional +information can be found in the `queueing' manual, which is available +in PDF format in `doc/queueing.pdf' and in HTML format in +`doc/queueing.html'. + + Within GNU Octave, you can also run the test and demo blocks +associated to the functions, using the `test' and `demo' commands +respectively. To run all the tests of, say, the `qnmvablo' function: + + octave:3> test qnmvablo + -| PASSES 4 out of 4 tests + + To execute the demos of the `qnclosed' function, use the following: + + octave:4> demo qnclosed +
--- a/main/queueing/doc/Makefile Fri Feb 03 22:34:20 2012 +0000 +++ b/main/queueing/doc/Makefile Sat Feb 04 11:10:35 2012 +0000 @@ -1,10 +1,10 @@ DOC=queueing CHAPTERS=summary.texi installation.texi markovchains.texi singlestation.texi queueingnetworks.texi conf.texi ack.texi contributing.texi gpl.texi gettingstarted.texi -DISTFILES=README $(DOC).pdf $(DOC).html $(DOC).texi +DISTFILES=README INSTALL $(DOC).pdf $(DOC).html $(DOC).texi .PHONY: clean -ALL: pdf html ../INSTALL +ALL: pdf html INSTALL html: $(DOC).html @@ -12,10 +12,10 @@ info: $(DOC).info -../INSTALL: installation.texi +INSTALL: installation.texi rm -f ../INSTALL -$(MAKEINFO) -D INSTALLONLY \ - --no-validate --no-headers --no-split --output ../INSTALL $< + --no-validate --no-headers --no-split --output INSTALL $< $(DOC).html: $(DOC).texi $(CHAPTERS) -$(MAKEINFO) --html --no-split $(DOC).texi
--- a/main/queueing/doc/README Fri Feb 03 22:34:20 2012 +0000 +++ b/main/queueing/doc/README Sat Feb 04 11:10:35 2012 +0000 @@ -12,41 +12,47 @@ functions for steady-state and transient analysis of Markov chains, as well as fo single station queueing systems. -The latest version of the queueing package can be downloaded from +The Web page of the queueing toolbox is http://www.moreno.marzolla.name/software/queueing/ +The latest version can be downloaded from Octave-forge + +http://octave.sourceforge.net/ + This package requires GNU Octave; version 3.0.0 or later should work. -The package contains the following directories: +The package contains the following directories (note that some of +these are only available in the SVN repository, and are not included +in the tarball published on Octave-forge): inst/ - Contains the Octave m-scripts implementing all functions - provided by the queueing toolbox. + Contains the Octave m-scripts implementing all functions + provided by the queueing toolbox. doc/ Contains the user documentation, which is automatically generated from the texinfo strings embedded in the m-scripts. scripts/ - This directory contains some scripts used to extract - documentation strings from the m-files. The scripts here have - been taken almost verbatim from the GNU Octave distribution. + Contains some scripts used to extract documentation strings + from the m-files. The scripts here have been taken almost + verbatim from the GNU Octave distribution. examples/ - This directory contains demo functions which are automatically - extracted from the scripts included in the inst/ - directory. The demo functions are put in this directory so - that they can be easily embedded into the package documentation. + Contains demo functions which are automatically extracted from + the scripts included in the inst/ directory. The demo + functions are put in this directory so that they can be + embedded into the package documentation. test/ - This directory contains the script used to execute all - tests embedded within functions in the inst/ directory. + Contains the script used to execute all tests embedded within + functions in the inst/ directory. devel/ - This directory contains scripts which are currently known - not to work correctly, or which are work-in-progress. + Contains scripts which are currently under development, and + therefore should not be used. -This package can be distributed according to the terms of the GNU +The Octave queueing toolbox is distributed under the terms of the GNU General Public License, version 3 or later. See the file COPYING for details.
--- a/main/queueing/doc/installation.txi Fri Feb 03 22:34:20 2012 +0000 +++ b/main/queueing/doc/installation.txi Sat Feb 04 11:10:35 2012 +0000 @@ -56,9 +56,13 @@ @section Installation through Octave package management system The most recent version of @code{queueing} is @value{VERSION} and can -be downloaded from +be downloaded from Octave-forge + +@url{http://octave.sourceforge.net/} -@url{http://www.moreno.marzolla.name/software/queueing/queueing-@value{VERSION}.tar.gz} +The package Web page is + +@url{http://www.moreno.marzolla.name/software/queueing/} To install @code{queueing} in the system-wide location, such that all functions are automatically available when Octave starts, you can use @@ -136,8 +140,9 @@ @node Content of the source distribution @section Content of the source distribution -The @code{queueing} source distribution contains the following -subdirectories: +The @code{queueing} package source code in the Subversion repository +contains the following subdirectories (some of which are not included +in the installation archive): @table @file @item doc/ @@ -170,7 +175,7 @@ @item devel/ This directory contains function files which are either not working -properly, or need additional testing before they can be moved to the +properly, or need additional testing before they are moved to the @file{inst/} directory. @end table
--- a/main/queueing/doc/queueing.html Fri Feb 03 22:34:20 2012 +0000 +++ b/main/queueing/doc/queueing.html Sat Feb 04 11:10:35 2012 +0000 @@ -313,9 +313,13 @@ <h3 class="section">2.1 Installation through Octave package management system</h3> <p>The most recent version of <code>queueing</code> is 1.0.0 and can -be downloaded from - - <p><a href="http://www.moreno.marzolla.name/software/queueing/queueing-1.0.0.tar.gz">http://www.moreno.marzolla.name/software/queueing/queueing-1.0.0.tar.gz</a> +be downloaded from Octave-forge + + <p><a href="http://octave.sourceforge.net/">http://octave.sourceforge.net/</a> + + <p>The package Web page is + + <p><a href="http://www.moreno.marzolla.name/software/queueing/">http://www.moreno.marzolla.name/software/queueing/</a> <p>To install <code>queueing</code> in the system-wide location, such that all functions are automatically available when Octave starts, you can use @@ -389,8 +393,9 @@ <h3 class="section">2.3 Content of the source distribution</h3> -<p>The <code>queueing</code> source distribution contains the following -subdirectories: +<p>The <code>queueing</code> package source code in the Subversion repository +contains the following subdirectories (some of which are not included +in the installation archive): <dl> <dt><samp><span class="file">doc/</span></samp><dd>Documentation source. Most of the documentation is extracted from the @@ -417,7 +422,7 @@ from the ‘<samp><span class="samp">demo</span></samp>’ blocks of the function files. <br><dt><samp><span class="file">devel/</span></samp><dd>This directory contains function files which are either not working -properly, or need additional testing before they can be moved to the +properly, or need additional testing before they are moved to the <samp><span class="file">inst/</span></samp> directory. </dl>