Skip to content

Commit 4ac3c87

Browse files
committed
docs: add docs for .cpprc
1 parent f052b75 commit 4ac3c87

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,11 @@ sudo ./setup_cpp_mac --compiler llvm --cmake true --ninja true --ccache true --v
8282
source ~/.cpprc # activate cpp enviroment variables
8383
```
8484

85-
NOTE: In the `compiler` entry, you can specify the version after `-` like `llvm-11.0.0`.
86-
For the tools, instead of `true` that chooses the default version, you can pass a specific version.
85+
NOTE: In the `compiler` entry, you can specify the version after `-` like `llvm-11.0.0`. For the tools, you can pass a specific version instead of `true` that chooses the default version
8786

88-
NOTE: you will not need `sudo` if you are already a root user (e.g., in a GitLab runner).
87+
NOTE: On Unix systems, when `setup-cpp` is used locally or in other CI services like GitLab, the environment variables are added to `~/.cpprc`. You should run `source ~/.cpprc` to immediately activate the environment variables. This file is automatically sourced in the next shell restart from `~/.bashrc` or `~/.profile` if `SOURCE_CPPRC` is not set to `0`.
88+
89+
NOTE: On Unix systems, you will not need `sudo` if you are already a root user (e.g., in a GitLab runner or Docker).
8990

9091
### With Nodejs
9192

src/main.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -227,12 +227,12 @@ export async function main(args: string[]): Promise<number> {
227227
if (!isGitHubCI()) {
228228
switch (process.platform) {
229229
case "win32": {
230-
core.info("Run `RefreshEnv.cmd` or restart your shell to update the environment.")
230+
warning("Run `RefreshEnv.cmd` or restart your shell to update the environment.")
231231
break
232232
}
233233
case "linux":
234234
case "darwin": {
235-
core.info("Run `source ~/.cpprc` or restart your shell to update the environment.")
235+
warning("Run `source ~/.cpprc` or restart your shell to update the environment.")
236236
break
237237
}
238238
default: {

0 commit comments

Comments
 (0)