summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSamuel Williams <samuel.williams@oriontransfer.co.nz>2021-12-18 21:42:17 +1300
committerSamuel Williams <samuel.williams@oriontransfer.co.nz>2021-12-18 23:10:42 +1300
commit78c175280befc8f0078ee037233ce1bb0af80ed6 (patch)
tree3a079b96542b4e41d791bfae7b28561d9950c696 /doc
parent1560cc16889e1afede66f675c89f9e3962a1e35e (diff)
Fix code formatting.
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/5295
Diffstat (limited to 'doc')
-rw-r--r--doc/hacking.md54
1 files changed, 35 insertions, 19 deletions
diff --git a/doc/hacking.md b/doc/hacking.md
index 088e7c2aca..5bbb04b176 100644
--- a/doc/hacking.md
+++ b/doc/hacking.md
@@ -8,33 +8,39 @@ This document gives some helpful instructions which should make your experience
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:
- # On macOS with Fish shell:
- export MAKEFLAGS="--jobs "(sysctl -n hw.ncpu)
+``` 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 macOS with Bash/ZSH shell:
+export MAKEFLAGS="--jobs $(sysctl -n hw.ncpu)"
- # On Linux with Fish shell:
- export MAKEFLAGS="--jobs "(nproc)
+# On Linux with Fish shell:
+export MAKEFLAGS="--jobs "(nproc)
- # On Linux with Bash/ZSH 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.
- ./autogen.sh
- mkdir build
- cd build
- ../configure --prefix $HOME/.rubies/ruby-head
- make install
+``` 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`.
- ../configure --disable-install-doc
+``` shell
+../configure --disable-install-doc
+```
## Running Ruby
@@ -42,7 +48,9 @@ If you are frequently building Ruby, this will reduce the time it takes to `make
You can create a file in the Ruby source root called `test.rb`. You can build `miniruby` and execute this script:
- make run
+``` shell
+make run
+```
If you want more of the standard library, you can use `runruby` instead of `run`.
@@ -50,20 +58,28 @@ If you want more of the standard library, you can use `runruby` instead of `run`
There are a set of tests in `bootstraptest/` which cover most basic features of the core Ruby language.
- make test
+``` shell
+make test
+```
### Run Extensive Tests
There are extensive tests in `test/` which cover a wide range of features of the Ruby core language.
- make test-all
+``` shell
+make test-all
+```
You can run specific tests by specifying their path:
- make test-all TESTS=../test/fiber/test_io.rb
+``` shell
+make test-all TESTS=../test/fiber/test_io.rb
+```
### Run RubySpec Tests
RubySpec is a project to write a complete, executable specification for the Ruby programming language.
- make test-all test-rubyspec
+``` shell
+make test-all test-rubyspec
+```