[IGSTK-Developers] The Book, Chapter 1, Directory Structure: Confusion on CVS modules

[Luis Ibanez]

Section 1.2.4 of the book, with title "Directory Structure",
has some misleading (incorrect ?) information.


The second paragraph says:


IGSTK is organized into several different modules, or CVS checkouts. If you
are using an
official release, you will see three important modules: the Source, Testing,
and Examples
modules. The source code can be found in the Source module; testing code,
input data, and
baseline images can be found in Testing; and example applications using
IGSTK are available
in Examples directory. There is also an Utilities directory containing some
auxiliary scripts.
The Source directory contains all the components of IGSTK. When you are
working with this
library, you can refer to the code in Testing and Examples to learn how the
classes are being
used.


This is confusing subdirectories with CVS modules.

The CVS modules of IGSTK are:

   - IGSTK
   - IGSTKSandbox
   - IGSTKDocuments


Referring to the subdirectories  "Source", "Testing" and "Examples"  as "CVS
modules"
is incorrect.

We probably should refer to them simply as "directories" or
"subdirectories".

Something like:


IGSTK is organized into several different subdirectories. If you are using
an
official release, you will see three important subdirectories: the Source,
Testing, and Examples
subdirectories. The source code can be found in the Source subdirectory;
testing code, input data, and
baseline images can be found in Testing; and example applications using
IGSTK are available
in Examples directory. There is also an Utilities directory containing some
auxiliary scripts.
The Source directory contains all the components of IGSTK. When you are
working with this
library, you can refer to the code in Testing and Examples to learn how the
classes are being
used.


     Luis
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://public.kitware.com/pipermail/igstk-developers/attachments/20081209/1659df3a/attachment-0001.html>