[Compbench-web-devel] compbenchmarks-web/cgi-bin doc.cgi, 1.35, 1.36
Brought to you by:
xfred
Menu
▾
▴
[Compbench-web-devel] compbenchmarks-web/cgi-bin doc.cgi, 1.35, 1.36
|
From: Frederic T. <xf...@us...> - 2007-09-09 18:17:33
|
Update of /cvsroot/compbench/compbenchmarks-web/cgi-bin In directory sc8-pr-cvs4.sourceforge.net:/tmp/cvs-serv20113 Modified Files: doc.cgi Log Message: For SF's TID #141819 : improving documentation. C++ Documentaiton can be browsed on-line. Index: doc.cgi =================================================================== RCS file: /cvsroot/compbench/compbenchmarks-web/cgi-bin/doc.cgi,v retrieving revision 1.35 retrieving revision 1.36 diff -C2 -d -r1.35 -r1.36 *** doc.cgi 12 Dec 2006 18:35:56 -0000 1.35 --- doc.cgi 9 Sep 2007 18:17:30 -0000 1.36 *************** *** 16,23 **** our $LT_GCC_BENCH_PACKAGE_BENCH; our $LT_WEB_ICONS; ! our $CVS_DATE = '$Date$'; my @benchmarks_list; sub show_benchmarks { --- 16,70 ---- our $LT_GCC_BENCH_PACKAGE_BENCH; our $LT_WEB_ICONS; ! our $LT_TMP_DIR; our $CVS_DATE = '$Date$'; my @benchmarks_list; + my $target; + my $version; + + my $cid; + my $ver; + + sub showdoxydoc { + my $html_prefix = "$LT_TMP_DIR/doc/$version"; + my $file; + + if (!defined($version)) { + print "<p>C++ API documentation for libcompbenchmarks is available for the following versions (includes main concept descriptions) :</p><ul>"; + my @V = `cd $LT_TMP_DIR/doc && ls -1`; + chomp(@V); + foreach(@V) { + if (-d "$LT_TMP_DIR/doc/$_") { + print "<li><a href='/cgi-bin/doc.cgi?tab=core&version=$_'>$_</a></li>"; + } + } + print "</ul>"; + html_tip("You may want to get this document(s) for off-line usage; look at the <a href='/cgi-bin/downloads.cgi'>download page</a>."); + return; + } + + if ($target =~ /(.*?)#.*/) { + $target=$1; + } + + $file = "$html_prefix/$target"; + my $str = `cat $file`; + print "$str"; + } + + sub showcompilersdoc { + my $html_prefix = "$LT_TMP_DIR/doc/compbenchmarks-maint-compilers"; + my $file; + + if ((!defined($cid)) || + (!defined($ver))) { + $file = "$html_prefix-summary.html"; + } else { + $file = "$html_prefix-zoom-$cid-$ver.html"; + } + + my $r = `cat $file`; + print "$r"; + } sub show_benchmarks { *************** *** 133,136 **** --- 180,201 ---- }); + if (!defined($req->param("target"))) { + $target="index.html"; + } else { + $target=$req->param("target"); + } + + if (defined($req->param("version"))) { + $version=$req->param("version"); + } + + if (defined($req->param("cid"))) { + $cid=$req->param("cid"); + } + + if (defined($req->param("ver"))) { + $ver=$req->param("ver"); + } + $req->delete_all(); *************** *** 159,163 **** 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=perl-ui#usage-download'>download packages and benchmarks</a></li> --- 224,228 ---- 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 core functionnalities to :</p> <ul> <li><a href='/cgi-bin/doc.cgi?tab=package&topic=perl-ui#usage-download'>download packages and benchmarks</a></li> *************** *** 168,178 **** <table cellpadding='5' summary='description'><tr><td valign='top'> <img src='$LT_WEB_ICONS/compbenchmarks-arch.png' alt='Architecture overview'> ! </td><td valign='top'><p><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 <a href='#arch-lib'>libcompbenchmarks</a> 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'></a><h3>High-level user interfaces</h3> ! <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'></a><h3>compbenchmarks-core program</h3> ! <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 providen user interfaces)</p>"; print "<a name='arch-lib'></a><h3>libcompbenchmarks</h3> <p>This is the underlaying library for the <i>compbenchmarks</i> package. It holds generic methods to download packages, basic framework to install, optionally patch 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>"; --- 233,243 ---- <table cellpadding='5' summary='description'><tr><td valign='top'> <img src='$LT_WEB_ICONS/compbenchmarks-arch.png' alt='Architecture overview'> ! </td><td valign='top'><p><i>compbenchmarks</i> is splited in two functionnal blocks : normal users should start take a look at <a href='#arch-ui'>high-level user interfaces</a>. For more in-depth management, or if you don't have installed more user friendly applications, the <a href='#arch-core'>compbenchmark-core</a> and <a href='#arch-plan'>compbenchmark-plan</a> program are available. Finaly, the <a href='#arch-lib'>libcompbenchmarks</a> shared library and related API can be used to implement new benchmark/package support or develop your own C++/Perl wrappers (at this time).</p> ! <p>Each supported benchmark or compiler is handled through a specific, independant, shared library.</p> </td></tr></table>"; print "<a name='arch-ui'></a><h3>High-level user interfaces</h3> ! <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 actions allowed by the underlaying library that. 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 providen user interfaces)</p>"; print "<a name='arch-lib'></a><h3>libcompbenchmarks</h3> <p>This is the underlaying library for the <i>compbenchmarks</i> package. It holds generic methods to download packages, basic framework to install, optionally patch 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>"; *************** *** 187,191 **** <li>A C++ Compiler or/and a C compiler (like g++ and gcc from <a href='http://gcc.gnu.org'>GCC</a>), make</li> <li><a href='http://www.perl.org'>Perl 5</a> or above</li> ! <li>wget, dialog, and few UNIX commands (tar, gzip, unzip, zcat, grep, head, mkdir, patch, rm, tail and cat)</li> </ul> <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. --- 252,256 ---- <li>A C++ Compiler or/and a C compiler (like g++ and gcc from <a href='http://gcc.gnu.org'>GCC</a>), make</li> <li><a href='http://www.perl.org'>Perl 5</a> or above</li> ! <li>wget and few UNIX commands (tar, gzip, unzip, zcat, grep, head, mkdir, patch, rm, tail and cat)</li> </ul> <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. *************** *** 206,209 **** --- 271,275 ---- <li>./configure</li> <li>make</li> + <li>make test # optional, yet recommanded</li> </ul> <p>Optionaly, you may want to install it on your system to make it accessible to all users :</p> *************** *** 299,302 **** --- 365,372 ---- 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&package_id=204979'>technical documention</a>, which presents the API."); } + } elsif ($tab eq 'core') { + showdoxydoc(); + } elsif ($tab eq 'compilers') { + showcompilersdoc(); } |
