Skip to content

Commit

Permalink
Update INSTALL doc for git
Browse files Browse the repository at this point in the history
  • Loading branch information
jfirebaugh committed Aug 8, 2011
1 parent 74531b5 commit 2dcd7e7
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 29 deletions.
30 changes: 13 additions & 17 deletions INSTALL.SVN → INSTALL.GIT
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Building and Installing ruby-debug from rubyforge's Subversion
Repository (svn)
Building and Installing ruby-debug from git

The below are Unix-centric instructions. If you have Microsoft
Windows, see the section on building Microsoft Windows.
Expand All @@ -12,7 +11,7 @@ Windows, see the section on building Microsoft Windows.
- Ruby development headers. This typically includes a file called "ruby.h"
- A C compiler like GNU C (gcc)
- Rake
- Subversion (svn)
- git

If you want to build the documentation and install Emacs files, you'll
also need:
Expand All @@ -26,18 +25,14 @@ also need:

1. Basic package checkout and installation

Check out the trunk of repository following the instructions at
http://rubyforge.org/scm/?group_id=1900 For example on a Unixy system,
this may work:
Clone the git repository:

mkdir ruby-debug
cd ruby-debug
svn checkout svn://rubyforge.org/var/svn/ruby-debug/trunk trunk
git clone git://github.com/ruby-debug/ruby-debug.git

In order to make the Ruby gems, ruby-debug and ruby-debug-base, get
yourself into the trunk directory after the code has been checked out and run:
yourself into the directory after the code has been checked out and run:

cd trunk # This is the same trunk checked out above.
cd ruby-debug
rake package

If all goes well you should have some gem files put in the directory
Expand All @@ -62,21 +57,22 @@ part of step 1 you may want to try this approach since we go into a
little more detail as to what happens under the covers when you do the
gem install.

Run (from trunk)
Run:

rake compile

This creates a Makefile and builds the ruby-debug shared library. (On
Unix the name is ruby_debug.so).

Once this is done you can run the debugger as you would rdebug using the
script rdbg.rb. For example (again from trunk)
script rdbg.rb. For example:

./rdbg.rb ~/my-ruby-program.rb

3. Running the Regression tests

We've put together some basic tests to make sure ruby-debug is doing
what we think it should do. To run these (from trunk):
what we think it should do. To run these:

rake test

Expand Down Expand Up @@ -118,16 +114,16 @@ and basically build a ruby interpreter. I use cross-compile.sh script
in this directory. You may want to customize it for your needs.

Once you have a cross-compiled rubyw.exe interpreter, the directory
you want be is in ruby-debug/trunk/ext/win32, not ruby-debug/ext.
you want be is in ruby-debug/ext/win32, not ruby-debug/ext.

So let's say you've installed the cross-compiled install rubyw.exe in
/usr/local/ruby-mingw32/rubyw.exe. Here then are the commands to build
ruby-debug-base-xxx-mswin32.gem

cd .../ruby-debug/trunk/ext/win32
cd .../ruby-debug/ext/win32
ruby -I /usr/local/ruby-mingw32/lib/ruby/1.8/i386-mingw32 ../extconf.rb
make # Not rake
cd ../.. # back in ruby-debug/trunk
cd ../.. # back in ruby-debug
rake win32_gem

3. Customizing C extension compile options
Expand Down
12 changes: 0 additions & 12 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -129,18 +129,6 @@ It is the same as ruby-debug-base native C extension from ruby-debug project

jruby -S gem install ruby-debug-base

== Installation of trunk version

Handy for developers or users living on the cutting-edge.

$ cd ~/tmp
$ svn co svn://rubyforge.org/var/svn/debug-commons/jruby-debug/trunk jruby-debug
$ cd jruby-debug
$ rake gem
$ jruby -S gem install -l pkg/ruby-debug-base-0.10.3-java.gem
$ jruby -S gem install columnize
$ jruby -S gem install -r ruby-debug -v 0.10.3 --ignore-dependencies

== Usage

The usage is then the same as with native ruby-debugger, but you might need to
Expand Down

0 comments on commit 2dcd7e7

Please sign in to comment.