Skip to content

Commit b79f29e

Browse files
committed
Fix links in the table of content
1 parent e6cb537 commit b79f29e

File tree

1 file changed

+32
-62
lines changed

1 file changed

+32
-62
lines changed

doc/contributor/how-to-guide.md

Lines changed: 32 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,36 @@
11
# How-To Guide
22

3-
- [How to find a Core Method
4-
implementation](#TruffleRubyhowtoguide-HowtofindaCoreMethodimplementation)
5-
- [How to add a Core Method in
6-
Java](#TruffleRubyhowtoguide-HowtoaddaCoreMethodinJava)
7-
- [How to add a new C API
8-
function](#TruffleRubyhowtoguide-HowtoaddanewCAPIfunction)
9-
- [How to define and expose a POSIX system call to Ruby
10-
code](#TruffleRubyhowtoguide-HowtodefineandexposeaPOSIXsystemcalltoRubycode)
11-
- [How to add a helper Ruby
12-
method](#TruffleRubyhowtoguide-HowtoaddahelperRubymethod)
13-
- [How to warn in Ruby](#TruffleRubyhowtoguide-HowtowarninRuby)
14-
- [How to warn in Java](#TruffleRubyhowtoguide-HowtowarninJava)
15-
- [How to raise Ruby exception in
16-
Java](#TruffleRubyhowtoguide-HowtoraiseRubyexceptioninJava)
17-
- [How to cast type implicitly in
18-
Ruby](#TruffleRubyhowtoguide-HowtocasttypeimplicitlyinRuby)
19-
- [How to cast type implicitly in
20-
Java](#TruffleRubyhowtoguide-HowtocasttypeimplicitlyinJava)
21-
- [How to call Java code in
22-
Ruby](#TruffleRubyhowtoguide-HowtocallJavacodeinRuby)
23-
- [How to call Ruby method in
24-
Java](#TruffleRubyhowtoguide-HowtocallRubymethodinJava)
25-
- [How to declare an optional method argument in
26-
Ruby](#TruffleRubyhowtoguide-HowtodeclareanoptionalmethodargumentinRuby)
27-
- [How to accept keyword arguments in Core Method in
28-
Java](#TruffleRubyhowtoguide-HowtoacceptkeywordargumentsinCoreMethodinJava)
29-
- [How to create Ruby Array in
30-
Java](#TruffleRubyhowtoguide-HowtocreateRubyArrayinJava)
31-
- [How to call original class method in
32-
Ruby](#TruffleRubyhowtoguide-HowtocalloriginalclassmethodinRuby)
33-
- [How to call original instance method in
34-
Ruby](#TruffleRubyhowtoguide-HowtocalloriginalinstancemethodinRuby)
35-
- [How to get a list of all the
36-
Primitives](#TruffleRubyhowtoguide-HowtogetalistofallthePrimitives)
37-
- [How to use the most common
38-
Primitives](#TruffleRubyhowtoguide-HowtousethemostcommonPrimitives)
39-
- [How to use Java debug
40-
helpers](#TruffleRubyhowtoguide-HowtouseJavadebughelpers)
41-
- [How to update supported Unicode
42-
version](#TruffleRubyhowtoguide-HowtoupdatesupportedUnicodeversion)
43-
- [How to patch MRI source files when update
44-
Ruby](#TruffleRubyhowtoguide-HowtopatchMRIsourcefileswhenupdateRuby)
45-
- [How to introduce a new platform-specific constant in
46-
Ruby](#TruffleRubyhowtoguide-Howtointroduceanewplatform-specificconstantinRuby)
47-
- [How to decide on what to change - ABI version or ABI
48-
check](#TruffleRubyhowtoguide-Howtodecideonwhattochange-ABIversionorABIcheck)
49-
- [How to choose where to add new specs - in TruffleRuby or in
50-
ruby/spec
51-
repository](#TruffleRubyhowtoguide-Howtochoosewheretoaddnewspecs-inTruffleRubyorinRubySpecrepository)
52-
- [How to choose between Ruby and Java when implement a Ruby Core
53-
Library class
54-
method](#TruffleRubyhowtoguide-HowtochoosebetweenRubyandJavawhenimplementaRubyCoreLibraryclassmethod)
55-
- [How to write specs for C
56-
API](#TruffleRubyhowtoguide-HowtowritespecsforCAPI)
57-
- [How to exclude/include a spec/MRI test
58-
case](#TruffleRubyhowtoguide-Howtoexclude/includeaRubySpec/MRItestcase)
59-
- [How to tag slow ruby/spec
60-
tests](#TruffleRubyhowtoguide-HowtotagslowRubySpectests)
61-
- [How to introduce a constant  in
62-
specs](#TruffleRubyhowtoguide-Howtointroduceaconstantinspecs)
63-
- [How to add a new spec](#TruffleRubyhowtoguide-Howtoaddanewspec)
3+
* [How to find a Core Method implementation](#how-to-find-a-core-method-implementation)
4+
* [How to add a Core Method in Java](#how-to-add-a-core-method-in-java)
5+
* [How to add a new C API function](#how-to-add-a-new-c-api-function)
6+
* [How to define and expose a POSIX system call to Ruby code](#how-to-define-and-expose-a-posix-system-call-to-ruby-code)
7+
* [How to add a helper Ruby method](#how-to-add-a-helper-ruby-method)
8+
* [How to warn in Ruby](#how-to-warn-in-ruby)
9+
* [How to warn in Java](#how-to-warn-in-java)
10+
* [How to raise Ruby exception in Java](#how-to-raise-ruby-exception-in-java)
11+
* [How to cast type implicitly in Ruby](#how-to-cast-type-implicitly-in-ruby)
12+
* [How to cast type implicitly in Java](#how-to-cast-type-implicitly-in-java)
13+
* [How to call Java code in Ruby](#how-to-call-java-code-in-ruby)
14+
* [How to call Ruby method in Java](#how-to-call-ruby-method-in-java)
15+
* [How to declare an optional method argument in Ruby](#how-to-declare-an-optional-method-argument-in-ruby)
16+
* [How to accept keyword arguments in Core Method in Java](#how-to-accept-keyword-arguments-in-core-method-in-java)
17+
* [How to create Ruby Array in Java](#how-to-create-ruby-array-in-java-)
18+
* [How to call original class method in Ruby](#how-to-call-original-class-method-in-ruby)
19+
* [How to call original instance method in Ruby](#how-to-call-original-instance-method-in-ruby)
20+
* [How to get a list of all the Primitives](#how-to-get-a-list-of-all-the-primitives)
21+
* [How to use the most common Primitives](#how-to-use-the-most-common-primitives)
22+
* [How to use Java debug helpers](#how-to-use-java-debug-helpers)
23+
* [How to update supported Unicode version](#how-to-update-supported-unicode-version)
24+
* [How to patch MRI source files when update Ruby](#how-to-patch-mri-source-files-when-update-ruby)
25+
* [How to introduce a new platform-specific constant in Ruby](#how-to-introduce-a-new-platform-specific-constant-in-ruby)
26+
* [How to decide on what to change - ABI version or ABI check](#how-to-decide-on-what-to-change---abi-version-or-abi-check)
27+
* [How to choose where to add new specs - in TruffleRuby or in ruby/spec repository](#how-to-choose-where-to-add-new-specs---in-truffleruby-or-in-rubyspec-repository)
28+
* [How to choose between Ruby and Java when implement a Ruby Core Library class method](#how-to-choose-between-ruby-and-java-when-implement-a-ruby-core-library-class-method)
29+
* [How to write specs for C API](#how-to-write-specs-for-c-api)
30+
* [How to exclude/include ruby/spec and MRI test cases](#how-to-excludeinclude-rubyspec-and-mri-test-cases)
31+
* [How to tag slow ruby/spec tests](#how-to-tag-slow-rubyspec-tests)
32+
* [How to introduce a constant in specs](#how-to-introduce-a-constant-in-specs)
33+
* [How to add a new spec](#how-to-add-a-new-spec)
6434

6535
## How to find a Core Method implementation
6636

@@ -1501,7 +1471,7 @@ and functions might be helpful:
15011471
- `rb_str_new`, `rb_str_new_cstr`
15021472
- `rb_intern`
15031473
1504-
## How to exclude/include a spec/MRI test case
1474+
## How to exclude/include ruby/spec and MRI test cases
15051475
15061476
There is a mechanism to skip tests for not yet implemented functionality
15071477
or known but not fixed bug.

0 commit comments

Comments
 (0)