[DRE-commits] [SCM] ruby-zentest.git branch, master, updated. upstream/4.8.2-6-gc886b67
Praveen Arimbrathodiyil
praveen at debian.org
Tue Oct 30 10:17:51 UTC 2012
The following commit has been merged in the master branch:
commit cd15b844531ab8a7d008f6feab13650744f43b62
Author: Praveen Arimbrathodiyil <praveen at debian.org>
Date: Tue Oct 30 15:46:04 2012 +0530
update all man pages with formatting
- add --help output to multiruby_setup man page
diff --git a/debian/autotest.1.pod b/debian/autotest.1.pod
index bfda183..e5e967d 100644
--- a/debian/autotest.1.pod
+++ b/debian/autotest.1.pod
@@ -4,7 +4,7 @@ autotest - a continuous testing facility
=head1 SYNOPSIS
-autotest
+B<autotest>
=head1 DESCRIPTION
@@ -12,7 +12,7 @@ B<autotest> is a continuous testing facility meant to be used during
development. As soon as you save a file, autotest will run the
corresponding dependent tests.
-See /usr/share/doc/ruby-zentest/ for more details.
+See I</usr/share/doc/ruby-zentest/> for more details.
=head1 AUTHOR
diff --git a/debian/multigem.1.pod b/debian/multigem.1.pod
index 479cee8..82b1c9d 100644
--- a/debian/multigem.1.pod
+++ b/debian/multigem.1.pod
@@ -4,7 +4,7 @@ multigem - install gems for multiple ruby versions
=head1 SYNOPSIS
-multigem command
+B<multigem> I<command>
=head1 DESCRIPTION
@@ -12,7 +12,7 @@ B<multigem> uses multiruby to run the gem command in order to install
gems in the right place for each of the ruby versions under that
.multiruby directory. It takes all options of gem command.
-See /usr/share/doc/ruby-zentest/ for more details.
+See I</usr/share/doc/ruby-zentest/> for more details.
=head1 AUTHOR
diff --git a/debian/multiruby.1.pod b/debian/multiruby.1.pod
index 2697c0d..80a67cb 100644
--- a/debian/multiruby.1.pod
+++ b/debian/multiruby.1.pod
@@ -4,12 +4,12 @@ multiruby - runs anything you want on multiple versions of ruby
=head1 SYNOPSIS
-multiruby ./TestMyProject.rb
+B<multiruby> I<./TestMyProject.rb>
=head1 DESCRIPTION
B<multiruby> runs anything you want on multiple versions of ruby. Great
-for compatibility checking! Use multiruby_setup to manage your
+for compatibility checking! Use I<multiruby_setup> to manage your
installed versions.
=head1 AUTHOR
diff --git a/debian/multiruby_setup.1.pod b/debian/multiruby_setup.1.pod
index 47cdf3b..a8b71ed 100644
--- a/debian/multiruby_setup.1.pod
+++ b/debian/multiruby_setup.1.pod
@@ -1,10 +1,12 @@
=head1 NAME
-multiruby_setup - manage multiple versions of ruby for multiruby
+multiruby_setup - script to help you manage multiruby
=head1 SYNOPSIS
-multiruby_setup mri:svn:current
+B<multiruby_setup> [B<-h>|I<cmd>|I<spec...>]
+
+B<multiruby_setup> I<mri:svn:current>
=head1 DESCRIPTION
@@ -15,7 +17,85 @@ multiple versions of ruby.
The various versions are installed in a subdirectory of .multiruby
in your home directory.
-Run multiruby_setup --help to see all the options.
+=head1 OPTIONS
+
+=head2 cmds
+
+B<-h>, B<--help>, B<help>
+ show this help.
+
+B<build>
+ build and install everything. used internally.
+
+B<clean>
+ clean scm build dirs and remove non-scm build dirs.
+
+B<list>
+ print installed versions.
+
+B<rm:$version>
+ remove a particular version.
+
+B<rubygems:merge>
+ symlink all rubygem dirs to one dir.
+
+B<tags>
+ list all tags from svn.
+
+B<update>
+ update svn builds.
+
+B<update:rubygems>
+ update rubygems and nuke install dirs.
+
+=head2 specs
+
+B<the_usual>
+ alias for latest versions from tar + rubygems
+
+B<mri:svn:current>
+ alias for mri:svn:releases and mri:svn:branches.
+
+B<mri:svn:releases>
+ alias for supported releases of mri ruby.
+
+B<mri:svn:branches>
+ alias for active branches of mri ruby.
+
+B<mri:svn:branch:$branch>
+ install a specific $branch of mri from svn.
+
+B<mri:svn:tag:$tag>
+ install a specific $tag of mri from svn.
+
+B<mri:tar:$version>
+ install a specific $version of mri from tarball.
+
+=head2 environment variables
+
+B<GEM_URL>
+ url for rubygems tarballs
+
+B<MRI_SVN>
+ url for MRI SVN
+
+B<RUBY_URL>
+ url for MRI tarballs
+
+B<VERSIONS>
+ what versions to install
+
+B<RUBYOPT> is cleared on installs.
+
+=head1 NOTES
+
+=over 4
+
+=item * you can add a symlink to your rubinius build into ~/.multiruby/install
+
+=item * I need patches/maintainers for other implementations.
+
+=back
=head1 AUTHOR
diff --git a/debian/unit_diff.1.pod b/debian/unit_diff.1.pod
index 81f737f..5e99c4f 100644
--- a/debian/unit_diff.1.pod
+++ b/debian/unit_diff.1.pod
@@ -4,16 +4,16 @@ unit_diff - command-line filter to diff expected results from actual results
=head1 SYNOPSIS
-./TestMyProject.rb | unit_diff
+I<./TestMyProject.rb> | B<unit_diff>
=head1 DESCRIPTION
B<unit_diff> is a command-line filter to diff expected results from
actual results and allow you to quickly see exactly what is wrong.
Do note that minitest 2.2+ provides an enhanced assert_equal obviating
-the need for unit_diff
+the need for unit_diff.
-See /usr/share/doc/ruby-zentest/ for more details.
+See I</usr/share/doc/ruby-zentest/> for more details.
=head1 AUTHOR
diff --git a/debian/zentest.1.pod b/debian/zentest.1.pod
index 79d79d5..eecea2b 100644
--- a/debian/zentest.1.pod
+++ b/debian/zentest.1.pod
@@ -4,7 +4,7 @@ zentest - scans your target and unit-test code and writes your missing code
=head1 SYNOPSIS
-zentest MyProject.rb TestMyProject.rb > missing.rb
+B<zentest> I<MyProject.rb TestMyProject.rb> > I<missing.rb>
=head1 DESCRIPTION
@@ -14,7 +14,7 @@ zentest only works with Ruby and Minitest or Test::Unit. There is
enough evidence to show that this is still proving useful to users, so
it stays.
-See /usr/share/doc/ruby-zentest/ for more details.
+See I</usr/share/doc/ruby-zentest/> for more details.
=head1 AUTHOR
--
ruby-zentest.git
More information about the Pkg-ruby-extras-commits
mailing list