Skip to content

Commit ef416f2

Browse files
committed
Some improvements
1 parent a5b947b commit ef416f2

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,9 @@ We encourage new contributors to join our communication channels and introduce t
3131
To run specific tests, use appropriate flags such as:
3232
- `./y.sh test --test-libcore`
3333
- `./y.sh test --std-tests`
34+
- `cargo test -- <name of test>`
3435

35-
Additional test running options:
36+
Additionally, you can run the tests of `libgccjit`:
3637
```bash
3738
# libgccjit tests
3839
cd gcc-build/gcc
@@ -48,14 +49,14 @@ The project provides several environment variables for debugging:
4849
- `CG_GCCJIT_DUMP_MODULE`: Dumps a specific module
4950
- `CG_GCCJIT_DUMP_TO_FILE`: Creates C-like representation
5051

51-
Full list of debugging options can be found in the README.
52+
Full list of debugging options can be found in the [README](/rust-lang/rustc_codegen_gcc#env-vars).
5253

5354
## Making Contributions
5455

5556
### Finding Issues to Work On
56-
1. Look for issues labeled with `good-first-issue` or `help-wanted`
57+
1. Look for issues labeled with `good first issue` or `help wanted`
5758
2. Check the [progress report](https://blog.antoyo.xyz/rustc_codegen_gcc-progress-report-34#state_of_rustc_codegen_gcc) for larger initiatives
58-
3. Consider improving documentation or investigate [failing tests](https://github.com/rust-lang/rustc_codegen_gcc/tree/master/tests)(except failing-ui-tests12.txt)
59+
3. Consider improving documentation or investigating [failing tests](https://github.com/rust-lang/rustc_codegen_gcc/tree/master/tests)(except failing-ui-tests12.txt)
5960

6061
### Pull Request Process
6162
1. Fork the repository and create a new branch

Readme.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ A secondary goal is to check if using the gcc backend will provide any run-time
1515
## Getting Started
1616

1717
Note: **This requires a patched libgccjit in order to work.
18-
You need to use my [fork of gcc](https://github.com/antoyo/gcc) which already includes these patches.**
18+
You need to use my [fork of gcc](https://github.com/rust-lang/gcc) which already includes these patches.**
19+
The default configuration (see below in the [Quick start](#quick-start) section) will download a pre-built `libgccjit` that already contains these patches, so you don't need to build this fork yourself if you use the default configuration.
1920

2021
### Dependencies
2122
- rustup: follow instructions on the [official website](https://rustup.rs)
@@ -53,7 +54,7 @@ to do a few more things.
5354
To build it (most of these instructions come from [here](https://gcc.gnu.org/onlinedocs/jit/internals/index.html), so don't hesitate to take a look there if you encounter an issue):
5455

5556
```bash
56-
$ git clone https://github.com/antoyo/gcc
57+
$ git clone https://github.com/rust-lang/gcc
5758
$ sudo apt install flex libmpfr-dev libgmp-dev libmpc3 libmpc-dev
5859
$ mkdir gcc-build gcc-install
5960
$ cd gcc-build

0 commit comments

Comments
 (0)