Skip to content

Commit

Permalink
[doc] Update build help
Browse files Browse the repository at this point in the history
And update links
  • Loading branch information
Andy C committed Jan 23, 2025
1 parent 2fb19e9 commit daa4496
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
10 changes: 6 additions & 4 deletions build/oils-preamble.sh
Original file line number Diff line number Diff line change
Expand Up @@ -50,17 +50,19 @@ Compile/link flags:
LDFLAGS= [default ''] (defined in build/ninja-rules-cpp.sh)
Space-separated list of more linker flags
Compiler flags come from 4 sources:
Compiler flags come from these sources:
1. The $BASE_CXXFLAGS var
2. -I $REPO_ROOT is hard-coded
3. The build --variant, e.g. 'asan' adds -fsanitizer=address and more
4. The $CXXFLAGS var
4. Flags detected by ./configure, e.g. for GNU readline
5. The $CXXFLAGS var
Linker flags come from 3 sources:
Linker flags come from tehse sources:
1. The build --variant, e.g. 'asan' adds -fsanitizer=address
2. $STRIP_FLAGS, a variable detected by ./configure
2. Flags detected by ./configure, like $STRIP_FLAGS and -lreadline for GNU
readline
3. The $LDFLAGS var
EOF
Expand Down
2 changes: 1 addition & 1 deletion doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ See [Published Docs](published.html) for those that are ready to read.

- [INSTALL](INSTALL.html). How do I install Oils? This text file is also in
the `oils-for-unix` tarball.
- [Oils Help Mirror](help-mirror.html)
- [Oils Build `--help` Mirror](help-mirror.html)
- [Portability](portability.html)
- [Getting Started](getting-started.html). How do I use the shell?

Expand Down
2 changes: 1 addition & 1 deletion doc/published.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Build/packaging:

- [INSTALL](INSTALL.html). How do I install Oils? This text file is also in
the `oils-for-unix` tarball.
- [Oils Help Mirror](help-mirror.html)
- [Oils Build `--help` Mirror](help-mirror.html)
- [Portability](portability.html)

[help]: ref/chap-builtin-cmd.html#help
Expand Down

0 comments on commit daa4496

Please sign in to comment.