From patchwork Fri Jun 24 15:00:47 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: alexandros.frantzis@linaro.org X-Patchwork-Id: 2301 Return-Path: X-Original-To: patchwork@peony.canonical.com Delivered-To: patchwork@peony.canonical.com Received: from fiordland.canonical.com (fiordland.canonical.com [91.189.94.145]) by peony.canonical.com (Postfix) with ESMTP id 7D06723F42 for ; Fri, 24 Jun 2011 15:00:51 +0000 (UTC) Received: from mail-qw0-f52.google.com (mail-qw0-f52.google.com [209.85.216.52]) by fiordland.canonical.com (Postfix) with ESMTP id 342E0A18038 for ; Fri, 24 Jun 2011 15:00:51 +0000 (UTC) Received: by qwb8 with SMTP id 8so2122278qwb.11 for ; Fri, 24 Jun 2011 08:00:50 -0700 (PDT) Received: by 10.229.40.139 with SMTP id k11mr2593299qce.135.1308927650651; Fri, 24 Jun 2011 08:00:50 -0700 (PDT) X-Forwarded-To: linaro-patchwork@canonical.com X-Forwarded-For: patch@linaro.org linaro-patchwork@canonical.com Delivered-To: patches@linaro.org Received: by 10.229.230.139 with SMTP id jm11cs50840qcb; Fri, 24 Jun 2011 08:00:50 -0700 (PDT) Received: by 10.227.198.130 with SMTP id eo2mr3169062wbb.50.1308927648445; Fri, 24 Jun 2011 08:00:48 -0700 (PDT) Received: from adelie.canonical.com (adelie.canonical.com [91.189.90.139]) by mx.google.com with ESMTP id fm12si3757012wbb.13.2011.06.24.08.00.48; Fri, 24 Jun 2011 08:00:48 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of bounces@canonical.com designates 91.189.90.139 as permitted sender) client-ip=91.189.90.139; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of bounces@canonical.com designates 91.189.90.139 as permitted sender) smtp.mail=bounces@canonical.com Received: from loganberry.canonical.com ([91.189.90.37]) by adelie.canonical.com with esmtp (Exim 4.71 #1 (Debian)) id 1Qa7sF-0005lC-RJ for ; Fri, 24 Jun 2011 15:00:47 +0000 Received: from loganberry.canonical.com (localhost [127.0.0.1]) by loganberry.canonical.com (Postfix) with ESMTP id CB10D2E808B for ; Fri, 24 Jun 2011 15:00:47 +0000 (UTC) MIME-Version: 1.0 X-Launchpad-Project: glcompbench X-Launchpad-Branch: ~glcompbench-dev/glcompbench/trunk X-Launchpad-Message-Rationale: Subscriber X-Launchpad-Branch-Revision-Number: 39 X-Launchpad-Notification-Type: branch-revision To: Linaro Patch Tracker From: noreply@launchpad.net Subject: [Branch ~glcompbench-dev/glcompbench/trunk] Rev 39: Add man pages for glcompbench variants and gl-composite-benchmark. Message-Id: <20110624150047.26723.93152.launchpad@loganberry.canonical.com> Date: Fri, 24 Jun 2011 15:00:47 -0000 Reply-To: noreply@launchpad.net Sender: bounces@canonical.com Errors-To: bounces@canonical.com Precedence: bulk X-Generated-By: Launchpad (canonical.com); Revision="13265"; Instance="initZopeless config overlay" X-Launchpad-Hash: 0f7cda1f51b0694b3f0f68c8a7a92d1adad71490 ------------------------------------------------------------ revno: 39 committer: Alexandros Frantzis branch nick: trunk timestamp: Fri 2011-06-24 17:56:59 +0300 message: Add man pages for glcompbench variants and gl-composite-benchmark. added: doc/ doc/gl-composite-benchmark.1.in doc/glcompbench.1.in doc/wscript_build modified: wscript --- lp:glcompbench https://code.launchpad.net/~glcompbench-dev/glcompbench/trunk You are subscribed to branch lp:glcompbench. To unsubscribe from this branch go to https://code.launchpad.net/~glcompbench-dev/glcompbench/trunk/+edit-subscription === added directory 'doc' === added file 'doc/gl-composite-benchmark.1.in' --- doc/gl-composite-benchmark.1.in 1970-01-01 00:00:00 +0000 +++ doc/gl-composite-benchmark.1.in 2011-06-24 14:56:59 +0000 @@ -0,0 +1,21 @@ +.TH GL-COMPOSITE-BENCHMARK "1" "June 2011" "gl-composite-benchmark @appversion@" +.SH NAME +.SH SYNOPSIS +.B gl-composite-benchmark [OPTIONS] [-- [GLCOMPBENCH_OPTIONS]] +.SH DESCRIPTION +gl-composite-benchmark is a program to assist with running benchmarks using glcompbench. +.SH OPTIONS +.TP +\fB\-n\fR NWINDOWS +the number of windows to use [default: 4] +.TP +\fB\-d\fR DELAY +the delay between window updates in seconds [default: 0.25] +.HP +\fB\-e\fR EXECUTABLE the glcompbench executable to use +.TP +\fB\-h\fR +display help message + +.SH AUTHOR +gl-composite-benchmark was written by Alexandros Frantzis. === added file 'doc/glcompbench.1.in' --- doc/glcompbench.1.in 1970-01-01 00:00:00 +0000 +++ doc/glcompbench.1.in 2011-06-24 14:56:59 +0000 @@ -0,0 +1,106 @@ +.TH @APPNAME@ "1" "June 2011" "@appname@ @appversion@" +.SH NAME +@appname@ \- OpenGL (ES) 2.0 compositing benchmark +.SH SYNOPSIS +.B @appname@ [options] +.SH DESCRIPTION +\fB@appname@\fP is a benchmark for compositing windows using OpenGL (ES) 2.0. +.SH OPTIONS +.TP +\fB\-i\fR, \fB\-\-ids\fR IDs +A comma separated list of window ids to track +(base 10 or 16) +.TP +\fB\-s\fR, \fB\-\-size\fR SIZE +The size of each side of the main window in pixels +[default: 512] +.TP +\fB\-\-no\-accel\-tfp\fR +Don't use accelerated TFP (use glTexImage2D) +.TP +\fB\-b\fR, \fB\-\-benchmark\fR BENCH +A benchmark to run: 'test(:opt1=val1)*' +(the option can be used multiple times) +.TP +\fB\-\-no\-draw\fR +Process the windows but don't draw anything on screen +.TP +\fB\-\-idle\-redraw\fR +Redraw when idle, even when nothing has changed +.HP +\fB\-\-force\-tex\-update\fR Force texture updates even when they are unchanged +.TP +\fB\-\-manual\-redirect\fR +Perform a manual redirect when using XComposite +.TP +\fB\-\-run\-forever\fR +Run indefinitely, looping from the last test back to the first +.TP +\fB\-l\fR, \fB\-\-list\-tests\fR +List the avalaible tests and their options +.TP +\fB\-\-no\-swap\-buffers\fR +Don't update the screen by swapping the front and +back buffer, use glFinish() instead +.TP +\fB\-d\fR, \fB\-\-debug\fR +Display debug messages +.TP +\fB\-h\fR, \fB\-\-help\fR +Display help + +.SH BENCHMARKS +@appname@ offers a suite of tests that composite windows in different ways, +often trying to emulate the behavior of existing compositor. The way in which +each test is rendered is configurable through a set of options. To get the +available tests and their acceptable options you can use the \fB\-l\fR, +\fB\-\-list\-tests\fR command line option. + +In @appname@, a benchmark is defined as a test plus a set of option values. +You can specify the list and order of the benchmarks to run by using the +\fB\-b\fR, \fB\-\-benchmark\fR command line option (possibly multiple times). +If no benchmarks are specified, a default set of benchmarks is used. If a +benchmark option is not specified it assumes its default value (listed with +\fB\-l\fR, \fB\-\-list\-test\fR). + +As a special case, a benchmark description string is allowed to not contain a +test name (i.e. to start with ':'). In this case, any specified option values +are used as the default values for benchmarks following this description +string. + +.SH EXAMPLES +To run the default benchmarks using all the visible windows: +.PP +.RS +\fB@appname@\fR +.RE +.PP +To run the default benchmarks using a specific set of windows: +.PP +.RS +\fB@appname@ --ids 0x89cdaf,3398289,0xfffefd\fR +.RE +.PP +To run a benchmark using test 'default' with a 'duration' of '5.0' seconds per +iteration and 5 iterations: +.PP +.RS +\fB@appname@ -b default:duration=5.0:iterations=5\fR +.RE +.PP +To run a series of benchmarks use the \fB\-b\fR, \fB\-\-benchmark\fR command +line option multiple times: +.PP +.RS +\fB@appname@ -b default:duration=5.0 -b brick:use-vbo=false -b default\fR +.RE +.PP +To set default option values for benchmarks: +.PP +.RS +\fB@appname@ -b :duration=2.0 -b default -b brick -b :duration=5.0 -b default\fR +.RE +.PP + +.SH AUTHOR +@appname@ was written by Alexandros Frantzis and Jesse Barker. === added file 'doc/wscript_build' --- doc/wscript_build 1970-01-01 00:00:00 +0000 +++ doc/wscript_build 2011-06-24 14:56:59 +0000 @@ -0,0 +1,40 @@ +if bld.env.BUILD_GLX: + bld( + features = 'subst', + source = 'glcompbench.1.in', + target = bld.path.find_or_declare('glcompbench-glx.1'), + install_path = '${PREFIX}/share/man/man1', + APPNAME = 'GLCOMPBENCH-GLX', + appname = 'glcompbench-glx', + appversion = bld.env.GLCOMPBENCH_VERSION + ) + +if bld.env.BUILD_EGL_GL: + bld( + features = 'subst', + source = 'glcompbench.1.in', + target = bld.path.find_or_declare('glcompbench-egl-gl.1'), + install_path = '${PREFIX}/share/man/man1', + APPNAME = 'GLCOMPBENCH-EGL-GL', + appname = 'glcompbench-egl-gl', + appversion = bld.env.GLCOMPBENCH_VERSION + ) + +if bld.env.BUILD_EGL_ES2: + bld( + features = 'subst', + source = 'glcompbench.1.in', + target = bld.path.find_or_declare('glcompbench-egl-es2.1'), + install_path = '${PREFIX}/share/man/man1', + APPNAME = 'GLCOMPBENCH-EGL-ES2', + appname = 'glcompbench-egl-es2', + appversion = bld.env.GLCOMPBENCH_VERSION + ) + +bld( + features = 'subst', + source = 'gl-composite-benchmark.1.in', + target = bld.path.find_or_declare('gl-composite-benchmark.1'), + install_path = '${PREFIX}/share/man/man1', + appversion = bld.env.GLCOMPBENCH_VERSION +) === modified file 'wscript' --- wscript 2011-04-28 08:43:59 +0000 +++ wscript 2011-06-24 14:56:59 +0000 @@ -89,6 +89,7 @@ ctx.env.append_unique('GLCOMPBENCH_DATA_PATH', Options.options.data_path) ctx.env.append_unique('DEFINES', 'GLCOMPBENCH_DATA_PATH="%s"' % Options.options.data_path) ctx.env.append_unique('DEFINES', 'GLCOMPBENCH_VERSION="%s"' % VERSION) + ctx.env.GLCOMPBENCH_VERSION = VERSION ctx.msg("Prefix", ctx.env.PREFIX, color='PINK') ctx.msg("Data path", Options.options.data_path, color='PINK') @@ -97,6 +98,7 @@ def build(ctx): ctx.recurse('src') ctx.recurse('data') + ctx.recurse('doc') def dist(ctx): ctx.algo = 'tar.gz'