Skip to content
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

Merged
merged 2 commits into from
Aug 1, 2024

Conversation

knelli2
Copy link
Contributor

@knelli2 knelli2 commented Jul 20, 2024

Proposed changes

And also move them under Installation instead of the Developers Guide.

Upgrade instructions

Code review checklist

  • The code is documented and the documentation renders correctly. Run
    make doc to generate the documentation locally into BUILD_DIR/docs/html.
    Then open index.html.
  • The code follows the stylistic and code quality guidelines listed in the
    code review guide.
  • The PR lists upgrade instructions and is labeled bugfix or
    new feature if appropriate.

Further comments

Depends on #6164

@knelli2 knelli2 added documentation dependent Needs a different PR to be merged in first labels Jul 20, 2024
@@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

page

@knelli2 knelli2 added priority critical for progress and removed dependent Needs a different PR to be merged in first labels Jul 30, 2024
@knelli2
Copy link
Contributor Author

knelli2 commented Jul 30, 2024

Marking priority because this should be merged before the workshop

@knelli2
Copy link
Contributor Author

knelli2 commented Jul 31, 2024

@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):
Copy link
Member

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)

`src/PATH/DIR/CMakeLists.txt` and add `FILE.cpp` to the list of files
in
```
set(LIBRARY_SOURCES
Copy link
Member

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

prepend the parent directory to `DIR`.
- Add the lines
```
set(LIBRARY_SOURCES
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see above

@knelli2
Copy link
Contributor Author

knelli2 commented Aug 1, 2024

@kidder posted a fixup since I edited a couple more things

Copy link
Member

@kidder kidder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, squash

@kidder kidder enabled auto-merge August 1, 2024 03:54
@kidder kidder merged commit 8c0ee0e into sxs-collaboration:develop Aug 1, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation priority critical for progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants