[Compbench-web-devel] compbenchmarks-web/cgi-bin doc.cgi, 1.38, 1.39

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

Update of /cvsroot/compbench/compbenchmarks-web/cgi-bin
In directory sc8-pr-cvs4.sourceforge.net:/tmp/cvs-serv19923

Modified Files:
	doc.cgi 
Log Message:
For SF's TID #141819 : compbenchmarks-plan documentation added.

Index: doc.cgi
===================================================================
RCS file: /cvsroot/compbench/compbenchmarks-web/cgi-bin/doc.cgi,v
retrieving revision 1.38
retrieving revision 1.39
diff -C2 -d -r1.38 -r1.39
*** doc.cgi	9 Sep 2007 20:37:18 -0000	1.38
--- doc.cgi	9 Sep 2007 20:57:14 -0000	1.39
***************
*** 185,191 ****
  			    'start' => 'Installation',
  			    'cbm-core' => 'compbenchmarks-core',
! 			    'perl-ui' => 'UI::Perl',
! 			    'advanced' => 'Advanced usage' },
! 			  [ 'arch', 'start', 'cbm-core', 'perl-ui', 'advanced' ] ],
  	    'benchs' => [ \%benchmarks_topics,
  			  \@benchmarks_list ]
--- 185,192 ----
  			    'start' => 'Installation',
  			    'cbm-core' => 'compbenchmarks-core',
! 			    'cbm-plan' => 'compbenchmarks-plan',
! 			    'perl-ui' => 'UI::Perl' },
! 			  [ 'arch', 'start', 'cbm-core', 'cbm-plan',
! 			    'perl-ui', 'advanced' ] ],
  	    'benchs' => [ \%benchmarks_topics,
  			  \@benchmarks_list ]
***************
*** 251,255 ****
  <p>No GUI is available at the moment; a Qt 4.x based interface is in active development.</p>";
  print "<a name='arch-core'></a><h3>compbenchmarks-core program</h3>
! <p>This binary program supports most of configuraiton related actions allowed by the underlaying library that. It may be needed for <a href='/cgi-bin/doc.cgi?tab=package&amp;topic=usage'>advanced usages</a> (e.g. for writting a custom wrapper to evaluate benchmarks in a specific maner, not handled by providen user interfaces).</p>";
  
  print "<a name='arch-plan'></a><h3>compbenchmarks-plan program</h3>
--- 252,256 ----
  <p>No GUI is available at the moment; a Qt 4.x based interface is in active development.</p>";
  print "<a name='arch-core'></a><h3>compbenchmarks-core program</h3>
! <p>This binary program <a href='/cgi-bin/doc.cgi?tab=package&amp;topic=cbm-core'>supports</a> most of configuraiton related actions allowed by the underlaying library that. It may be needed for advanced usages (e.g. for writting a custom wrapper to evaluate benchmarks in a specific maner, not handled by providen user interfaces).</p>";
  
  print "<a name='arch-plan'></a><h3>compbenchmarks-plan program</h3>
***************
*** 408,435 ****
  html_tip("For every benchmark, the higher is the result (<i>Value</i> field), the better is the effisciency.");
  }
! 
! if ($topic eq 'advanced') {
! print "<p>When embedded <i>compbenchmarks</i> <a href='/cgi-bin/doc.cgi?tab=package&amp;topic=arch#arch-ui'>user interfaces</a> are not suffiscient, the program <i>compbenchmarks-core</i> may be found useful.</p>
! <h3>Installing a package/benchmark from a local file</h3>
! <p>When a package is not accessible anymore on the Internet (e.g; through the <a href='/cgi-bin/doc.cgi?tab=package&amp;topic=perl-ui#usage-download'>install menu</a> of <a href='/cgi-bin/doc.cgi?tab=package&amp;topic=perl-ui'>compbenchmarks-ui-perl</a>), it can be fetched from a local file :</p>
! <code>
! \$ compbenchmarks-core --fetch benchpp-whetstone bench++.tar.gz
! </code>
! <h3>Running a benchmark</h3>
! <p>You can also configure and run an installed package directly, like this :
! </p>
! <code>
! \$ compbenchmarks-core --bench benchpp-whetstone /usr/local/bin/g++ '-O3 -Wall'
! </code>
! <p>Result will be the last line of stdout.</p>
! ";
! html_tip("For every benchmark, the higher is the result, the better is the effisciency.");
! print "<p>This simple command can be issued by a wrapper script of your choice to run specific benchmarks or for using a options/compilers attribution mechanism that differs from the one applied in user interfaces.</p>
! <h3>Further readings</h3>
! <code>
! \$ man compbenchmarks-core # :p
! </code>";
! html_tip("If you want to an in-depth interaction with <i>compbenchmarks</i>, you should look at the <a href='http://sourceforge.net/project/showfiles.php?group_id=150828&amp;package_id=204979'>technical documention</a>, which presents the API.");
  }
  } elsif ($tab eq 'core') {
    showdoxydoc();
--- 409,428 ----
  html_tip("For every benchmark, the higher is the result (<i>Value</i> field), the better is the effisciency.");
  }
! if ($topic eq 'cbm-plan') {
! print "<p>compbenchmarks-plan allows you to select bunchs of compilers, compilation options and benchmarks and evaluate the compilers or/and options relative performances.</p>
! <p>Such selections are called a plan. Well, as, basically, the terminology is the key here. I'll will try to expose some terms first.</p>
! <h3>Terminology</h3>
! <p>A plan consists of some plan specific parameters and of some objects called batchs. Each batch references a set of compilers, some benchmarks, and one or more option set. Option set is basically a list of options group. Each option group is a list of options.</p>
! <p>Each option group is a bunch of compiler options; batch'll take in care in option group individually, and apply all options of a given group at a time whereas option group will be used separatly.</p>";
! print "<h3>Definied a simple plan</h3>
! <p>Copy/paste each line individually in a console :</p>";
! showbindoc("compbenchmarks-plan-tut.raw");
! html_tip("If you're a bit curious about it, you can take a look to tut.xml file.<br>Notice that --plan-use repetition is not mandatory if --default-plan is specified in plan registration step.");
! print "<h3>Running benchmarks</h3>
! <p>You can try this :</p>";
! showbindoc("compbenchmarks-plan-tut-run.raw");
! html_tip("A benchmarking session (like above) can be stopped with Ctrl+C. Resuming is automatic.");
  }
+ 
  } elsif ($tab eq 'core') {
    showdoxydoc();