kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

Fix code formatting.

Browse source
This commit is contained in:
Samuel Williams 2021-12-18 21:42:17 +13:00
parent 1560cc1688
commit 78c175280b
Notes: git 2021-12-18 19:11:12 +09:00 
Merged: https://github.com/ruby/ruby/pull/5295
1 changed files with 35 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
doc/hacking.md
View file

@ -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: 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: ``` shell
export MAKEFLAGS="--jobs "(sysctl -n hw.ncpu) # On macOS with Fish shell:
export MAKEFLAGS="--jobs "(sysctl -n hw.ncpu)
# On macOS with Bash/ZSH shell: # On macOS with Bash/ZSH shell:
export MAKEFLAGS="--jobs $(sysctl -n hw.ncpu)" export MAKEFLAGS="--jobs $(sysctl -n hw.ncpu)"
# On Linux with Fish shell: # On Linux with Fish shell:
export MAKEFLAGS="--jobs "(nproc) export MAKEFLAGS="--jobs "(nproc)
# On Linux with Bash/ZSH shell: # On Linux with Bash/ZSH shell:
export MAKEFLAGS="--jobs $(nproc)" export MAKEFLAGS="--jobs $(nproc)"
```
## Configure Ruby ## Configure Ruby
It's generally advisable to use a build directory. It's generally advisable to use a build directory.
./autogen.sh ``` shell
mkdir build ./autogen.sh
cd build mkdir build
../configure --prefix $HOME/.rubies/ruby-head cd build
make install ../configure --prefix $HOME/.rubies/ruby-head
make install
```
### Without Documentation ### Without Documentation
If you are frequently building Ruby, this will reduce the time it takes to `make install`. 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 ## 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: 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`. 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. 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 ### Run Extensive Tests
There are extensive tests in `test/` which cover a wide range of features of the Ruby core language. 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: 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 ### Run RubySpec Tests
RubySpec is a project to write a complete, executable specification for the Ruby programming language. 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
```