diff options
| author | Antoni Boucher <bouanto@zoho.com> | 2025-04-29 18:12:08 -0400 |
|---|---|---|
| committer | Antoni Boucher <bouanto@zoho.com> | 2025-04-29 18:21:04 -0400 |
| commit | f150171b6cc6b1e8393fd9b057accb6b5ea0f093 (patch) | |
| tree | e177b6de806d6ec50593b88b352c14b979e01736 | |
| parent | a5b947ba1cba06bbd08f4d5c83aac1dba1dd37ca (diff) | |
| download | rust-f150171b6cc6b1e8393fd9b057accb6b5ea0f093.tar.gz rust-f150171b6cc6b1e8393fd9b057accb6b5ea0f093.zip | |
Some improvements
| -rw-r--r-- | CONTRIBUTING.md | 21 | ||||
| -rw-r--r-- | Readme.md | 5 |
2 files changed, 14 insertions, 12 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 85ddb6c8f46..1bfa6e435db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,8 +31,9 @@ We encourage new contributors to join our communication channels and introduce t To run specific tests, use appropriate flags such as: - `./y.sh test --test-libcore` - `./y.sh test --std-tests` +- `cargo test -- <name of test>` -Additional test running options: +Additionally, you can run the tests of `libgccjit`: ```bash # libgccjit tests cd gcc-build/gcc @@ -48,14 +49,14 @@ The project provides several environment variables for debugging: - `CG_GCCJIT_DUMP_MODULE`: Dumps a specific module - `CG_GCCJIT_DUMP_TO_FILE`: Creates C-like representation -Full list of debugging options can be found in the README. +Full list of debugging options can be found in the [README](/rust-lang/rustc_codegen_gcc#env-vars). ## Making Contributions ### Finding Issues to Work On -1. Look for issues labeled with `good-first-issue` or `help-wanted` +1. Look for issues labeled with [`good first issue`](/rust-lang/rustc_codegen_gcc/issues?q=is%3Aissue state%3Aopen label%3A"good first issue") or [`help wanted`](/rust-lang/rustc_codegen_gcc/issues?q=is%3Aissue state%3Aopen label%3A"help wanted") 2. Check the [progress report](https://blog.antoyo.xyz/rustc_codegen_gcc-progress-report-34#state_of_rustc_codegen_gcc) for larger initiatives -3. Consider improving documentation or investigate [failing tests](https://github.com/rust-lang/rustc_codegen_gcc/tree/master/tests)(except failing-ui-tests12.txt) +3. Consider improving documentation or investigating [failing tests](https://github.com/rust-lang/rustc_codegen_gcc/tree/master/tests)(except `failing-ui-tests12.txt`) ### Pull Request Process 1. Fork the repository and create a new branch @@ -74,12 +75,12 @@ Full list of debugging options can be found in the README. - [Rustc Dev Guide](https://rustc-dev-guide.rust-lang.org/) - [GCC Internals Documentation](https://gcc.gnu.org/onlinedocs/gccint/) - Project-specific documentation in the `doc/` directory: - - [Common errors](./doc/errors.md) - - [Debugging GCC LTO](./doc/debugging-gcc-lto.md) - - [Debugging libgccjit](./doc/debugging-libgccjit.md) - - [Git subtree sync](./doc/subtree.md) - - [List of useful commands](./doc/tips.md) - - [Send a patch to GCC](./doc/sending-gcc-patch.md) + - [Common errors](/rust-lang/rustc_codegen_gcc/blob/master/doc/errors.md) + - [Debugging](/rust-lang/rustc_codegen_gcc/blob/master/doc/debugging.md) + - [Debugging libgccjit](/rust-lang/rustc_codegen_gcc/blob/master/doc/debugging-libgccjit.md) + - [Git subtree sync](/rust-lang/rustc_codegen_gcc/blob/master/doc/subtree.md) + - [List of useful commands](/rust-lang/rustc_codegen_gcc/blob/master/doc/tips.md) + - [Send a patch to GCC](/rust-lang/rustc_codegen_gcc/blob/master/doc/sending-gcc-patch.md) ## Getting Help diff --git a/Readme.md b/Readme.md index 89e7e24bd32..10f9a85d72a 100644 --- a/Readme.md +++ b/Readme.md @@ -15,7 +15,8 @@ A secondary goal is to check if using the gcc backend will provide any run-time ## Getting Started Note: **This requires a patched libgccjit in order to work. -You need to use my [fork of gcc](https://github.com/antoyo/gcc) which already includes these patches.** +You need to use my [fork of gcc](https://github.com/rust-lang/gcc) which already includes these patches.** +The default configuration (see below in the [Quick start](#quick-start) section) will download a `libgccjit` built in the CI that already contains these patches, so you don't need to build this fork yourself if you use the default configuration. ### Dependencies - rustup: follow instructions on the [official website](https://rustup.rs) @@ -53,7 +54,7 @@ to do a few more things. 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): ```bash -$ git clone https://github.com/antoyo/gcc +$ git clone https://github.com/rust-lang/gcc $ sudo apt install flex libmpfr-dev libgmp-dev libmpc3 libmpc-dev $ mkdir gcc-build gcc-install $ cd gcc-build |
