Skip to content

Commit b5f8dd5

Browse files
committed
Fix typo and links to suppress linter warnings
1 parent 07d6fc2 commit b5f8dd5

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

doc/contributor/how-to-guide.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -572,8 +572,7 @@ module.
572572
C extensions related *primitives* are located in
573573
`org/truffleruby/cext/CExtNodes.java` file.
574574

575-
More details about writing a C extensions are provided in the C Extensions Guide
576-
([https://github.com/oracle/truffleruby/blob/master/doc/contributor/cexts.md](https://github.com/oracle/truffleruby/blob/master/doc/contributor/cexts.md){.external-link rel="nofollow"}).
575+
More details about writing a C extensions are provided in the [C Extensions Guide](cexts.md).
577576

578577
## How to define and expose a POSIX system call to Ruby code
579578

@@ -613,7 +612,7 @@ e.g. this function returns current time in nanoseconds:
613612
// src/main/c/truffleposix/truffleposix.c
614613
int64_t truffleposix_clock_gettime(int clock) {
615614
struct timespec timespec;
616-
int ret = clock_gettime((clockid_t) clock, ×pec);
615+
int ret = clock_gettime((clockid_t) clock, &timespec);
617616
if (ret != 0) {
618617
return 0;
619618
}
@@ -832,8 +831,7 @@ Library files):
832831
# truffleruby_primitives: true
833832
```
834833
835-
Naming conventions are described in the Primitives Guide
836-
<https://github.com/oracle/truffleruby/blob/master/doc/contributor/primitives.md>.
834+
Naming conventions are described in the [Primitives Guide](primitives.md).
837835
838836
## How to call Ruby method in Java
839837
@@ -1196,14 +1194,13 @@ jt -q ruby -e 'puts Truffle::Debug.ast_size([].method(:to_ary))'
11961194
11971195
## How to update supported Unicode version
11981196
1199-
We rely on [JCodings](https://github.com/jruby/jcodings){.external-link rel="nofollow"} for Unicode/Encoding stuff.
1197+
We rely on [JCodings](https://github.com/jruby/jcodings) for Unicode/Encoding stuff.
12001198
So basically updating Unicode version is just as upgrade of this library
12011199
12021200
Steps to do:
12031201
12041202
- choose a proper jcodings version (probably the latest one)
1205-
- Unicode version is hardcoded here
1206-
<https://github.com/jruby/jcodings/blob/jcodings-1.0.58/src/org/jcodings/Config.java>
1203+
- Unicode version is hardcoded [here](https://github.com/jruby/jcodings/blob/jcodings-1.0.58/src/org/jcodings/Config.java)
12071204
- ask for approval to upgrade the third-party component (example Jira ticket: GR-43593)
12081205
- upgrade the library ([example PR](https://github.com/oracle/truffleruby/pull/2930))
12091206
- Ruby constants `UNICODE_VERSION` and `UNICODE_EMOJI_VERSION` should have a proper value now
@@ -1531,8 +1528,7 @@ jt retag <path-to-MRI-test-file>
15311528
If you need to skip the whole file with MRI tests - it should be added
15321529
to `test/mri/failing.exclude` file.
15331530
1534-
More details are explained in the MRI Tests Guide
1535-
(<https://github.com/oracle/truffleruby/blob/master/doc/contributor/mri-tests.md>).
1531+
More details are explained in the [MRI Tests Guide](mri-tests.md).
15361532
15371533
## How to tag slow ruby/spec tests
15381534

0 commit comments

Comments
 (0)