Summarize build toolchain workflow and implied rules #360
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
jvdp1
reviewed
Mar 23, 2021
Co-authored-by: Jeremie Vandenplas <jeremie.vandenplas@gmail.com>
LKedward
approved these changes
Apr 17, 2021
|
Thanks for the feedback. I'll go ahead and merge. |
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.
This patch will be part of a series of patches to improve the overall developer documentation.
The build tools are currently undocumented, this patch is an effort to summarize the developer workflow required to interact with the CMake and make build toolchains. It also attempts to summarize the implied rules for those toolchains by inspection of the build files, the commit history and the issue tracker. This process is not perfect due missing internal knowledge of almost a year on those files and might have resulted in a wrong perception on some of the implied rules. Feedback of previous contributors to those files is welcome.
Related to #351