[Compbench-devel] CompBenchmarks++ main.h,1.3,1.4

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

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

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

Index: main.h
===================================================================
RCS file: /cvsroot/compbench/CompBenchmarks++/main.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** main.h	23 Nov 2006 16:42:48 -0000	1.3
--- main.h	29 Nov 2006 22:01:02 -0000	1.4
***************
*** 31,46 ****
   * Basically, operating system object is detected at CompBenchmarks
   * compilation time and instancied at run time to get others parts working.
!  * Only one user interface as been coded for actual need, it allows the C++
!  * core to interact with compbenchmarks-config. Many benchmarks have been
!  * derivated from base benchmark object; each benchmark can use compilers and
!  * options instances (e.g. through the operating system object).
   *
!  * \section Example
   *
   * 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 (\link CBMBenchmarkBENCHPP_WHETSTONE benchpp-whetstone\endlink).
   *
   */
  
--- 31,60 ----
   * 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 object;
!  * each benchmark can use compilers and options instances (e.g. through
!  * the operating system object).
   *
!  * \section 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 the libcompbenchmarks'.
+  *
+  * To start implementing the support
+  * of a new package, you should :
+  * - download the sources (http://compbench.sf.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 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 .
+  *
+  * \section
   */