Edit make-all.sh user guide #275
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ffoulkes
requested review from
nupuruttarwar,
n-sandeep,
vsureshkumarp and
5abeel
as code owners
5abeel
reviewed
Sep 11, 2023
docs/scripts/make-all.rst
Outdated
| @@ -147,6 +147,10 @@ Configurations | |||
| Build with ``-DCMAKE_BUILD_TYPE=Release``. | |||
| The compiler settings will default to ``-O3 -DNDEBUG``. | |||
|
|
|||
| If no configuration is specified, the CMake listfile will default to | |||
| ``RelWithDebInfo``. | |||
| This will probably be changed to ``Release`` in a future release. | |||
There was a problem hiding this comment.
Dont think we need this that something "will probably be changed to".
This can be updated when we change the default
There was a problem hiding this comment.
Actually, I think we should make a point of telling people in advance that we expect something to change.
Especially when we do such a poor job of telling people after we've made the change.
But I can water this down to saying that we "currently" default to RelWithDebInfo.
ffoulkes
force-pushed
the
edit-make-all-doc
branch
from
2c2818a to
91e1dc4
Compare
- Document what the default build type is if no configuration is specified. - Replace ® with the UTF-8 symbol. RST doesn't render html character entities. (sigh) Signed-off-by: Derek G Foster <[email protected]>
- Add flow diagram. - Remove reference to IPU E2100. Signed-off-by: Derek G Foster <[email protected]>
Signed-off-by: Derek G Foster <[email protected]>
Signed-off-by: Derek G Foster <[email protected]>
ffoulkes
force-pushed
the
edit-make-all-doc
branch
from
1b21fef to
10d885c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document what the default build type is if no configuration is specified.
Replace ® with the UTF-8 symbol. RST doesn't render html character entities. (sigh)