Update of /cvsroot/compbench/CompBenchmarks++
In directory sc8-pr-cvs4.sourceforge.net:/tmp/cvs-serv27605
Modified Files:
main.h
Log Message:
Updated documentation.
Index: main.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/main.h,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** main.h 6 Feb 2007 19:35:59 -0000 1.9
--- main.h 1 May 2007 14:39:29 -0000 1.10
***************
*** 10,22 ****
#define H_CBMMAIN
! /*! \mainpage CompBenchmarks Internals
*
* \section intro_sec A foreword
*
! * This document presents source layout and organisation of CompBenchmarks.
! * As a reminder, this software has been released under the GPL license.
*
! * It'd be useful for developpers or contributers, as well as for people
! * who like to get an overview about how things are done.
*
* New releases and complementory information can be found at
--- 10,30 ----
#define H_CBMMAIN
! /*! \mainpage CompBenchmarks Reference Manual
*
* \section intro_sec A foreword
*
! * This document presents concepts, source layout and organisation of CompBenchmarks.
! * As a reminder, this software has been released under the GPL license and aims to
! * provide a convenient environment to benchmark softwares using different compilers
! * and options on a variety of architectures.
*
! * \subsection foreword_programs Programs
! *
! * CompBenchmarks is a package built around the libcompbenchmarks shared library,
! * which brings core functionnalities. It also comes with
! * compbenchmarks-core, other programs and user interfaces that uses and interract with
! * libcompbenchmarks.
! *
! * \subsection foreword_moreinfo More informations
*
* New releases and complementory information can be found at
***************
*** 25,35 ****
* \section abstraction General organisation
*
! * CompBenchmarks suite has been (re)written in C++, to add more flexibility.
! * Its core rely on a few abstracts (as in C++) definitions (concepts) :
! * - \link CBM::System operating system\endlink,
! * - \link CBM::Package package\endlink,
! * - \link CBM::Benchmark benchmark\endlink,
! * - \link CBM::Compiler compiler\endlink and \link CBM::CompilerOptions compilation options\endlink,
! * - \link CBM::UI user interface\endlink.
*
* Basically, operating system object is detected at CompBenchmarks
--- 33,49 ----
* \section abstraction General organisation
*
! * CompBenchmarks core relies on a few definitions :
! * - \link CBM::System operating system\endlink which provides abstraction interface for all supported operating systems,
! * - \link CBM::Package package\endlink; that's API to declare and handle packages.
! * - \link CBM::Benchmark benchmark\endlink; which uses packages to describe what are related benchmarks,
! * - \link CBM::Compiler compilers\endlink and \link CBM::CompilerOptions compilation options\endlink and \link CBM::CompilerOptionDescriptions descriptions\endlink,
! * - \link CBM::Plan benchmark plan\endlink. It stores and handles current benchmarking context,
! * - \link CBM::UI user interface\endlink. Higher-level core abstractions for UI.
! *
! * These concepts aims giving flexibility and should improve (re-)useability.
! *
! * Another major element is \ref howto_kb "knowledge-base", which can for instance enlight
! * incompatibilities between options, and which is used in
! * \link CBM::Plan benchmark plans\endlink.
*
* Basically, operating system object is detected at CompBenchmarks
|
