Releasing system?


(Evan Martin) #1

I think I’m ready for an initial release of Ruby/Evas.

Is there a Ruby Way to releasing? For example, I’ve used Python’s
distutils in the past.

Or should I just build a .tar.gz that includes a README that tells the
user to “cd src; make && make install” ?

How about documentation? Is there any standard way to build it? I have
the .rd file and a Makefile that runs rd2, but that doesn’t do any sort
of installation. (Is there a standardized procedure for installing
documentation on *nix systems? I’ve been in the Debian world for so
long I can’t remember what is standard and what is just Debian
policy…)

Sorry if this is answered elsewhere. I looked around and didn’t find
anything. :slight_smile:

···


Evan Martin
martine@cs.washington.edu
http://neugierig.org


(Tobi Reif) #2

Evan Martin wrote:

I think I’m ready for an initial release of Ruby/Evas.

Is there a Ruby Way to releasing?

Some suggestions:

  • ruby-talk (subject “[ann] foo”)
  • RAA (Ruby Application Archive) [1]
  • homepage:
    • screenshots if applicable
    • readme (short desc, info, usage, …)
    • examples (perhaps a tutorial or demo
      if applicable)
    • RDOCs [2]
    • .zip//&.tar.gz
      I like it if it’s easy to install by hand,
      by moving it to $: [3])

Some nice examples:

RDOC [4]
REXML [5] (check the RDOCs)

Tobi

[1] http://www.ruby-lang.org/en/raa.html
[2] http://rdoc.sourceforge.net/
[3]
ruby -e “puts $:”
/cygdrive/c/RUBY/lib/ruby/site_ruby/1.6
/cygdrive/c/RUBY/lib/ruby/site_ruby/1.6/i386-cygwin
/cygdrive/c/RUBY/lib/ruby/site_ruby
/cygdrive/c/RUBY/lib/ruby/1.6
/cygdrive/c/RUBY/lib/ruby/1.6/i386-cygwin
.
[4] http://rdoc.sourceforge.net/

[5] http://www.germane-software.com/software/rexml/

···


http://www.pinkjuice.com/


(Lyle Johnson) #3

Is there a Ruby Way to releasing? For example, I’ve used Python’s
distutils in the past.

Or should I just build a .tar.gz that includes a README that tells the
user to “cd src; make && make install”?

Sadly, there is no real standard for this yet (although I think we
should shoot for a much higher standard than the distutils :wink: There are
some promising things in the works, like RubyGems and rpkg (and probably
others I haven’t kept up with) but certainly no standard has emerged yet.

If it’s a C/C+±based extension you want to be sure to include an
extconf.rb script so that a platform-appropriate Makefile gets
generated. This is described (among other places) in the README.EXT file
from the Ruby source code distribution, and in books like “Programming
Ruby” and the “Ruby Developer’s Guide”.

If your software consists of more than “just” the C extension part –
for example, supporting scripts and library files – you might also take
a look at Minero Aoki’s setup.rb script
(http://www.loveruby.net/en/setup.html). This is the system I’m
currently using for FXRuby and it basically works well. He does not yet
have support for some things I’d like, such as documentation files and
test scripts, but it’s about as good as it gets short of rolling your
own solution.

How about documentation? Is there any standard way to build it? I have
the .rd file and a Makefile that runs rd2, but that doesn’t do any sort
of installation. (Is there a standardized procedure for installing
documentation on *nix systems? I’ve been in the Debian world for so
long I can’t remember what is standard and what is just Debian
policy…)

I don’t think it’s standardized. On my Red Hat 7.2 system, documentation
files tend to get installed in places like /usr/share/doc (or
/usr/local/share/doc) but I don’t know that this is true in general.


(Pat Eyler) #4

For distribution, may I suggest looking at rubynet, this is the
project aiming at fulfilling the requirements of raa.succ (from last years
rubyconf and the interveneing discussion). See rubynet.sourceforge.net
for more info.

···

On Thu, 20 Jun 2002, Lyle Johnson wrote:

Is there a Ruby Way to releasing? For example, I’ve used Python’s
distutils in the past.

Or should I just build a .tar.gz that includes a README that tells the
user to “cd src; make && make install”?

Sadly, there is no real standard for this yet (although I think we
should shoot for a much higher standard than the distutils :wink: There are
some promising things in the works, like RubyGems and rpkg (and probably
others I haven’t kept up with) but certainly no standard has emerged yet.


(Lyle Johnson) #5

Sadly, there is no real standard for this yet (although I think we
should shoot for a much higher standard than the distutils :wink: There are
some promising things in the works, like RubyGems and rpkg (and probably
others I haven’t kept up with) but certainly no standard has emerged yet.

For distribution, may I suggest looking at rubynet, this is the
project aiming at fulfilling the requirements of raa.succ (from last years
rubyconf and the interveneing discussion). See rubynet.sourceforge.net
for more info.

Well, I am an idiot. I had no idea this project existed (when was this
announced?). Anyways, thanks very much for the info, Pat, and now I’m
off to read the rubynet mailing list archives!