Skip to content

Commit 4a8aa6e

Browse files
committed
Tweak for page flow/readability
1 parent cf5d6d9 commit 4a8aa6e

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

docs/install.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,18 @@ from inside the library. See the [required build
8888
configuration](./discussion/concepts/compiler_warnings.md#required-build-configuration) for the full
8989
explanation.
9090

91+
!!! note "Help us keep this advice accurate"
92+
We've tested the guidance below where we can. The bazel and CMake instructions were checked by
93+
building a real client project against Au, with both gcc and clang. Other parts rest on
94+
documented behavior that we can't easily exercise: notably MSVC's `/external:I`, and the conan and
95+
vcpkg packages, which are [community maintained](#package-managers-conan-vcpkg). Build systems
96+
also change their defaults over time, and this page won't always notice.
97+
98+
So treat it as our best current understanding rather than a guarantee. If you follow it and Au
99+
still adds or subtracts a warning relative to the equivalent raw-number code, please [file an
100+
issue](https://github.com/aurora-opensource/au/issues/new). It's either a bug in Au, or a gap in
101+
these instructions --- and we want to fix both.
102+
91103
Here's what to check for each installation method.
92104

93105
=== "bazel"
@@ -167,17 +179,6 @@ Here's what to check for each installation method.
167179
`-isystem` (or `/external:I`). If you keep it in, say, `third_party/`, and your build treats
168180
that whole folder as external, consider putting Au somewhere else.
169181

170-
!!! note "Help us keep this advice accurate"
171-
We've tested this guidance where we can. The bazel and CMake instructions above were checked by
172-
building a real client project against Au, with both gcc and clang. Other parts rest on
173-
documented behavior that we can't easily exercise: notably MSVC's `/external:I`, and the conan and
174-
vcpkg packages, which are [community maintained](#package-managers-conan-vcpkg). Build systems
175-
also change their defaults over time, and this page won't always notice.
176-
177-
So treat this section as our best current understanding rather than a guarantee. If you follow it
178-
and Au still adds or subtracts a warning relative to the equivalent raw-number code, please [file
179-
an issue](https://github.com/aurora-opensource/au/issues/new). It's either a bug in Au, or a gap
180-
in these instructions --- and we want to fix both.
181182

182183
## Installation instructions
183184

0 commit comments

Comments
 (0)