diff options
| author | Jemma Issroff <[email protected]> | 2022-05-09 11:45:50 -0400 |
|---|---|---|
| committer | Peter Zhu <[email protected]> | 2022-05-11 10:59:24 -0400 |
| commit | c00feffb46ac646605adc277b5454e6b067e2d8a (patch) | |
| tree | 5dc1cd26ca18b1bc0f6a48a71b91a67a6c778d43 /doc/hacking.md | |
| parent | becafe1efb7bf8bf5a324a6005b24e133c0f69a8 (diff) | |
Improve documentation on contributing to Ruby
co-authored-by: Peter Zhu <[email protected]>
co-authored-by: Stan Lo <[email protected]>
Notes
Notes:
Merged: https://github.com/ruby/ruby/pull/5899
Diffstat (limited to 'doc/hacking.md')
| -rw-r--r-- | doc/hacking.md | 104 |
1 files changed, 0 insertions, 104 deletions
diff --git a/doc/hacking.md b/doc/hacking.md deleted file mode 100644 index e441a40554..0000000000 --- a/doc/hacking.md +++ /dev/null @@ -1,104 +0,0 @@ -# Ruby Hacking Guide - -This document gives some helpful instructions which should make your -experience as a Ruby core developer easier. - -## Setup - -### Make - -It's common to want to compile things as quickly as possible. Ensuring -`make` has the right `--jobs` flag will ensure all processors are -utilized when building software projects To do this effectively, you -can set `MAKEFLAGS` in your shell configuration/profile: - -``` shell -# On macOS with Fish shell: -export MAKEFLAGS="--jobs "(sysctl -n hw.ncpu) - -# On macOS with Bash/ZSH shell: -export MAKEFLAGS="--jobs $(sysctl -n hw.ncpu)" - -# On Linux with Fish shell: -export MAKEFLAGS="--jobs "(nproc) - -# On Linux with Bash/ZSH shell: -export MAKEFLAGS="--jobs $(nproc)" -``` - -## Configure Ruby - -It's generally advisable to use a build directory. - -``` shell -./autogen.sh -mkdir build -cd build -../configure --prefix $HOME/.rubies/ruby-head -make install -``` - -### Without Documentation - -If you are frequently building Ruby, this will reduce the time it -takes to `make install`. - -``` shell -../configure --disable-install-doc -``` - -## Running Ruby - -### Run Local Test Script - -You can create a file in the Ruby source root called `test.rb`. You -can build `miniruby` and execute this script: - -``` shell -make run -``` - -If you want more of the standard library, you can use `runruby` -instead of `run`. - -## Running Tests - -You can run the following tests at once: - -``` shell -make check -``` - -### Run Bootstrap Tests - -There are a set of tests in `bootstraptest/` which cover most basic -features of the core Ruby language. - -``` shell -make test -``` - -### Run Extensive Tests - -There are extensive tests in `test/` which cover a wide range of -features of the Ruby core language. - -``` shell -make test-all -``` - -You can run specific tests by specifying their path: - -``` shell -make test-all TESTS=../test/fiber/test_io.rb -``` - -### Run Ruby Spec Suite Tests - -The [Ruby Spec Suite](https://github.com/ruby/spec/) is a test suite -that aims to provide an executable description for the behavior of the -language. - -``` shell -make test-spec -``` |