Hi,
On Fri, Dec 30, 2011 at 01:26:29AM -0200, Antonio Terceiro wrote:
> # Usage
>
> $ ruby-debian-doc <package>
>
> That's it.
An nice option would also be to have it automatically updated/installed
when a Ruby package is installed. This could be some hook somewhere
to do this when enabled. By default it is obviously off, but typically
enabled on a development machine.
A result could be a central archive with some index page listing
the packages/libraries documentation is generated for.
I don't know if it already does this, but I could not get it to run:
% ruby-debian-doc ruby-<anything>
/usr/lib/ruby/vendor_ruby/debian-doc/writer.rb:47:in `system': can't
convert nil into String (TypeError)
from /usr/lib/ruby/vendor_ruby/debian-doc/writer.rb:47:in `process'
from /usr/lib/ruby/vendor_ruby/debian-doc/writer.rb:24:in `write'
from /usr/lib/ruby/vendor_ruby/debian-doc/cli.rb:15:in `run'
from /usr/bin/ruby-debian-doc:3
> This should avoid the need for including documentation in binary
> packages, saving space in the archive and bandwidth for everyone (the
> gerenerated documentation is usually several times larger than the code
> itself).
There is a problem, however, with extensions. Once built and installed,
there is no way to extract the documentation... it is only possible at
build time.
> Please let me known what you think. In special, I will appreciate
> suggestions of a better name for the tool.
Nothing great for now, but you could always go with ruby-debdoc to
make it shorter.
Cheers,
Paul
--
Using the Power of Debian GNU/Linux | email: paulvt@debian.org
jabber/gtalk: paul@luon.netl | GnuPG key ID: 0x50064181
Attachment:
signature.asc
Description: Digital signature