[Compbench-web-devel] compbenchmarks-web/cgi-bin doc.cgi, 1.28, 1.29
Brought to you by:
xfred
Menu
▾
▴
[Compbench-web-devel] compbenchmarks-web/cgi-bin doc.cgi, 1.28, 1.29
|
From: Frederic T. <xf...@us...> - 2006-11-28 21:50:32
|
Update of /cvsroot/compbench/compbenchmarks-web/cgi-bin In directory sc8-pr-cvs4.sourceforge.net:/tmp/cvs-serv25363 Modified Files: doc.cgi Log Message: Topics' usage. Rewritted package's documentation. Index: doc.cgi =================================================================== RCS file: /cvsroot/compbench/compbenchmarks-web/cgi-bin/doc.cgi,v retrieving revision 1.28 retrieving revision 1.29 diff -C2 -d -r1.28 -r1.29 *** doc.cgi 28 Nov 2006 17:18:39 -0000 1.28 --- doc.cgi 28 Nov 2006 21:50:28 -0000 1.29 *************** *** 6,12 **** --- 6,15 ---- push(@INC, "../lib"); require "html.pl"; + require "topic.pl"; + our $dbh; our $req; our $tab; + our $topic; our $LT_GCC_BENCH_PACKAGE; *************** *** 91,95 **** my $comp2 = "<a href='http://www.research.att.com/~orost/bench_plus_plus.html'>Bench++</a>"; ! html_init('doc'); $req->delete_all(); --- 94,106 ---- my $comp2 = "<a href='http://www.research.att.com/~orost/bench_plus_plus.html'>Bench++</a>"; ! html_init('doc', undef, ! { 'package' => [ ! { 'arch' => 'Architecture', ! 'start' => 'Installation', ! 'perl-ui' => 'Dialog-based UI', ! 'advanced' => 'Advanced usage' }, ! [ 'arch', 'start', 'perl-ui', 'advanced' ] ] ! }); ! $req->delete_all(); *************** *** 116,128 **** print "</td></tr></table>"; } elsif ($tab eq 'package') { ! print "<h2>Presentation</h2> ! <p> ! A simple benchmarks' suite, the <i>compbenchmarks</i> package, has been developped to integrate some of the <a href='/cgi-bin/doc.cgi?tab=benchs'>well-known benchmarks and applications</a>, providing a simple interface to <a href='#usage-download'>download</a>, <a href='#usage-compile'>compile</a> and <a href='#usage-eval'>evaluate</a> generated binaries more conveniently, according to customizable parameters. ! </p> ! <p>Results use a common format that can be easily interpreted by third party applications. Results can be imported in the <a href='http://www.mysql.org'>MySQL</a> database underlaying this website. ! </p>"; ! html_tip("For a more detailled information concerning technical aspects and implementation, see <a href='http://sourceforge.net/project/showfiles.php?group_id=150828&package_id=204979'>SourceForge project's documentation download page</a>."); ! print "<h2>Requierements</h2> <ul> <li>A C++ Compiler or/and a C compiler (like g++ and gcc from <a href='http://gcc.gnu.org'>GCC</a>), make</li> --- 127,157 ---- print "</td></tr></table>"; } elsif ($tab eq 'package') { ! if ($topic eq 'arch') { ! print "<p><i>compbenchmarks</i> package proposes a framework to handle ! <a href='/cgi-bin/doc.cgi?tab=benchs'>some well-known benchmarks and applications</a>. It provides a single interface to :</p> ! <ul> ! <li><a href='/cgi-bin/doc.cgi?tab=package&topic=start#usage-download!!!'>download packages and benchmarks</a></li> ! <li><a href='/cgi-bin/doc.cgi?tab=package&topic=start#usage-compile!!!'>configure and compile</a> them (with arbitrary C/C++ compilers and optimisation options)</li> ! <li><a href='/cgi-bin/doc.cgi?tab=package&topic=start#usage-eval!!!'>evaluate them</a>, and store results in a common format. Results can also be imported in <a href='/cgi-bin/browse.cgi'>official database</a>.</li> ! </ul>"; ! print "<h3>Architecture</h3> ! <table cellpadding='5'><tr><td valign='top'> ! <img src='$LT_WEB_ICONS/compbenchmarks-arch.png' alt='Architecture overview'> ! </td><p><td valign='top'><i>compbenchmarks</i> is splited in three functionnal blocks (since 0.3.3) : normal users should start take a look at <a href='#arch-ui'>high-level user interfaces</a>. For more in-depth management, the <a href='#arch-core'>compbenchmark-core</a> program is adviced. Finaly, the libcompbenchmarks shared library and related API can be used to implement new benchmark/package support.</p> ! <p>Each supported benchmark is handled through a specific, independant, shared library.</p> ! </td></tr></table>"; ! print "<a name='arch-ui'><h3>High-level user interfaces</h3></a> ! <p>At this time only <a href='/cgi-bin/doc.cgi?tab=package&topic=perl-ui'>compbenchmarks-ui-perl</a>, which uses dialog (ncurses) is working. It can be used to do classic operations, such as configuring, managing, and runing benchmarks.</p>"; ! print "<a name='arch-core'><h3>compbenchmarks-core program</h3></a> ! <p>This binary program supports all actions providen by the underlaying library. It may be needed for <a href='/cgi-bin/doc.cgi?tab=package&topic=usage'>advanced usages</a> (e.g. for writting a wrapper to evaluate benchmarks in a specific maner, not handled by user interfaces)</p>"; ! print "<a name='arch-lib'><h3>libcompbenchmarks</h3></a> ! <p>This is the underlaying library for the <i>compbenchmarks</i> package. It holds generic methods to download packages, basic frameworks to install and configure them, etc. If you are interested in how to use it in your own program or if you want to make a new benchmark/package supported, you'll need to use it.</p>"; ! html_tip("The <a href='http://sourceforge.net/project/showfiles.php?group_id=150828&package_id=204979'>technical documention</a> presents all concepts, as well as API."); ! ! } ! ! if ($topic eq 'start') { ! print "<h3>Requierements</h3> <ul> <li>A C++ Compiler or/and a C compiler (like g++ and gcc from <a href='http://gcc.gnu.org'>GCC</a>), make</li> *************** *** 132,140 **** <p>For now, CompilerBenchmarks' suite just supports tcc, gcc and g++ compilers on Linux and Cygwin. Any help improving that is welcome. It has only been tested on i686 and compatible systems. </p> ! <h2>Download</h2> <p> See project's <a href='http://sourceforge.net/project/showfiles.php?group_id=150828'>download area</a> on <a href='http://sourceforge.net'>SourceForge</a>. </p> ! <h2>Installation</h2> <p> compbenchmarks is providen as a GNU gzipped-tarball package. Traditionnal installation process is used : --- 161,169 ---- <p>For now, CompilerBenchmarks' suite just supports tcc, gcc and g++ compilers on Linux and Cygwin. Any help improving that is welcome. It has only been tested on i686 and compatible systems. </p> ! <h3>Download</h3> <p> See project's <a href='http://sourceforge.net/project/showfiles.php?group_id=150828'>download area</a> on <a href='http://sourceforge.net'>SourceForge</a>. </p> ! <h3>Installation</h3> <p> compbenchmarks is providen as a GNU gzipped-tarball package. Traditionnal installation process is used : *************** *** 146,155 **** <li>make</li> </ul> ! <p>Optionnaly, you may want to install it on your system to make it accessible to all users :</p> <ul> <li>make install</li> ! </ul> ! <a name='usage'></a><h2>Usage</h2> ! <p>For a quick start, you may run :</p> <ul> <li>./compbenchmarks-ui-perl , it'll detect your C compilers and create basic configurations files</li> --- 175,188 ---- <li>make</li> </ul> ! <p>Optionaly, you may want to install it on your system to make it accessible to all users :</p> <ul> <li>make install</li> ! </ul>"; ! } ! ! if ($topic eq 'perl-ui') { ! print "<p>compbenchmarks-ui-perl is a front-end to <i>compbenchmarks</i>. It is written in perl and uses dialog. Most of typical operations can be done with it.</p>"; ! print "<h3>Configuration</h3>"; ! print "<p>For a quick start, you may run :</p> <ul> <li>./compbenchmarks-ui-perl , it'll detect your C compilers and create basic configurations files</li> *************** *** 157,161 **** <li>In ~/.compbenchmarks/Configuration, take a look at default-C-compilers and default-C-compilers-options</li> </ul> ! <a name='usage-download'></a><h3>Package installation</h3> <p> Run ./compbenchmarks-ui-perl and choose 'Manage package'. Select supported packages/benchmarks you want to install, and choose 'OK' : --- 190,195 ---- <li>In ~/.compbenchmarks/Configuration, take a look at default-C-compilers and default-C-compilers-options</li> </ul> ! <p>Following shows a typical step-by-step usage.</p> ! <a name='usage-download'></a><h3>Packages' installation</h3> <p> Run ./compbenchmarks-ui-perl and choose 'Manage package'. Select supported packages/benchmarks you want to install, and choose 'OK' : *************** *** 210,213 **** --- 244,271 ---- "; } + if ($topic eq 'advanced') { + print "<p>When embedded <i>compbenchmarks</i>' <a href='/cgi-bin/doc.cgi?tab=package&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&topic=perl-ui#usage-download'>download/install menu</a> of <a href='/cgi-bin/doc.cgi?tab=package&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> + </p> + <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 reading</h3> + <code> + \$ man compbenchmarks-core # :p + </code>"; + } + } html_end(); |
