[DRE-commits] [ruby-build] 01/01: Convert manpage from ronn to asciidoc
Sebastian Boehm
sometimesfood-guest at moszumanska.debian.org
Thu Nov 19 11:39:45 UTC 2015
This is an automated email from the git hooks/post-receive script.
sometimesfood-guest pushed a commit to branch master
in repository ruby-build.
commit 5ce69c7a251431dc55acc258a81afc79848bbe3f
Author: Sebastian Boehm <sebastian at sometimesfood.org>
Date: Thu Nov 19 11:02:28 2015 +0100
Convert manpage from ronn to asciidoc
---
debian/control | 3 +-
debian/ruby-build.1.adoc | 152 +++++++++++++++++++++++++++++++++++++++++++++++
debian/ruby-build.1.ronn | 137 ------------------------------------------
debian/rules | 2 +-
4 files changed, 155 insertions(+), 139 deletions(-)
diff --git a/debian/control b/debian/control
index 92bab3f..f47b249 100644
--- a/debian/control
+++ b/debian/control
@@ -3,7 +3,8 @@ Section: ruby
Priority: optional
Maintainer: Debian Ruby Extras Maintainers <pkg-ruby-extras-maintainers at lists.alioth.debian.org>
Uploaders: Sebastian Boehm <sebastian at sometimesfood.org>
-Build-Depends: debhelper (>= 7.0.50~), ruby-ronn
+# TODO: fix build dependencies once Debian bug #692274 is addressed
+Build-Depends: debhelper (>= 7.0.50~), asciidoc, libxml2-utils, docbook-xml, xmlto
Standards-Version: 3.9.6
Homepage: https://github.com/sstephenson/ruby-build
Vcs-Git: http://anonscm.debian.org/git/pkg-ruby-extras/ruby-build.git
diff --git a/debian/ruby-build.1.adoc b/debian/ruby-build.1.adoc
new file mode 100644
index 0000000..b0d4eb8
--- /dev/null
+++ b/debian/ruby-build.1.adoc
@@ -0,0 +1,152 @@
+RUBY-BUILD(1)
+=============
+:doctype: manpage
+
+NAME
+----
+ruby-build - utility to compile and install Rubies
+
+SYNOPSIS
+--------
+*ruby-build* ['OPTIONS'...] 'DEFINITION' 'PREFIX'
+
+*ruby-build --definitions*
+
+*ruby-build --version*
+
+*ruby-build* [*-h*|*--help*]
+
+*rbenv install* ['OPTIONS'...] ['DEFINITION']
+
+*rbenv install* [*-l*|*--list*]
+
+*rbenv uninstall* [*-f*|*--force*] 'DEFINITION'
+
+DESCRIPTION
+-----------
+*ruby-build* provides a simple way to compile and install different
+versions of Ruby on UNIX-like systems.
+
+ruby-build downloads, builds and installs the Ruby version specified
+in a 'DEFINITION' into a 'PREFIX' directory. Definitions can be chosen
+from the list of installed definitions or by specifying a file path
+for a definition.
+
+rbenv(1) users can also use the provided *rbenv install*
+command, which installs Rubies into the `rbenv` directory.
+
+OPTIONS
+-------
+*--definitions*::
+ List available definitions.
+
+*-f*, *--force*::
+ When using *rbenv-install*, force installation of Ruby versions that
+ are already installed. When using *rbenv-uninstall*, uninstall
+ without prompting for confirmation or displaying an error message
+ for Rubies that are not currently installed.
+
+*-k*, *--keep*::
+ Don't delete source code after installation.
+
+*-p*, *--patch*::
+ Apply a patch from standard input to the Ruby, JRuby or Rubinius
+ source code before executing the `./configure` step.
+
+*-v*, *--verbose*::
+ Display compiler messages on standard output.
+
+*--version*::
+ Show `ruby-build` version and exit.
+
+*-h*, *--help*::
+ Show usage information and exit.
+
+EXAMPLES
+--------
+Install Ruby 2.0.0 (MRI, patch level 0) to `~/rubies/mri-2.0.0`:
+
+ ruby-build 2.0.0-p0 ~/rubies/mri-2.0.0
+
+Install Ruby Enterprise Edition 1.8.7 (patch level 2011.03) for rbenv(1):
+
+ rbenv install ree-1.8.7-2011.03
+
+Install local app-specific Ruby version:
+
+ rbenv install
+
+Install Ruby from a custom definition into `~/your-ruby`:
+
+ rbenv install /path/to/your/own/ruby/definition ~/your-ruby
+
+Install Ruby 2.0.0-p0, applying the patch in `/path/to/some.patch`:
+
+ rbenv install --patch 2.0.0-p0 < /path/to/some.patch
+
+ENVIRONMENT
+-----------
+*CC*::
+ Sets the path to the C compiler.
+
+*CONFIGURE_OPTS*::
+ Options that are passed to `./configure` when building a Ruby.
+
+*MAKE*::
+ Sets the command used for `make`.
+
+*MAKE_OPTS*::
+ Options that are passed to `make` when building a Ruby.
+
+*MAKEOPTS*::
+ Used instead of *MAKE_OPTS* when *MAKE_OPTS* is not defined.
+
+*RUBY_BUILD_BUILD_PATH*::
+ Sets the location in which sources are downloaded and built.
+
+*RUBY_BUILD_CACHE_PATH*::
+ Sets the location where downloaded package files are cached.
+
+*RUBY_BUILD_DEFINITIONS*::
+ Adds a colon-separated list of directories to the build definition
+ path.
+
+*RUBY_BUILD_MIRROR_URL*::
+ Sets the root URL of the mirror from which package files are
+ downloaded.
+
+*RUBY_BUILD_ROOT*::
+ If set, overrides the default location from where build definitions
+ in `share/ruby-build/` are looked up.
+
+*RUBY_BUILD_SKIP_MIRROR*::
+ If set, forces `ruby-build` to download packages from their
+ original source URLs instead of using a mirror.
+
+*RUBY_CFLAGS*::
+ Options that are added to the default `CFLAGS` when building a Ruby.
+
+*RUBY_CONFIGURE_OPTS*::
+ Options that are passed to `./configure` when building a Ruby. In
+ contrast to *CONFIGURE_OPTS*, these are only passed to Ruby and not
+ to any dependent packages (such as `libyaml`).
+
+*RUBY_MAKE_OPTS*::
+ Options that are passed to `make` when building a Ruby. In contrast
+ to *MAKE_OPTS*, these are only passed to Ruby and not to any
+ dependent packages (such as `libyaml`).
+
+*TMPDIR*::
+ Sets the location where `ruby-build` stores temporary files.
+
+AUTHORS
+-------
+ruby-build is developed by Sam Stephenson <sam at 37signals.com>.
+
+This man page was written for the Debian GNU/Linux distribution by
+Sebastian Boehm <sebastian at sometimesfood.org> but may be used by
+others.
+
+SEE ALSO
+--------
+rbenv(1)
diff --git a/debian/ruby-build.1.ronn b/debian/ruby-build.1.ronn
deleted file mode 100644
index 0b7eceb..0000000
--- a/debian/ruby-build.1.ronn
+++ /dev/null
@@ -1,137 +0,0 @@
-ruby-build(1) -- compile and install Rubies
-===========================================
-
-## SYNOPSIS
-
-`ruby-build` [OPTIONS...] <definition> <prefix><br>
-`ruby-build` `--definitions`<br>
-`ruby-build` `--version`<br>
-`ruby-build` [`-h`|`--help`]<br>
-`rbenv install` [OPTIONS...] [<definition>]<br>
-`rbenv install` [`-l`|`--list`]<br>
-`rbenv uninstall` [`-f`|`--force`] <definition><br>
-
-## DESCRIPTION
-
-**ruby-build** provides a simple way to compile and install different
-versions of Ruby on UNIX-like systems.
-
-`ruby-build` downloads, builds and installs the Ruby version specified
-in a <definition> into a <prefix> directory. Definitions can be chosen
-from the list of installed definitions or by specifying a file path
-for a definition.
-
-rbenv(1) users can also use the provided `rbenv install`
-command, which installs Rubies into the `rbenv` directory.
-
-## OPTIONS
-
- * `--definitions`:
- List available definitions.
-
- * `-f`, `--force`:
- When using `rbenv-install`, force installation of Ruby versions
- that are already installed. When using `rbenv-uninstall`,
- uninstall without prompting for confirmation or displaying an
- error message for Rubies that are not currently installed.
-
- * `-k`, `--keep`:
- Don't delete source code after installation.
-
- * `-p`, `--patch`:
- Apply a patch from standard input to the Ruby, JRuby or Rubinius
- source code before executing the `./configure` step.
-
- * `-v`, `--verbose`:
- Display compiler messages on standard output.
-
- * `--version`:
- Show `ruby-build` version and exit.
-
- * `-h`, `--help`:
- Show usage information and exit.
-
-## EXAMPLES
-
-Install Ruby 2.0.0 (MRI, patch level 0) to `~/rubies/mri-2.0.0`:
- ruby-build 2.0.0-p0 ~/rubies/mri-2.0.0
-
-Install Ruby Enterprise Edition 1.8.7 (patch level 2011.03) for rbenv(1):
- rbenv install ree-1.8.7-2011.03
-
-Install local app-specific Ruby version:
- rbenv install
-
-Install Ruby from a custom definition into `~/your-ruby`:
- rbenv install /path/to/your/own/ruby/definition ~/your-ruby
-
-Install Ruby 2.0.0-p0, applying the patch in `/path/to/some.patch`:
- rbenv install --patch 2.0.0-p0 < /path/to/some.patch
-
-## ENVIRONMENT
-
- * `CC`:
- Sets the path to the C compiler.
-
- * `CONFIGURE_OPTS`:
- Options that are passed to `./configure` when building a Ruby.
-
- * `MAKE`:
- Sets the command used for `make`.
-
- * `MAKE_OPTS`:
- Options that are passed to `make` when building a Ruby.
-
- * `MAKEOPTS`:
- Used instead of `MAKE_OPTS` when `MAKE_OPTS` is not defined.
-
- * `RUBY_BUILD_BUILD_PATH`:
- Sets the location in which sources are downloaded and built.
-
- * `RUBY_BUILD_CACHE_PATH`:
- Sets the location where downloaded package files are cached.
-
- * `RUBY_BUILD_DEFINITIONS`:
- Adds a colon-separated list of directories to the build definition
- path.
-
- * `RUBY_BUILD_MIRROR_URL`:
- Sets the root URL of the mirror from which package files are
- downloaded.
-
- * `RUBY_BUILD_ROOT`:
- If set, overrides the default location from where build
- definitions in share/ruby-build/ are looked up.
-
- * `RUBY_BUILD_SKIP_MIRROR`:
- If set, forces `ruby-build` to download packages from their
- original source URLs instead of using a mirror.
-
- * `RUBY_CFLAGS`:
- Options that are added to the default `CFLAGS` when building a
- Ruby.
-
- * `RUBY_CONFIGURE_OPTS`:
- Options that are passed to `./configure` when building a Ruby. In
- contrast to `CONFIGURE_OPTS`, these are only passed to Ruby and
- not to any dependent packages (such as libyaml).
-
- * `RUBY_MAKE_OPTS`:
- Options that are passed to `make` when building a Ruby. In
- contrast to `MAKE_OPTS`, these are only passed to Ruby and not to
- any dependent packages (such as libyaml).
-
- * `TMPDIR`:
- Sets the location where `ruby-build` stores temporary files.
-
-## AUTHORS
-
-ruby-build is developed by Sam Stephenson <<sam at 37signals.com>>.
-
-This man page was written for the Debian GNU/Linux distribution by
-Sebastian Boehm <<sebastian at sometimesfood.org>> but may be used by
-others.
-
-## SEE ALSO
-
-rbenv(1)
diff --git a/debian/rules b/debian/rules
index 9e50a4a..b0efa4b 100755
--- a/debian/rules
+++ b/debian/rules
@@ -12,4 +12,4 @@ get-orig-source:
uscan --download-current-version --force-download --rename
update-manpage:
- ronn --roff --warnings debian/ruby-build.1.ronn
+ a2x --format manpage debian/ruby-build.1.adoc
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/ruby-build.git
More information about the Pkg-ruby-extras-commits
mailing list