- Expanded user manual structure, feedback is strongly recommended

- Replaced the annoying "Application Name" in the about dialog with SGPEMv2

git-svn-id: svn://svn.gna.org/svn/sgpemv2/trunk@1042 3ecf2c5c-341e-0410-92b4-d18e462d057c
This commit is contained in:
elvez 2006-09-07 13:32:10 +00:00
parent 449af3cd3e
commit 116400defd
2 changed files with 153 additions and 20 deletions

View File

@ -70,7 +70,11 @@ Free Documentation License''.
as well as providing some advice for as well as providing some advice for
believed-to-be useful compilation options. believed-to-be useful compilation options.
* Starting with SGPEM:: Insructions on how to use SGPEM. * Basics:: Things you should know before starting.
* Using SGPEM:: Instructions on how to use SGPEM.
* Extending SGPEM:: Learn how to write new policies and plugins.
* License:: A full copy of the GNU Free Documentation License * License:: A full copy of the GNU Free Documentation License
this manual is licensed into. this manual is licensed into.
@ -85,6 +89,9 @@ Free Documentation License''.
@unnumbered History @unnumbered History
@table @strong @table @strong
@item 2006, September 7th @r{--- Luca Vezzaro}
First attempt at expanding the manual structure with the
stuff we'll need in the forthcoming beta testing
@item 2006, March 10th @r{--- Djina Verbanac} @item 2006, March 10th @r{--- Djina Verbanac}
Added chapter Writing new policies Added chapter Writing new policies
@item 2006, March 9th @r{--- Djina Verbanac} @item 2006, March 9th @r{--- Djina Verbanac}
@ -104,8 +111,8 @@ First draft of this document.
@c % -------------------------------------------------- @c % --------------------------------------------------
@node Overview of SGPEM, Installation, History, Top @node Overview of SGPEM, Installation, History, Top
@chapter Overview of SGPEM @chapter Overview of SGPEM
@menu @menu
@ -196,7 +203,7 @@ For more information see @ref{Writing new policies}.
@c % -------------------------------------------------- @c % --------------------------------------------------
@node Installation, Starting with SGPEM, Overview of SGPEM, Top @node Installation, Basics, Overview of SGPEM, Top
@chapter Installation @chapter Installation
@cindex installation @cindex installation
@ -354,23 +361,129 @@ install @command{dot}, part of the @emph{Graphviz} package.
@c % -------------------------------------------------- @c % --------------------------------------------------
@node Basics, Using SGPEM, Installation, Top
@chapter Basics
@cindex basics
@node Starting with SGPEM, License, Installation, Top @menu
@chapter Starting with SGPEM
@cindex starting * Policies:: Everything you'll ever wanted to know about policies
in SGPEM!
* The Scheduler:: Essential background information necessary to
understand how schedulable entities are scheduled.
@end menu
@c % -------------------------------------------------
@node Policies, The Scheduler, Basics, Basics
@section Policies
@cindex policies
@menu
* What is a policy in SGPEM?:: Explains what a SGPEM policy can, should and must do,
and what it can't do. And how.
* What kind of policies are there?:: In SGPEM there a two very different
kinds of policies. This subsection explains
these differences.
* Built-in policies:: Here you will find a detailed descriptions of the policies
shipped with the standard distribution of SGPEM.
@end menu
@node What is a policy in SGPEM?, What kind of policies are there?, Policies, Policies
@subsection What is a policy in SGPEM?
@cindex policies basics
@node What kind of policies are there?, Built-in policies, What is a policy in SGPEM?, Policies
@subsection What kind of policies are there?
@cindex policies kinds
@node Built-in policies, (none), What kind of policies are there?, Policies
@subsection Built-in policies
@cindex built-in policies
@c % -------------------------------------------------
@node The Scheduler, (none), Policies, Basics
@section The Scheduler
@cindex scheduler basics
@c % --------------------------------------------------
@node Using SGPEM, Extending SGPEM, Basics, Top
@chapter Using SGPEM
@cindex using
@menu
* From the GUI::
* From the commandline::
@end menu
@c % -------------------------------------------------
@node From the GUI, From the commandline, Using SGPEM, Using SGPEM
@section From the GUI
@cindex GUI
@menu
* The Schedulables/Requests tree::
* The Resources list::
* The Simulation widget::
* The Holt graph::
* The Preferences dialog::
* Controlling the simulation:: This subsection will explain you all the means
available to control the simulation workflow.
@end menu
@c % -------------------------------------------------
@node The Schedulables/Requests tree, The Resources list, From the GUI, From the GUI
@subsection The Schedulables/Requests tree
@cindex schedulables tree
@c % -------------------------------------------------
@node The Resources list, The Simulation widget, The Schedulables/Requests tree, From the GUI
@subsection The Resources list
@cindex resources
@c % -------------------------------------------------
@node The Simulation widget, The Holt graph, The Resources list, From the GUI
@subsection The Simulation widget
@cindex simulation widget
@c % -------------------------------------------------
@node The Holt graph, The Preferences dialog, The Simulation widget, From the GUI
@subsection The Holt graph
@cindex holt
@c % -------------------------------------------------
@node The Preferences dialog, Controlling the simulation, The Holt graph, From the GUI
@subsection The Preferences dialog
@cindex preferences
@c % -------------------------------------------------
@node Controlling the simulation, (none), The Preferences dialog, From the GUI
@subsection Controlling the simulation
@cindex simulation
@c % -------------------------------------------------
@node From the commandline, (none), From the GUI, Using SGPEM
@section From the commandline
@cindex commandline
@menu @menu
* SGPEM Commands:: Here you'll find a set of commands available * SGPEM Commands:: Here you'll find a set of commands available
from the command line from the command line
* SGPEM Output:: Interpretation of the output * SGPEM Output:: Interpretation of the output
* Writing new policies:: Steps that must be followed to insert a new policy
@end menu @end menu
@c % ------------------------------------------------- @c % -------------------------------------------------
@node SGPEM Commands, SGPEM Output, Starting with SGPEM, Starting with SGPEM @node SGPEM Commands, SGPEM Output, From the commandline, From the commandline
@section SGPEM Commands @subsection SGPEM Commands
@cindex commands @cindex commands
@ -409,8 +522,8 @@ If <string> is a valid command, it prints the usage instructions for that specif
@c % ------------------------------------------------- @c % -------------------------------------------------
@node SGPEM Output, Writing new policies, SGPEM Commands,Starting with SGPEM @node SGPEM Output, (none), SGPEM Commands, From the commandline
@section SGPEM Output @subsection SGPEM Output
@cindex output @cindex output
You can see the textual output of the simulation in your console window or on the GUI window provided with SGPEM v2. You can see the textual output of the simulation in your console window or on the GUI window provided with SGPEM v2.
@ -429,9 +542,22 @@ Each schedulable entity is represented by its name followed by its priority encl
@c % ------------------------------------------------ @c % ------------------------------------------------
@node Writing new policies, (none), SGPEM Output, Starting with SGPEM @c % -------------------------------------------------
@node Extending SGPEM, License, Using SGPEM, Top
@chapter Extending SGPEM
@cindex extending
@menu
* Writing new policies:: Steps that must be followed to insert a new policy
* Writing plugins::
@end menu
@node Writing new policies, Writing plugins, Extending SGPEM, Extending SGPEM
@section Writing new policies @section Writing new policies
@cindex policies @cindex writing policies
All policies are implemented in Python, but don't worry (be happy!). You don't have to be a Python expert to write a new policy. All policies are implemented in Python, but don't worry (be happy!). You don't have to be a Python expert to write a new policy.
We'll explain you how to write a new policy on an simple example of FCFS policy. Now let's start, all you have to do is change the few bold-ed lines, of the following example. We'll explain you how to write a new policy on an simple example of FCFS policy. Now let's start, all you have to do is change the few bold-ed lines, of the following example.
@ -498,9 +624,16 @@ This method is called by the scheduler at each step of the simulation to sort th
@c % -------------------------------------------------
@node Writing plugins, (none), Writing new policies, Extending SGPEM
@section Writing plugins
@cindex plugins
@c % ------------------------------------------------- @c % -------------------------------------------------
@c include license text @c include license text
@node License, Concept index, Starting with SGPEM, Top @node License, Concept index, Extending SGPEM, Top
@include fdl.texi @include fdl.texi
@c % -------------------------------------------------- @c % --------------------------------------------------

View File

@ -612,7 +612,7 @@
<widget class="GtkAboutDialog" id="AboutDialog"> <widget class="GtkAboutDialog" id="AboutDialog">
<property name="destroy_with_parent">False</property> <property name="destroy_with_parent">False</property>
<property name="name" translatable="yes">Application Name</property> <property name="name" translatable="yes">SGPEMv2</property>
<property name="copyright">University of Padova, dept. of Pure and Applied Mathematics</property> <property name="copyright">University of Padova, dept. of Pure and Applied Mathematics</property>
<property name="comments">An educational simulator for process scheduling policies in a monoprocessor computer.</property> <property name="comments">An educational simulator for process scheduling policies in a monoprocessor computer.</property>
<property name="license">SGPEMv2 comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome to redistribute it under the terms of the GNU General Public License; for details see file COPYING contained in the source package.</property> <property name="license">SGPEMv2 comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome to redistribute it under the terms of the GNU General Public License; for details see file COPYING contained in the source package.</property>