[Compbench-devel] CompBenchmarks++ howto_new_benchmark_support.h, NONE, 1.1 howto_new_package_support.h, NONE, 1.1

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

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

Added Files:
	howto_new_benchmark_support.h howto_new_package_support.h 
Log Message:
First import.

--- NEW FILE: howto_new_package_support.h ---
/* ----------------------------------------------------------------------------
   $Id: howto_new_package_support.h,v 1.1 2007/05/01 19:37:15 xfred Exp $

   This is free software.
   For details, see the GNU Public License in the COPYING file, or
   Look http://www.fsf.org
   ------------------------------------------------------------------------- */

#ifndef H_CBMHOWTO_NEW_PACKAGE_SUPPORT
#define H_CBMHOWTO_NEW_PACKAGE_SUPPORT

/*! \page howto_new_package_support Supporting a new package
 *
 * \section howto_new_package_support_introduction Introduction
 *
 * Here's the methodology to make a package supported by CompBenchmarks;
 * CompBenchmarks has to know how to download, check, extract, configure and
 * make it.
 *
 * As a reminder, a package in CompBenchmarks is a file (e.g. archive) that
 * provide a source for a given version of a software. This software can be
 * either dedicated to benchmarking, or is just used as a real-word application
 * to get some performance indicators.
 *
 * \section howto_new_package_support_core C++ core
 *
 * You should build a couple of files in source root; if your package's
 * name is Foo, you'll have to create
 * ./SupportedBenchmarks/Benchmark-FOO.cpp and Benchmark-FOO.h.
 *
 * If package is Foo::Test or if its hold others extra characters,
 * they should be replaced by underscore. Note that the minus sign may have
 * a special meaning, so it should be avoided in package's name.
 *
 *
 * Remember to update ./SupportedBenchmarks/Makefile.am.
 *
 * Take a look at ./SupportedBenchmarks/Benchmark-BENCHPP.* files for an
 * example. See CBM::Package for more information.
 *
 * \section howto_new_package_support_ref Referencing
 *
 * SupportedBenchmarks/benchmarks.list must be updated, once you've defined
 * \ref howto_new_benchmark_support "supported benchmarks" for your package.
 *
 * \section howto_new_package_support_ts Testsuite
 *
 * In source directory, please take a look at ./CBM-PI/t/02-CBMSystem-benchs.pl
 * file. Normaly updating SupportedBenchmarks/benchmarks.list is suffiscient,
 * and should not require changes yet.
 *
 */

#endif

--- NEW FILE: howto_new_benchmark_support.h ---
/* ----------------------------------------------------------------------------
   $Id: howto_new_benchmark_support.h,v 1.1 2007/05/01 19:37:15 xfred Exp $

   This is free software.
   For details, see the GNU Public License in the COPYING file, or
   Look http://www.fsf.org
   ------------------------------------------------------------------------- */

#ifndef H_CBMHOWTO_NEW_BENCHMARK_SUPPORT
#define H_CBMHOWTO_NEW_BENCHMARK_SUPPORT

/*! \page howto_new_benchmark_support Supporting a new benchmark
 *
 * \section howto_new_benchmark_support_introduction Introduction
 *
 * Here's the methodology to make a benchmark supported by CompBenchmarks,
 * which have to know how to prepare, run, and get its performance indicator.
 *
 * Each benchmark is associated to a \ref howto_new_package_support "package".
 *
 * \section howto_new_benchmark_support_core C++ core
 *
 * You should build a couple of files in source root; if your package's
 * name is Foo, you'll have to create
 * ./SupportedBenchmarks/Benchmark-FOO.cpp and Benchmark-FOO.h.
 *
 * If package is Foo::Test or if its hold others extra characters,
 * they should be replaced by underscore. Note that the minus sign may have
 * a special meaning, so it should be avoided in package's name.
 *
 *
 * Remember to update ./SupportedBenchmarks/Makefile.am.
 *
 * Take a look at ./SupportedBenchmarks/Benchmark-BENCHPP.* files for an
 * example. See CBM::Benchmark for more information.
 *
 * \section howto_new_benchmark_support_ref Referencing
 *
 * SupportedBenchmarks/benchmarks.list must be updated. Each line of this file
 * holds same colon-separated elements defining a benchmark, in order :
 * - Internal benchmark name which a string consisting of internal package
 *   identifier and benchmark identifier, separated by minus. Internal package
 *   name is given by CBM::Package::Name().
 * - Package filename without any extension or 'Benchmark-' prefix,
 * - Corresponding benchmark's class postfix.
 *
 * \section howto_new_benchmark_support_ts Testsuite
 *
 * In source directory, please take a look at ./CBM-PI/t/02-CBMSystem-benchs.pl
 * file. Normaly updating SupportedBenchmarks/benchmarks.list is suffiscient,
 * and should not require changes yet.
 *
 */

#endif