[Compbench-devel] CompBenchmarks++ main.h,1.10,1.11

[Frederic T. <xf...@us...>]

Update of /cvsroot/compbench/CompBenchmarks++
In directory sc8-pr-cvs4.sourceforge.net:/tmp/cvs-serv19680

Modified Files:
	main.h 
Log Message:
Updated documentation.

Index: main.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/main.h,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -d -r1.10 -r1.11
*** main.h	1 May 2007 14:39:29 -0000	1.10
--- main.h	1 May 2007 19:43:42 -0000	1.11
***************
*** 16,20 ****
   * 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.
   *
--- 16,20 ----
   * 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 software using different compilers
   * and options on a variety of architectures.
   *
***************
*** 23,27 ****
   * 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.
   *
--- 23,27 ----
   * 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 interracts with
   * libcompbenchmarks.
   *
***************
*** 41,74 ****
   * - \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
!  * compilation time and instancied at run time to get others parts working.
!  * Only one user interface, compbenchmarks-ui-perl as been coded for actual
!  * needs, and it uses the compbenchmarks-core program.
!  * Many benchmarks have been derivated from base benchmark and package classes.
!  *
!  * \section behaviour Behaviour
!  *
!  * Compiled on Linux, program'll use a CBMSystemLinux instance. It can install
!  * defined packages (like \link CBMBenchmarkGZIP gzip\endlink or \link
!  * CBMBenchmarkBENCHPP Bench++\endlink) via Internet and uses some benchmarks on them.
!  * Benchmarks can also be hard-coded in CompBenchmarks (as, for gzip : \link CBMBenchmarkGZIP1 gzip-1c\endlink) or directly providen by packages (like \link CBMBenchmarkBENCHPP_WHETSTONE benchpp-whetstone\endlink).
!  *
!  * External benchmark's packages are supported through independant shared
!  * libraries that use libcompbenchmarks'.
!  *
!  * To start a new benchmark or package implementation, you can
!  * - download the sources (http://compbench.sourceforge.net),
!  * - take a quick look at \link CBMBenchmark CBMBenchmark\endlink class.
!  * - for, said, Foo_benchpack.tar.gz package, create the Benchmark-FOO-BENCHPACK.cpp and corresponding header files in Benchmark directory,
!  * - update Makefile.am and benchmarks.list files in the Benchmark directory,
!  * - Look at Benchmark-SCIMARK2.cpp or Benchmark-BZIP2.cpp, which are good models.
   *
!  * You can also get in touch with me, see http://compbench.sf.net/cgi-bin/feedback.cgi .
   *
   */
--- 41,56 ----
   * - \link CBM::UI user interface\endlink. Higher-level core abstractions for UI.
   *
   * 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.
   *
!  * \section behaviour Hacking ?
   *
!  * Here are few entry points, mainly for contributors :
!  * - \ref howto_kb "XML knowledge base",
!  * - \ref new_compiler_support "Supporting a new compiler",
!  * - \ref improve_compiler_support "Improving or fixing logic for a supported compiler",
!  * - \ref howto_new_package_support "Adding a new package",
!  * - \ref howto_new_benchmark_support "Adding a new benchmark".
   *
   */