Docs: bulk add backticks to .seealso man page fields

```python
import os
import re
import fileinput

def _process_word(word):
comma = "," if word.endswith(",") else ""
return "`%s`%s" % (wor

Docs: bulk add backticks to .seealso man page fields

```python
import os
import re
import fileinput

def _process_word(word):
comma = "," if word.endswith(",") else ""
return "`%s`%s" % (word.rstrip(","), comma)

def _process_stripped_line(line):
return " ".join(map(_process_word, line.split()))

start_pattern = re.compile(r"^( *\.seealso:? )(.*$)")

def process_file(filename_full):
with fileinput.FileInput(filename_full, inplace=True) as f:
in_block = False
for line in f:
line_stripped = line.strip()
# end ".seealso blocks" on a blank line or C-style comment close
line_modified = None
if not line_stripped:
in_block = False
elif line_stripped.endswith("*/"):
in_block = False
else:
match = re.match(start_pattern,
line) # not stripped line
if match:
indent = " " * len(match.group(1))
in_block = True
line_modified = match.group(
1) + _process_stripped_line(
match.group(2).strip())
elif in_block:
line_modified = indent + _process_stripped_line(
line_stripped)
if line_modified:
print(line_modified) # prints to the file
else:
print(line, end="") # prints to the file

BASE_DIRS = ["src", "include"]
EXT = [".c", ".cxx", ".cpp", ".cu", ".h", ".hpp", ".hxx"]
EXCLUDE_DIRS = ["tests", "tutorials", "ftn-auto", "ftn-custom", "benchmarks"]

def main():
""" Process everything """
for base in BASE_DIRS:
for root, dirs, files in os.walk(base):
for filename in files:
if os.path.splitext(filename)[1] in EXT:
filename_full = os.path.join(root, filename)
print("FILE ---", filename_full)
process_file(filename_full)
for exclude_dir in EXCLUDE_DIRS:
if exclude_dir in dirs:
dirs.remove(exclude_dir)

if __name__ == "__main__":
main()
```

show more ...

Merge branch 'jolivet/feature-less-checkfalse' into 'main'

Dividing by four the number of PetscCheckFalse()

See merge request petsc/petsc!5072

Remove some PetscCheckFalse()

Merge branch 'jacobf/2022-03-26/variadic-chkerrq-stragglers' into 'main'

Clean Up Variadic-CHKERRQ Stragglers

See merge request petsc/petsc!5033

fixup some remaining stragglers from !4889

Merge branch 'jacobf/2022-02-23/variadic-chkerr' into 'main'

Variadic CHKERRQ()

See merge request petsc/petsc!4889

The great renaming:

- CHKERRQ() -> PetscCall()
- CHKERRV() -> PetscCallVoid()
- CHKERRMPI() -> PetscCallMPI()
- CHKERRABORT() -> PetscCallAbort()
- CHKERRCONTINUE() -> PetscCallContinue()
- CHKERRXX

The great renaming:

- CHKERRQ() -> PetscCall()
- CHKERRV() -> PetscCallVoid()
- CHKERRMPI() -> PetscCallMPI()
- CHKERRABORT() -> PetscCallAbort()
- CHKERRCONTINUE() -> PetscCallContinue()
- CHKERRXX() -> PetscCallThrow()
- CHKERRCXX() -> PetscCallCXX()
- CHKERRCUDA() -> PetscCallCUDA()
- CHKERRCUBLAS() -> PetscCallCUBLAS()
- CHKERRCUSPARSE() -> PetscCallCUSPARSE()
- CHKERRCUSOLVER() -> PetscCallCUSOLVER()
- CHKERRCUFFT() -> PetscCallCUFFT()
- CHKERRCURAND() -> PetscCallCURAND()
- CHKERRHIP() -> PetscCallHIP()
- CHKERRHIPBLAS() -> PetscCallHIPBLAS()
- CHKERRHIPSOLVER() -> PetscCallHIPSOLVER()
- CHKERRQ_CEED() -> PetscCallCEED()
- CHKERR_FORTRAN_VOID_FUNCTION() -> PetscCallFortranVoidFunction()
- CHKERRMKL() -> PetscCallMKL()
- CHKERRMMG() -> PetscCallMMG()
- CHKERRMMG_NONSTANDARD() -> PetscCallMMG_NONSTANDARD()
- CHKERRCGNS() -> PetscCallCGNS()
- CHKERRPTSCOTCH() -> PetscCallPTSCOTCH()
- CHKERRSTR() -> PetscCallSTR()
- CHKERRTC() -> PetscCallTC()

show more ...

pluck ~1000 low hanging PetscCheckFalse() -> PetscCheck() fruit

chkerr and friends wrapped

Merge branch 'jacobf/2022-01-05/c99' into 'main'

Feature: C99 and C++11

See merge request petsc/petsc!4700

rename PetscAssert() -> PetscCheck() and PetscAssertDebug() -> PetscAssert()

add PetscAssert() and PetscAssertFalse()

SETERRQ[1-9]+ begone

Merge branch 'psanan-release-patch-82973' into 'main'

Developer docs, style: remove rule about using "if (!rank)" and replace all "!rank" usage with "rank == 0"

See merge request petsc/petsc!4146

Style: replace "!rank" with "rank == 0"

In SF tutorial ex1 (src/vec/is/sf/tutorials/ex1.c), add parentheses around "rank == 0". This is relevant because ! binds more tightly than +, but == binds les

Style: replace "!rank" with "rank == 0"

In SF tutorial ex1 (src/vec/is/sf/tutorials/ex1.c), add parentheses around "rank == 0". This is relevant because ! binds more tightly than +, but == binds less
tightly, so the result of the computation would otherwise change.

show more ...

Merge remote-tracking branch 'origin/release'

Merge branch 'barry/update-doc' into 'release'

Begin adding missing descriptions to manual pages

See merge request petsc/petsc!4070

Begin adding missing descriptions to manual pages

Commit-type: bug-fix, docs-only
Reported-by: sowing error detection

Merge branch 'barry/2021-05-16/fix-double-lines' into 'main'

Fix typos in source

See merge request petsc/petsc!3984

Remove all double blank lines from source

Commit-type: petsc-style
/2h

Merge branch 'barry/2020-10-08/fix-mpi-error-codes' into 'master'

Convert MPI error type to PETSc error with string message for all MPI calls

See merge request petsc/petsc!3326

Convert MPI error type to PETSc error with string message for all MPI calls

Now PETSc examples will ONLY return PETSc error codes and never MPI error codes directly so we can understand and post-pro

Convert MPI error type to PETSc error with string message for all MPI calls

Now PETSc examples will ONLY return PETSc error codes and never MPI error codes directly so we can understand and post-process their
errors better.

The test harness will now automatically retry tests that fail with MPI, this may help with Intel MPI that produces
seemingly random failures.

Commit-type: error-checking
/spend 30m

show more ...

Merge branch 'jed/promote-examples-tests-tutorials' [petsc/petsc!2610]

* jed/promote-examples-tests-tutorials:
Promote examples/{tests,tutorials}/ to {tests,tutorials}/

Promote examples/{tests,tutorials}/ to {tests,tutorials}/

This shortens paths and improves consistency between test target names
and paths to the source and output files. Most of the work was
compl

Promote examples/{tests,tutorials}/ to {tests,tutorials}/

This shortens paths and improves consistency between test target names
and paths to the source and output files. Most of the work was
completed by this script, followed by mild cleanup of nonconforming
cases.

for makefile in `git ls-files 'src/*makefile'`; do
if rg -q 'DIRS.*\bexamples\b' $makefile; then
base=$(dirname $makefile)
dirs=$(cd $base/examples && ls -d tests tutorials 2>/dev/null | xargs echo)
perl -pi -e "s#^(DIRS.*)\bexamples\b#\1${dirs}#" $makefile
git rm $base/examples/makefile
for t in $dirs; do
git mv $base/examples/$t $base/
perl -pi -e "s#^(LOCDIR[[:space:]]*=).*#\1 $base/$t/#" $base/$t
done
fi
done

git grep -l -E -z 'examples/(tutorials|tests)' | xargs -0 perl -pi -e 's#examples/(tutorials|tests)#\1#g'
git checkout @ \
src/docs/website/documentation/changes/ \
src/benchmarks/results/

show more ...

Merge branch 'master' into knepley/feature-plex-functionals

* master: (984 commits)
netcdf: set zlib as optional dependency corretly [wrt --enable-netcdf-4] - otherwise netcdf configure errors out

Merge branch 'master' into knepley/feature-plex-functionals

* master: (984 commits)
netcdf: set zlib as optional dependency corretly [wrt --enable-netcdf-4] - otherwise netcdf configure errors out
fix gcov obj path
-options_table was changed to options_view in 2014 but documentation was not updated to reflect it
configure: fix F2003 test
Dev manual: remove duplicate entry
Plex test ex5: Removed "future" test, as it resulted in issues in the nightly tests.
Some minor typos in TS
Add ADIOS2.py which I forgot to git add in the past
Plex ex5: Disable test
Doc: Added note for interface change
KSPLSQRMonitorDefault fixed for quad precision
Tao: Added alternative output for chwirut2 test.
TS ex45,ex46: Removed overly refined tests for faster nightly tests.
KSP ex72: Fixed needlessly long-running PCTFS tests.
SNES ex56: Reduced test size to speed up nightly test suite.
KSPSolve_LSQR: don't compute unused norm of rhs
SNES ex13: Reduced problem sizes for nightly tests.
PetscOptionsDeprecated(): fix for NULL prefix
PetscOptionsDeprecated(): add option to print additional info
SNES ex12: Reduced sizes for BDDC tests.
...

show more ...