[DRE-commits] [ruby-prof] 10/14: changed readme to markdownformat, added source
Jonas Genannt
jonas at brachium-system.net
Thu Dec 19 19:42:24 UTC 2013
This is an automated email from the git hooks/post-receive script.
hggh-guest pushed a commit to branch master
in repository ruby-prof.
commit e5319042d8a781064516ba5cf1dd2ddb82b62597
Author: Jonas Genannt <jonas at brachium-system.net>
Date: Thu Dec 19 20:09:11 2013 +0100
changed readme to markdownformat, added source
---
debian/manpages/ruby-prof.1 | 151 +++++++++++++++++++++++++++++++++++++++
debian/manpages/ruby-prof.1.html | 147 +++++++++++++++++++++++++++++++++++++
debian/manpages/ruby-prof.1.ronn | 94 ++++++++++++++++++++++++
debian/ruby-prof.1 | 49 -------------
debian/ruby-prof.manpages | 2 +-
5 files changed, 393 insertions(+), 50 deletions(-)
diff --git a/debian/manpages/ruby-prof.1 b/debian/manpages/ruby-prof.1
new file mode 100644
index 0000000..a79048e
--- /dev/null
+++ b/debian/manpages/ruby-prof.1
@@ -0,0 +1,151 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "RUBY\-PROF" "1" "December 2013" "" ""
+.
+.SH "NAME"
+\fBruby\-prof\fR \- A fast ruby profiler
+.
+.SH "SYNOPSIS"
+\fBruby\-prof\fR \fIoptions\fR <script\.rb> [\-\-] [profiled\-script\-command\-line\-options]
+.
+.SH "DESCRIPTION"
+\fBruby\-prof\fR is a fast profiler for ruby\. It can be used as a stand\-alone program (that this man page documents) or as a ruby library\. Simply run the ruby program you want to profile using ruby\-prof : \fBruby\-prof script\.rb\fR At the end of execution the time spent in each method is displayed\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-p\fR, \fB\-\-printer=printer\fR
+Select a printer:
+.
+.br
+flat \- Prints a flat profile as text (default)\.
+.
+.br
+flat_with_line_numbers \- same as flat, with line numbers\.
+.
+.br
+graph \- Prints a graph profile as text\.
+.
+.br
+graph_html \- Prints a graph profile as html\.
+.
+.br
+call_tree \- format for KCacheGrind
+.
+.br
+call_stack \- prints a HTML visualization of the call tree
+.
+.br
+dot \- Prints a graph profile as a dot file
+.
+.br
+
+.
+.TP
+\fB\-m\fR, \fB\-\-min_percent=min_percent\fR
+The minimum percent a method must take before being included in output reports\. this option is not supported for call tree\.
+.
+.TP
+\fB\-f\fR, \fB\-\-file=path\fR
+Output results to a file instead of standard out\.
+.
+.TP
+\fB\-\-mode=measure_mode\fR
+Select what ruby\-prof should measure:
+.
+.br
+process \- Process time (default)\.
+.
+.br
+wall \- Wall time\.
+.
+.br
+cpu \- CPU time (Pentium and PowerPCs only)\.
+.
+.br
+allocations \- Object allocations (requires patched Ruby interpreter)\.
+.
+.br
+memory \- Allocated memory in KB (requires patched Ruby interpreter)\.
+.
+.br
+gc_runs \- Number of garbage collections (requires patched Ruby interpreter)\.
+.
+.br
+gc_time \- Time spent in garbage collection (requires patched Ruby interpreter)\.
+.
+.br
+
+.
+.TP
+\fB\-s\fR, \fB\-\-sort=sort_mode\fR
+Select how ruby\-prof results should be sorted:
+.
+.br
+total \- Total time
+.
+.br
+self \- Self time
+.
+.br
+wait \- Wait time
+.
+.br
+child \- Child time
+.
+.br
+
+.
+.TP
+\fB\-\-replace\-progname\fR
+Replace $0 when loading the \.rb files\.
+.
+.TP
+\fB\-v\fR
+Show version, set $VERBOSE to true, profile script if option given
+.
+.TP
+\fB\-d\fR
+Set $DEBUG to true
+.
+.TP
+\fB\-R\fR, \fB\-\-require\-noprof lib\fR
+require a specific library (not profiled)
+.
+.TP
+\fB\-E\fR, \fB\-\-eval\-noprof code\fR
+execute the ruby statements (not profiled)
+.
+.TP
+\fB\-x\fR, \fB\-\-exclude regexp\fR
+exclude methods by regexp (see method elimination)
+.
+.TP
+\fB\-X\fR, \fB\-\-exclude\-file file\fR
+exclude methods by regexp listed in file (see method elimination)
+.
+.TP
+\fB\-\-exclude\-common\-cycles\fR
+make common iterators like Integer#times appear inlined
+.
+.TP
+\fB\-\-exclude\-common\-callbacks\fR
+make common callbacks invocations like Integer#times appear inlined so you can see call origins in graph
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show help message
+.
+.TP
+\fB\-\-version\fR
+Show version 0\.13\.1
+.
+.SH "COPYRIGHT"
+ruby\-prof was written by Shugo Maeda \fIshugo at ruby\-lang\.org\fR\.
+.
+.P
+This manual page was written by Arnaud Cornet \fIarnaud\.cornet at gmail\.com\fR and updated by Jonas Genannt \fIjonas\.genannt at capi2name\.de\fR for the Debian project (but may be used by others)\.
+.
+.SH "SEE ALSO"
+The ruby\-prof website, https://github\.com/ruby\-prof/ruby\-prof
diff --git a/debian/manpages/ruby-prof.1.html b/debian/manpages/ruby-prof.1.html
new file mode 100644
index 0000000..83cc574
--- /dev/null
+++ b/debian/manpages/ruby-prof.1.html
@@ -0,0 +1,147 @@
+<!DOCTYPE html>
+<html>
+<head>
+ <meta http-equiv='content-type' value='text/html;charset=utf8'>
+ <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+ <title>ruby-prof(1) - A fast ruby profiler</title>
+ <style type='text/css' media='all'>
+ /* style: man */
+ body#manpage {margin:0}
+ .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+ .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+ .mp h2 {margin:10px 0 0 0}
+ .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+ .mp h3 {margin:0 0 0 4ex}
+ .mp dt {margin:0;clear:left}
+ .mp dt.flush {float:left;width:8ex}
+ .mp dd {margin:0 0 0 9ex}
+ .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+ .mp pre {margin-bottom:20px}
+ .mp pre+h2,.mp pre+h3 {margin-top:22px}
+ .mp h2+pre,.mp h3+pre {margin-top:5px}
+ .mp img {display:block;margin:auto}
+ .mp h1.man-title {display:none}
+ .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+ .mp h2 {font-size:16px;line-height:1.25}
+ .mp h1 {font-size:20px;line-height:2}
+ .mp {text-align:justify;background:#fff}
+ .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+ .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+ .mp u {text-decoration:underline}
+ .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+ .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+ .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+ .mp b.man-ref {font-weight:normal;color:#434241}
+ .mp pre {padding:0 4ex}
+ .mp pre code {font-weight:normal;color:#434241}
+ .mp h2+pre,h3+pre {padding-left:0}
+ ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+ ol.man-decor {width:100%}
+ ol.man-decor li.tl {text-align:left}
+ ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+ ol.man-decor li.tr {text-align:right;float:right}
+ </style>
+</head>
+<!--
+ The following styles are deprecated and will be removed at some point:
+ div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+ The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+ .man-navigation should be used instead.
+-->
+<body id='manpage'>
+ <div class='mp' id='man'>
+
+ <div class='man-navigation' style='display:none'>
+ <a href="#NAME">NAME</a>
+ <a href="#SYNOPSIS">SYNOPSIS</a>
+ <a href="#DESCRIPTION">DESCRIPTION</a>
+ <a href="#OPTIONS">OPTIONS</a>
+ <a href="#COPYRIGHT">COPYRIGHT</a>
+ <a href="#SEE-ALSO">SEE ALSO</a>
+ </div>
+
+ <ol class='man-decor man-head man head'>
+ <li class='tl'>ruby-prof(1)</li>
+ <li class='tc'></li>
+ <li class='tr'>ruby-prof(1)</li>
+ </ol>
+
+ <h2 id="NAME">NAME</h2>
+<p class="man-name">
+ <code>ruby-prof</code> - <span class="man-whatis">A fast ruby profiler</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>ruby-prof</code> <a href="#OPTIONS" title="OPTIONS" data-bare-link="true">options</a> <script.rb> [--] [profiled-script-command-line-options]</p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p><strong>ruby-prof</strong> is a fast profiler for ruby. It can be used as a stand-alone
+program (that this man page documents) or as a ruby library. Simply run
+the ruby program you want to profile using ruby-prof : <strong>ruby-prof script.rb</strong>
+ At the end of execution the time spent in each method is displayed.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<dl>
+<dt><code>-p</code>, <code>--printer=printer</code></dt><dd><p>Select a printer:<br />
+ flat - Prints a flat profile as text (default).<br />
+ flat_with_line_numbers - same as flat, with line numbers.<br />
+ graph - Prints a graph profile as text.<br />
+ graph_html - Prints a graph profile as html.<br />
+ call_tree - format for KCacheGrind<br />
+ call_stack - prints a HTML visualization of the call tree<br />
+ dot - Prints a graph profile as a dot file<br /></p></dd>
+<dt><code>-m</code>, <code>--min_percent=min_percent</code></dt><dd><p>The minimum percent a method must take before being included in output reports.
+this option is not supported for call tree.</p></dd>
+<dt><code>-f</code>, <code>--file=path</code></dt><dd><p>Output results to a file instead of standard out.</p></dd>
+<dt><code>--mode=measure_mode</code></dt><dd><p>Select what ruby-prof should measure:<br />
+ process - Process time (default).<br />
+ wall - Wall time.<br />
+ cpu - CPU time (Pentium and PowerPCs only).<br />
+ allocations - Object allocations (requires patched Ruby interpreter).<br />
+ memory - Allocated memory in KB (requires patched Ruby interpreter).<br />
+ gc_runs - Number of garbage collections (requires patched Ruby interpreter).<br />
+ gc_time - Time spent in garbage collection (requires patched Ruby interpreter).<br /></p></dd>
+<dt><code>-s</code>, <code>--sort=sort_mode</code></dt><dd><p>Select how ruby-prof results should be sorted:<br />
+ total - Total time<br />
+ self - Self time<br />
+ wait - Wait time<br />
+ child - Child time<br /></p></dd>
+<dt><code>--replace-progname</code></dt><dd><p>Replace $0 when loading the .rb files.</p></dd>
+<dt class="flush"><code>-v</code></dt><dd><p>Show version, set $VERBOSE to true, profile script if option given</p></dd>
+<dt class="flush"><code>-d</code></dt><dd><p>Set $DEBUG to true</p></dd>
+<dt><code>-R</code>, <code>--require-noprof lib</code></dt><dd><p>require a specific library (not profiled)</p></dd>
+<dt><code>-E</code>, <code>--eval-noprof code</code></dt><dd><p>execute the ruby statements (not profiled)</p></dd>
+<dt><code>-x</code>, <code>--exclude regexp</code></dt><dd><p>exclude methods by regexp (see method elimination)</p></dd>
+<dt><code>-X</code>, <code>--exclude-file file</code></dt><dd><p>exclude methods by regexp listed in file (see method elimination)</p></dd>
+<dt><code>--exclude-common-cycles</code></dt><dd><p>make common iterators like Integer#times appear inlined</p></dd>
+<dt><code>--exclude-common-callbacks</code></dt><dd><p>make common callbacks invocations like Integer#times appear inlined so you can see call origins in graph</p></dd>
+<dt><code>-h</code>, <code>--help</code></dt><dd><p>Show help message</p></dd>
+<dt><code>--version</code></dt><dd><p>Show version 0.13.1</p></dd>
+</dl>
+
+
+<h2 id="COPYRIGHT">COPYRIGHT</h2>
+
+<p>ruby-prof was written by Shugo Maeda <a href="mailto:shugo@ruby-lang.org" data-bare-link="true">shugo@ruby-lang.org</a>.</p>
+
+<p>This manual page was written by Arnaud Cornet <a href="mailto:arnaud.cornet@gmail.com" data-bare-link="true">arnaud.cornet@gmail.com</a> and
+updated by Jonas Genannt <a href="mailto:jonas.genannt@capi2name.de" data-bare-link="true">jonas.genannt@capi2name.de</a> for the Debian project (but may be used by others).</p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p>The ruby-prof website, https://github.com/ruby-prof/ruby-prof</p>
+
+
+ <ol class='man-decor man-foot man foot'>
+ <li class='tl'></li>
+ <li class='tc'>December 2013</li>
+ <li class='tr'>ruby-prof(1)</li>
+ </ol>
+
+ </div>
+</body>
+</html>
diff --git a/debian/manpages/ruby-prof.1.ronn b/debian/manpages/ruby-prof.1.ronn
new file mode 100644
index 0000000..716f546
--- /dev/null
+++ b/debian/manpages/ruby-prof.1.ronn
@@ -0,0 +1,94 @@
+ruby-prof(1) -- A fast ruby profiler
+=============================================
+
+## SYNOPSIS
+
+`ruby-prof` [options] <script.rb> [--] [profiled-script-command-line-options]
+
+## DESCRIPTION
+
+**ruby-prof** is a fast profiler for ruby. It can be used as a stand-alone
+program (that this man page documents) or as a ruby library. Simply run
+the ruby program you want to profile using ruby-prof : **ruby-prof script.rb**
+ At the end of execution the time spent in each method is displayed.
+
+## OPTIONS
+
+ * `-p`, `--printer=printer`:
+ Select a printer:<br>
+ flat - Prints a flat profile as text (default).<br>
+ flat_with_line_numbers - same as flat, with line numbers.<br>
+ graph - Prints a graph profile as text.<br>
+ graph_html - Prints a graph profile as html.<br>
+ call_tree - format for KCacheGrind<br>
+ call_stack - prints a HTML visualization of the call tree<br>
+ dot - Prints a graph profile as a dot file<br>
+
+ * `-m`, `--min_percent=min_percent`:
+ The minimum percent a method must take before being included in output reports.
+ this option is not supported for call tree.
+
+ * `-f`, `--file=path`:
+ Output results to a file instead of standard out.
+
+ * `--mode=measure_mode`:
+ Select what ruby-prof should measure:<br>
+ process - Process time (default).<br>
+ wall - Wall time.<br>
+ cpu - CPU time (Pentium and PowerPCs only).<br>
+ allocations - Object allocations (requires patched Ruby interpreter).<br>
+ memory - Allocated memory in KB (requires patched Ruby interpreter).<br>
+ gc_runs - Number of garbage collections (requires patched Ruby interpreter).<br>
+ gc_time - Time spent in garbage collection (requires patched Ruby interpreter).<br>
+
+ * `-s`, `--sort=sort_mode`:
+ Select how ruby-prof results should be sorted:<br>
+ total - Total time<br>
+ self - Self time<br>
+ wait - Wait time<br>
+ child - Child time<br>
+
+ * `--replace-progname`:
+ Replace $0 when loading the .rb files.
+
+ * `-v`:
+ Show version, set $VERBOSE to true, profile script if option given
+
+ * `-d`:
+ Set $DEBUG to true
+
+ * `-R`, `--require-noprof lib`:
+ require a specific library (not profiled)
+
+ * `-E`, `--eval-noprof code`:
+ execute the ruby statements (not profiled)
+
+ * `-x`, `--exclude regexp`:
+ exclude methods by regexp (see method elimination)
+
+ * `-X`, `--exclude-file file`:
+ exclude methods by regexp listed in file (see method elimination)
+
+ * `--exclude-common-cycles`:
+ make common iterators like Integer#times appear inlined
+
+ * `--exclude-common-callbacks`:
+ make common callbacks invocations like Integer#times appear inlined so you can see call origins in graph
+
+ * `-h`, `--help`:
+ Show help message
+
+ * `--version`:
+ Show version 0.13.1
+
+
+## COPYRIGHT
+
+ruby-prof was written by Shugo Maeda <shugo at ruby-lang.org>.
+
+This manual page was written by Arnaud Cornet <arnaud.cornet at gmail.com> and
+updated by Jonas Genannt <jonas.genannt at capi2name.de> for the Debian project (but may be used by others).
+
+## SEE ALSO
+
+The ruby-prof website, https://github.com/ruby-prof/ruby-prof
diff --git a/debian/ruby-prof.1 b/debian/ruby-prof.1
deleted file mode 100644
index 96ddec1..0000000
--- a/debian/ruby-prof.1
+++ /dev/null
@@ -1,49 +0,0 @@
-.TH RUBY-PROF 1 "14 October 2006"
-.SH NAME
-ruby-prof \- A fast ruby profiler
-.SH SYNOPSIS
-\fBruby-prof\fP [\fBoptions\fP] <\fIscript.rb\fP> [ \fBscript-options\fP ]
-.SH DESCRIPTION
-ruby-prof is a fast profiler for ruby. It can be used as a stand-alone program
-(that this man page documents) or as a ruby library.
-Simply run the ruby program you want to profile using ruby-prof :
-\fBruby-prof script.rb\fP
-At the end of execution the time spent in each method is displayed.
-.SH OPTIONS
-.TP
-\fB-p, --printer=printer\fP
-Select a printer:
- flat - Prints a flat profile as text (default).
- graph - Prints a graph profile as text.
- graph_html - Prints a graph profile as html.
- call_tree - format for KCacheGrind
-.TP
-\fB-m, --min_percent=min_percent\fP
-The minimum percent a method must take before being included in output reports.
-This option is not supported for call tree.
-.TP
-\fB-f, --file=path\fP
-Output results to a file instead of standard out.
-.TP
-\fB--mode=measure_mode\fP
-Select what ruby-prof should measure
- process - Use process time (default).
- wall - Use wall time.
- cpu - Use the CPU clock counter (only supported on Pentium and PowerPCs).
-.TP
-\fB--replace-progname\fP
-Replace $0 when loading the ruby source file.
-.TP
-\fB-h, --help\fP
-Show help message.
-.TP
-\fB-v, --version\fP
-Show version.
-.SH SEE ALSO
-The ruby-prof website, http://ruby-prof.rubyforge.org/
-.SH AUTHOR
-ruby-prof was written by Shugo Maeda <shugo at ruby-lang.org>.
-.PP
-This manual page was written by Arnaud Cornet <arnaud.cornet at gmail.com>
-for the Debian project (but may be used by others).
-
diff --git a/debian/ruby-prof.manpages b/debian/ruby-prof.manpages
index b923838..4cd44fd 100644
--- a/debian/ruby-prof.manpages
+++ b/debian/ruby-prof.manpages
@@ -1 +1 @@
-debian/ruby-prof.1
+debian/manpages/*.1
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/ruby-prof.git
More information about the Pkg-ruby-extras-commits
mailing list