Release: 7.2.0 sync main with develop

.cmake-format.py

@@ -0,0 +1,331 @@
+# ----------------------------------
+# Options affecting listfile parsing
+# ----------------------------------
+with section("parse"):
+
+  # Specify structure for custom cmake functions
+  additional_commands = {
+    'add_prefix': {'pargs': {'nargs': 2}},
+    'add_suffix': {'pargs': {'nargs': 2}},
+    'append_static_suffix': {'pargs': {'nargs': 2}},
+    'examples2string': {'pargs': {'nargs': 2}},
+    'force_variable': {'pargs': {'nargs': 4}},
+    'list2string': {'pargs': {'nargs': 2}},
+    'sundials_add_benchmark': { 'kwargs': { 'BENCHMARK_ARGS': 1,
+                                            'IDENTIFIER': 1,
+                                            'NUM_CORES': 1,
+                                            'TEST_RUNNER_ARGS': '+'},
+                                'pargs': { 'flags': ['ENABLE_GPU'],
+                                           'nargs': '3+'}},
+    'sundials_add_examples_ginkgo': { 'kwargs': {'BACKENDS': '+', 'TARGETS': '+'},
+                                      'pargs': { 'flags': ['UNIT_TEST'],
+                                                 'nargs': '1+'}},
+    'sundials_add_f2003_library': { 'kwargs': { 'COMPILE_DEFINITIONS': '+',
+                                                'COMPILE_OPTIONS': '+',
+                                                'INCLUDE_DIRECTORIES': '+',
+                                                'LINK_LIBRARIES': '+',
+                                                'OBJECT_LIBRARIES': '+',
+                                                'OUTPUT_NAME': 1,
+                                                'PROPERTIES': '+',
+                                                'SOURCES': '+',
+                                                'SOVERSION': 1,
+                                                'VERSION': 1},
+                                    'pargs': {'flags': [], 'nargs': '1+'}},
+    'sundials_add_library': { 'kwargs': { 'COMPILE_DEFINITIONS': '+',
+                                          'COMPILE_FEATURES': '+',
+                                          'COMPILE_OPTIONS': '+',
+                                          'HEADERS': '+',
+                                          'INCLUDE_DIRECTORIES': '+',
+                                          'INCLUDE_SUBDIR': 1,
+                                          'LINK_LIBRARIES': '+',
+                                          'OBJECT_LIBRARIES': '+',
+                                          'OUTPUT_NAME': 1,
+                                          'PROPERTIES': '+',
+                                          'SOURCES': '+',
+                                          'SOVERSION': 1,
+                                          'VERSION': 1},
+                              'pargs': { 'flags': [ 'STATIC_ONLY',
+                                                    'SHARED_ONLY',
+                                                    'OBJECT_LIB_ONLY'],
+                                         'nargs': '1+'}},
+    'sundials_add_nvector_benchmark': { 'kwargs': { 'INSTALL_SUBDIR': '+',
+                                                    'LINK_LIBRARIES': '+',
+                                                    'SOURCES': '+',
+                                                    'SUNDIALS_TARGETS': '+'},
+                                        'pargs': {'flags': [], 'nargs': '1+'}},
+    'sundials_add_test': { 'kwargs': { 'ANSWER_DIR': 1,
+                                       'ANSWER_FILE': 1,
+                                       'EXAMPLE_TYPE': 1,
+                                       'EXTRA_ARGS': '+',
+                                       'FLOAT_PRECISION': 1,
+                                       'INTEGER_PRECISION': 1,
+                                       'LABELS': '+',
+                                       'MPI_NPROCS': 1,
+                                       'TEST_ARGS': '+'},
+                           'pargs': {'flags': ['NODIFF'], 'nargs': '2+'}},
+    'sundials_add_test_install': { 'kwargs': {'EXECUTABLE': 1},
+                                   'pargs': {'flags': [], 'nargs': '2+'}},
+    'sundials_git_version': {'pargs': {'nargs': 0}},
+    'sundials_install_examples': { 'kwargs': { 'CMAKE_TEMPLATE': 1,
+                                               'DESTINATION': 1,
+                                               'EXAMPLES_DEPENDENCIES': '+',
+                                               'EXTRA_FILES': '+',
+                                               'EXTRA_INCLUDES': '+',
+                                               'MAKE_TEMPLATE': 1,
+                                               'OTHER_TARGETS': '+',
+                                               'SOLVER_LIBRARY': 1,
+                                               'SUNDIALS_COMPONENTS': '+',
+                                               'SUNDIALS_TARGETS': '+',
+                                               'TEST_INSTALL': 1},
+                                   'pargs': {'flags': [], 'nargs': '2+'}},
+    'sundials_install_examples_ginkgo': { 'kwargs': { 'CPU_EXAMPLES_VAR': '+',
+                                                      'CPU_GPU_EXAMPLES_VAR': '+',
+                                                      'DEPENDENCIES': '+',
+                                                      'DESTINATION': 1,
+                                                      'EXTRA_FILES': '+',
+                                                      'GPU_EXAMPLES_VAR': '+',
+                                                      'SUNDIALS_COMPONENTS': '+',
+                                                      'SUNDIALS_TARGETS': '+'},
+                                          'pargs': {'flags': [], 'nargs': '1+'}},
+    'sundials_option': { 'kwargs': {'DEPENDS_ON': '+', 'OPTIONS': '+'},
+                         'pargs': { 'flags': [ 'DEPENDS_ON_THROW_ERROR',
+                                               'ADVANCED'],
+                                    'nargs': '4+'}},
+    'sundials_trycompile_execute': { 'kwargs': { 'COMPILE_OUTPUT': 1,
+                                                 'RUN_OUTPUT': 1},
+                                     'pargs': {'flags': [], 'nargs': '4+'}},
+    'add_local_ci_target': {'pargs': {'nargs': 3}}
+  }
+
+  # Override configurations per-command where available
+  override_spec = {}
+
+  # Specify variable tags.
+  vartags = []
+
+  # Specify property tags.
+  proptags = []
+
+# -----------------------------
+# Options affecting formatting.
+# -----------------------------
+with section("format"):
+
+  # Disable formatting entirely, making cmake-format a no-op
+  disable = False
+
+  # How wide to allow formatted cmake files
+  line_width = 80
+
+  # How many spaces to tab for indent
+  tab_size = 2
+
+  # If true, lines are indented using tab characters (utf-8 0x09) instead of
+  # <tab_size> space characters (utf-8 0x20). In cases where the layout would
+  # require a fractional tab character, the behavior of the  fractional
+  # indentation is governed by <fractional_tab_policy>
+  use_tabchars = False
+
+  # If <use_tabchars> is True, then the value of this variable indicates how
+  # fractional indentions are handled during whitespace replacement. If set to
+  # 'use-space', fractional indentation is left as spaces (utf-8 0x20). If set
+  # to `round-up` fractional indentation is replaced with a single tab character
+  # (utf-8 0x09) effectively shifting the column to the next tabstop
+  fractional_tab_policy = 'use-space'
+
+  # If an argument group contains more than this many sub-groups (parg or kwarg
+  # groups) then force it to a vertical layout.
+  max_subgroups_hwrap = 2
+
+  # If a positional argument group contains more than this many arguments, then
+  # force it to a vertical layout.
+  max_pargs_hwrap = 6
+
+  # If a cmdline positional group consumes more than this many lines without
+  # nesting, then invalidate the layout (and nest)
+  max_rows_cmdline = 2
+
+  # If true, separate flow control names from their parentheses with a space
+  separate_ctrl_name_with_space = False
+
+  # If true, separate function names from parentheses with a space
+  separate_fn_name_with_space = False
+
+  # If a statement is wrapped to more than one line, than dangle the closing
+  # parenthesis on its own line.
+  dangle_parens = False
+
+  # If the trailing parenthesis must be 'dangled' on its on line, then align it
+  # to this reference: `prefix`: the start of the statement,  `prefix-indent`:
+  # the start of the statement, plus one indentation  level, `child`: align to
+  # the column of the arguments
+  dangle_align = 'prefix'
+
+  # If the statement spelling length (including space and parenthesis) is
+  # smaller than this amount, then force reject nested layouts.
+  min_prefix_chars = 4
+
+  # If the statement spelling length (including space and parenthesis) is larger
+  # than the tab width by more than this amount, then force reject un-nested
+  # layouts.
+  max_prefix_chars = 10
+
+  # If a candidate layout is wrapped horizontally but it exceeds this many
+  # lines, then reject the layout.
+  max_lines_hwrap = 2
+
+  # What style line endings to use in the output.
+  line_ending = 'unix'
+
+  # Format command names consistently as 'lower' or 'upper' case
+  command_case = 'canonical'
+
+  # Format keywords consistently as 'lower' or 'upper' case
+  keyword_case = 'unchanged'
+
+  # A list of command names which should always be wrapped
+  always_wrap = []
+
+  # If true, the argument lists which are known to be sortable will be sorted
+  # lexicographicall
+  enable_sort = True
+
+  # If true, the parsers may infer whether or not an argument list is sortable
+  # (without annotation).
+  autosort = False
+
+  # By default, if cmake-format cannot successfully fit everything into the
+  # desired linewidth it will apply the last, most agressive attempt that it
+  # made. If this flag is True, however, cmake-format will print error, exit
+  # with non-zero status code, and write-out nothing
+  require_valid_layout = False
+
+  # A dictionary mapping layout nodes to a list of wrap decisions. See the
+  # documentation for more information.
+  layout_passes = {}
+
+# ------------------------------------------------
+# Options affecting comment reflow and formatting.
+# ------------------------------------------------
+with section("markup"):
+
+  # What character to use for bulleted lists
+  bullet_char = '*'
+
+  # What character to use as punctuation after numerals in an enumerated list
+  enum_char = '.'
+
+  # If comment markup is enabled, don't reflow the first comment block in each
+  # listfile. Use this to preserve formatting of your copyright/license
+  # statements.
+  first_comment_is_literal = True
+
+  # If comment markup is enabled, don't reflow any comment block which matches
+  # this (regex) pattern. Default is `None` (disabled).
+  literal_comment_pattern = None
+
+  # Regular expression to match preformat fences in comments default=
+  # ``r'^\s*([`~]{3}[`~]*)(.*)$'``
+  fence_pattern = '^\\s*([`~]{3}[`~]*)(.*)$'
+
+  # Regular expression to match rulers in comments default=
+  # ``r'^\s*[^\w\s]{3}.*[^\w\s]{3}$'``
+  ruler_pattern = '^\\s*[^\\w\\s]{3}.*[^\\w\\s]{3}$'
+
+  # If a comment line matches starts with this pattern then it is explicitly a
+  # trailing comment for the preceeding argument. Default is '#<'
+  explicit_trailing_pattern = '#<'
+
+  # If a comment line starts with at least this many consecutive hash
+  # characters, then don't lstrip() them off. This allows for lazy hash rulers
+  # where the first hash char is not separated by space
+  hashruler_min_length = 10
+
+  # If true, then insert a space between the first hash char and remaining hash
+  # chars in a hash ruler, and normalize its length to fill the column
+  canonicalize_hashrulers = True
+
+  # enable comment markup parsing and reflow
+  enable_markup = True
+
+# ----------------------------
+# Options affecting the linter
+# ----------------------------
+with section("lint"):
+
+  # a list of lint codes to disable
+  disabled_codes = []
+
+  # regular expression pattern describing valid function names
+  function_pattern = '[0-9a-z_]+'
+
+  # regular expression pattern describing valid macro names
+  macro_pattern = '[0-9A-Z_]+'
+
+  # regular expression pattern describing valid names for variables with global
+  # (cache) scope
+  global_var_pattern = '[A-Z][0-9A-Z_]+'
+
+  # regular expression pattern describing valid names for variables with global
+  # scope (but internal semantic)
+  internal_var_pattern = '_[A-Z][0-9A-Z_]+'
+
+  # regular expression pattern describing valid names for variables with local
+  # scope
+  local_var_pattern = '[a-z][a-z0-9_]+'
+
+  # regular expression pattern describing valid names for privatedirectory
+  # variables
+  private_var_pattern = '_[0-9a-z_]+'
+
+  # regular expression pattern describing valid names for public directory
+  # variables
+  public_var_pattern = '[A-Z][0-9A-Z_]+'
+
+  # regular expression pattern describing valid names for function/macro
+  # arguments and loop variables.
+  argument_var_pattern = '[a-z][a-z0-9_]+'
+
+  # regular expression pattern describing valid names for keywords used in
+  # functions or macros
+  keyword_pattern = '[A-Z][0-9A-Z_]+'
+
+  # In the heuristic for C0201, how many conditionals to match within a loop in
+  # before considering the loop a parser.
+  max_conditionals_custom_parser = 2
+
+  # Require at least this many newlines between statements
+  min_statement_spacing = 1
+
+  # Require no more than this many newlines between statements
+  max_statement_spacing = 2
+  max_returns = 6
+  max_branches = 12
+  max_arguments = 5
+  max_localvars = 15
+  max_statements = 50
+
+# -------------------------------
+# Options affecting file encoding
+# -------------------------------
+with section("encode"):
+
+  # If true, emit the unicode byte-order mark (BOM) at the start of the file
+  emit_byteorder_mark = False
+
+  # Specify the encoding of the input file. Defaults to utf-8
+  input_encoding = 'utf-8'
+
+  # Specify the encoding of the output file. Defaults to utf-8. Note that cmake
+  # only claims to support utf-8 so be careful when using anything else
+  output_encoding = 'utf-8'
+
+# -------------------------------------
+# Miscellaneous configurations options.
+# -------------------------------------
+with section("misc"):
+
+  # A dictionary containing any per-command configuration overrides. Currently
+  # only `command_case` is supported.
+  per_command = {}
+

.git-blame-ignore-revs

@@ -4,3 +4,7 @@ fab1cecb7d91cff53b31730af5d00ff154c3b6ce
 cc6960349aa92e2bcad9168a6dacff99b21c329c
 # Apply formatting to Fortran files
 23581e8454955283139e551a7bcd1b85d8b7c77b
+# Apply formatting to Python files
+b578eabccd77b7642b04ddda9d8530f05890d1b4
+# Apply formatting to CMake files
+c6b9a02f24a27081c471d63dfc524684a9f5a9e3

.github/actions/apply-style/checkout.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+
+###
+# Attempt to find the branch of the PR from the detached head state
+##
+
+echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
+echo "Attempting to find branch that matches commit..."
+
+# Get the current commit SHA
+current_commit_sha=$(git rev-parse HEAD)
+# List all branches containing the current commit SHA
+branches=$(git branch -r --contains $current_commit_sha)
+
+echo "all branches:"
+echo "$(git branch -a)"
+echo "branches with SHA $current_commit_sha:"
+echo "$branches"
+
+# Loop over the string split by whitespace
+branch=""
+num_branches_found=0
+for _possible_branch in $branches; do
+  # Skip items that start with "pull/"
+  if [[ $_possible_branch == pull/* ]]; then
+    continue
+  fi
+  if [[ $_possible_branch == origin/* ]]; then
+    _possible_branch=$(echo "$_possible_branch" | sed 's/origin\///')
+  fi
+  echo "Possible Branch: $_possible_branch"
+  branch=$_possible_branch
+  num_branches_found=$((num_branches_found+1))
+done
+
+if [ "$num_branches_found" -ne 1 ]; then
+  echo "Error: Unable to find a single branch that matched git sha $current_commit_sha"
+  exit 1
+fi
+
+echo "Found branch: $branch"
+echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
+
+git checkout $branch
+git submodule update --init --recursive