document combination of flags #756
Conversation
|
Fixes #646 |
Good points :), thanks! |
|
|
||
| | Command | Backend Profile | Sysroot Profile | Usage Scenario | | ||
| |--------------------------------------------|-------------------------------|----------------------------------|------------------------------------------------------------| | ||
| | `./y.sh build` | dev (optimized + debuginfo) | X | Build backend in dev. mode with optimized dependencies without rebuilding sysroot | |
There was a problem hiding this comment.
Could you please remove the . (dot) at the end of dev. here and in other places? I find it a bit confusing.
|
|
||
| | Command | Backend Profile | Sysroot Profile | Usage Scenario | | ||
| |--------------------------------------------|-------------------------------|----------------------------------|------------------------------------------------------------| | ||
| | `./y.sh build` | dev (optimized + debuginfo) | X | Build backend in dev. mode with optimized dependencies without rebuilding sysroot | |
There was a problem hiding this comment.
Did you write "dev (optimized + debuginfo)" because this is what cargo shows and does it show it because the dependencies are compiled in release mode?
I wonder if this will cause confusion to people: what do you think?
Perhaps we should only write "dev"?
There was a problem hiding this comment.
Another idea could be to specify in a footnote that only the dependencies are compiled with optimizations.
| `build` command help: | ||
| --sysroot : Build with sysroot"# | ||
| --release : Build backend in release mode with optimized dependencies without rebuilding sysroot |
There was a problem hiding this comment.
I would remove the end since this could rebuild the sysroot if --sysroot is specified:
| --release : Build backend in release mode with optimized dependencies without rebuilding sysroot | |
| --release : Build backend in release mode with optimized dependencies |
| build the sysroot in release mode with optimized dependencies instead of in dev. mode | ||
| --release-sysroot : When combined with --sysroot, additionally | ||
| build the sysroot in release mode with optimized dependencies. | ||
| When combined with --release, it has no effect. |
There was a problem hiding this comment.
I would either remove this line completely or rephrase to:
| When combined with --release, it has no effect. | |
| It has no effect if `--sysroot` is not specified. |
| `build` command help: | ||
| --sysroot : Build with sysroot"# | ||
| --release : Build backend in release mode with optimized dependencies without rebuilding sysroot |
There was a problem hiding this comment.
This flag can also be used for ./y.sh test, so please move it back to config.rs.
| --sysroot : Build with sysroot"# | ||
| --release : Build backend in release mode with optimized dependencies without rebuilding sysroot | ||
| --sysroot : When used on its own, build backend in dev. mode with optimized dependencies |
There was a problem hiding this comment.
The flag --sysroot-panic-abort should also be documented here instead of in config.rs.
|
|
||
|
|
There was a problem hiding this comment.
Please merge these 2 empty lines into one:
2 participants
-Documented in CONTRIBUTING.md the role of sysroot and the meaning of different flags combination used in frontend script y.sh
-Updated help output for binary file y (build_system/target/release/y build --help)