Skip to content

Add make parameters target #6907

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.

Sign up for GitHub

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

Open
gassmoeller wants to merge 2 commits into
base: main
Choose a base branch
from
+22 −0
Open

Add make parameters target #6907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95be314
Add make parameters target
gassmoeller Mar 19, 2026
689869a
Add documentation
gassmoeller Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1052,6 +1052,14 @@ add_custom_target(indent
COMMENT "Indenting all ASPECT header and source files..."
)

# Provide "parameters" target for updating the parameter documentation
add_custom_target(parameters
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc
COMMAND ./update_parameters.sh ${CMAKE_BINARY_DIR}/aspect
DEPENDS ${TARGET_EXE}
COMMENT "Updating parameter documentation..."
)

# Provide "release" and "debug" targets to switch compile mode
if(CMAKE_GENERATOR MATCHES "Ninja")
set(_make_command "$ ninja")
Expand Down
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,20 @@ astyle --options=astyle.rc my_plugin.cc my_plugin.h
You NEED to use astyle version 2.04 for correct results (older versions or 2.05 will not work)!
:::

### Parameter documentation

We keep documentation about all ASPECT input parameters in our [parameter
documentation](https://aspect-documentation.readthedocs.io/en/latest/parameters/index.html).
If your pull request introduces new parameters or updates existing ones, our
automatic testers will notice and report the difference. You can update the
parameter documentation by either (i) run `make parameters` in your build
directory, check the modifications to the documentation and add the changes to
your pull request, or (ii) download the tester artifact
`changes-parameters.diff`, apply the changes to your local repository with `git
apply changes-parameters.diff`, and then add the changes to the pull request.
We insist on these changes to keep the online documentation always consistent
with the latest development version of ASPECT.

### Changelog entries

If your new pull request creates a change that is noticeable to ASPECT users,
Expand Down