-
Notifications
You must be signed in to change notification settings - Fork 191
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Reorganize build system docs #6171
Reorganize build system docs #6171
Conversation
docs/Installation/Installation.md
Outdated
@@ -7,7 +7,8 @@ See LICENSE.txt for details. | |||
\tableofcontents | |||
|
|||
This page details the installation procedure for SpECTRE on personal computers | |||
using x86-64 processors. For instructions on installing SpECTRE on clusters | |||
using x86-64 processors. For configuring SpECTRE, please refer to the \subpage | |||
spectre_build_system pag. For instructions on installing SpECTRE on clusters |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
page
120ea8e
to
9b36622
Compare
9b36622
to
91e54bc
Compare
Marking priority because this should be merged before the workshop |
@kidder could you take a look at this again? |
cmake -D FLAG1=OPT1 ... -D FLAGN=OPTN <SPECTRE_ROOT> | ||
``` | ||
The following are common flags used to control building SpECTRE with CMake (in | ||
alphabetical order): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
while you're touching the file, alphabetize the list (BUILD_DOCS, DOCS_ONLY, the CMAKE_*, SPECTRE_DEBUG)
docs/Installation/BuildSystem.md
Outdated
`src/PATH/DIR/CMakeLists.txt` and add `FILE.cpp` to the list of files | ||
in | ||
``` | ||
set(LIBRARY_SOURCES |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is not true anymore. we have spectre_target_sources
and spectre_target_headers
docs/Installation/BuildSystem.md
Outdated
prepend the parent directory to `DIR`. | ||
- Add the lines | ||
``` | ||
set(LIBRARY_SOURCES |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see above
@kidder posted a fixup since I edited a couple more things |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good, squash
dee9cce
to
dd2566e
Compare
Proposed changes
And also move them under
Installation
instead of theDevelopers Guide
.Upgrade instructions
Code review checklist
make doc
to generate the documentation locally intoBUILD_DIR/docs/html
.Then open
index.html
.code review guide.
bugfix
ornew feature
if appropriate.Further comments
Depends on #6164