search

rust-lang / rustc_codegen_gcc

libgccjit AOT codegen for rustc
Apache License 2.0
913 stars 60 forks source link

Clean up the "Env vars" section of the Readme #522

Closed antoyo closed 4 months ago

antoyo commented 4 months ago

The env var section mentions some environment variables that do not exist like CG_GCCJIT_INCR_CACHE_DISABLED and does not mention variables that exist like CG_GCCJIT_DUMP_ALL_MODULES.

Gerson2102 commented 4 months ago

Please assign this to me @antoyo

antoyo commented 4 months ago

Done.

Gerson2102 commented 4 months ago

Is there some docs that i can look to see if there is more env vars to include and to see what they are doing to put it in the readme?

antoyo commented 4 months ago

No, the issue is to write this doc. You can look in the code for usage of env::var. Usually, the variables we want to document starts with CG_GCCJIT_, but please ask if you're not sure.

Gerson2102 commented 4 months ago

What about these: std::env::var("GITHUB_ACTIONS"), std::env::var("PATH"), env::var("RUST_BACKTRACE")?

antoyo commented 4 months ago

Please do not add those in the doc.

antoyo commented 4 months ago

Fixed by #523.