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 'barry/2022-04-01/fix-petsc-options-begin-end/release' into 'main'

Remove bogus error returns from Begin/End() macros

See merge request petsc/petsc!5069

Cleanup of introduction of PetscCall()

* remove bogus error flags from XXXBegin()/End() macros such as PetscOptionsBegin()/End()

* rename for consistency certain XXXBegin()/End() macros such as Mat

Cleanup of introduction of PetscCall()

* remove bogus error flags from XXXBegin()/End() macros such as PetscOptionsBegin()/End()

* rename for consistency certain XXXBegin()/End() macros such as MatPreallocateInitialize()/Finalize()

* fix many lingering ierr = XXX that arose from multiline function calls

* sync slepc/hpddm - to use snapshots with the same changes

Commit-type: error-checking, style-fix
/spend 8h

show more ...

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 ...

chkerr and friends wrapped

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

Feature: C99 and C++11

See merge request petsc/petsc!4700

SETERRQ[1-9]+ begone

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 'haplav/fix-viewer-file-modes' into 'main'

PetscViewer: Improve handling of file modes.

See merge request petsc/petsc!3760

PetscViewer: Improve handling of file modes.

* add FILE_MODE_UNDEFINED for initial invalid value (internal use only)
* distinguish between not yet set and unsupported mode
* unify error messages in

PetscViewer: Improve handling of file modes.

* add FILE_MODE_UNDEFINED for initial invalid value (internal use only)
* distinguish between not yet set and unsupported mode
* unify error messages in PetscViewerFileSetName_XXX
* PetscViewerFileSetName_HDF5(): FILE_MODE_UPDATE = FILE_MODE_APPEND
* PetscViewerHDF5Open(): improve doc
* Deprecate PetscViewerVUSetMode, replace by PetscViewerFileSetMode_VU()

show more ...

Merged in barry/update-collective-on (pull request #1744)

Update the use of Collective on in the manual pages to reflect the new style

Update the use of Collective on in the manual pages to reflect the new style

Commit-type: style-fix, documentation
Thanks-to: Patrick Sanan <patrick.sanan@gmail.com>

Merge remote-tracking branch 'origin/psanan/docs-remove-manconcepts' [PR #1733]

Man pages: remove Concepts: fields

These fields were previously stripped from the man pages by logic removed in
21a59cba2737d49dc2f0bd12c08db0d2a3f3f209

Remove these fields from all man pages (but

Man pages: remove Concepts: fields

These fields were previously stripped from the man pages by logic removed in
21a59cba2737d49dc2f0bd12c08db0d2a3f3f209

Remove these fields from all man pages (but not from examples).

This is accomplished with GNU sed (gsed on OS X), with the following commands.
*Warning* that this type of command can corrupt a .git directory,
so be cautious in reusing or modifying these commands. They first look
for and delete matching lines with a following line consisting of only whitespace,
and then delete any remaining matching lines.

find src -type f -not -path "*/examples/*" -not -name "*.html" -not -name "*.bib" -exec gsed -i '/Concepts:/ {N; /\n\s*$/d}' {} +
find src -type f -not -path "*/examples/*" -not -name "*.html" -not -name "*.bib" -exec gsed -i '/Concepts:/d' {} +
find include -type f -not -path "*/examples/*" -not -name "*.html" -not -name "*.bib" -exec gsed -i '/Concepts:/ {N; /\n\s*$/d}' {} +
find include -type f -not -path "*/examples/*" -not -name "*.html" -not -name "*.bib" -exec gsed -i '/Concepts:/d' {} +

Hints on the sed command obtained from: https://unix.stackexchange.com/questions/100754/how-to-delete-a-specific-line-and-the-following-blank-line-using-gnu-sed

show more ...

Merge from master

Merged petsc/petsc into master

Merge branch 'master' into knepley/fix-superdm-is

* master: (455 commits)
bib: spell out some names for format consistency with related refs
bib: two 2018 pubs now appeared
cleaning up analyze

Merge branch 'master' into knepley/fix-superdm-is

* master: (455 commits)
bib: spell out some names for format consistency with related refs
bib: two 2018 pubs now appeared
cleaning up analyzer warnings
compile fixes (workarround PGI bug?):
undoing the branch's changes to leastsquares outputs
more fixes for complex builds
compile error fix for complex builds
1) Look for 64 bit integer MKL BLAS if 64 bit indices are used with PETSc 2) Fix Pardiso code to only compile pardiso_init64 when needed, otherwise can generate warnings/errors
jenkins: run 'cleantest' before 'allgtest-tap' - an attempt to fix errors of type:
cuda: protect cuda includes
fix cuda warnings.
fix complex compile error
Revert "Improved polymorphism of interfaces for MatSetValuesBlocked()"
Bib: Updated ref
Doc: More function documentation
petscvec: move PetscSFCreateFromZero from vscat to vec sources
Fixed an uninitialized variable and got rid of an unused one.
memleak fixed and output files updated
fixing build errors on some archs
Mat: obey options prefix of Mat in MatNullSpaceTest
...

Conflicts:
include/petsc/private/dmpleximpl.h
src/dm/interface/dmi.c

show more ...

Merge branch 'master' into knepley/feature-pc-patch

* master: (281 commits)
compile fixes (workarround PGI bug?):
1) Look for 64 bit integer MKL BLAS if 64 bit indices are used with PETSc 2) Fix

Merge branch 'master' into knepley/feature-pc-patch

* master: (281 commits)
compile fixes (workarround PGI bug?):
1) Look for 64 bit integer MKL BLAS if 64 bit indices are used with PETSc 2) Fix Pardiso code to only compile pardiso_init64 when needed, otherwise can generate warnings/errors
jenkins: run 'cleantest' before 'allgtest-tap' - an attempt to fix errors of type:
cuda: protect cuda includes
fix cuda warnings.
fix complex compile error
Revert "Improved polymorphism of interfaces for MatSetValuesBlocked()"
Bib: Updated ref
Doc: More function documentation
petscvec: move PetscSFCreateFromZero from vscat to vec sources
Mat: obey options prefix of Mat in MatNullSpaceTest
Plex+SNES: Must pass user context through
vscat: move ftn-custom to correct location remove custom vecscatterdestroy_()
vscat: move interface routines to correct location
vscat: delete dead code
fix compile error
FE: Correct coordinates in IntegrateBd
Bib: Added refs
SNES ex17: 3D tests must require a 3D grid generator
Plex+TS: We cannot run the check with the same vector that is the TS solution
...

Conflicts:
include/petsc/private/dmpleximpl.h
src/docs/website/documentation/changes/dev.html
src/snes/examples/tutorials/ex13.c
src/snes/utils/dmplexsnes.c

show more ...

Merge branch 'master' into arcowie-rem/feature-error-logging

* master: (249 commits)
Bib: Added refs
Netcdf should always build netcdf-4 (needed for example by exodusii.
trivial fixes of incor

Merge branch 'master' into arcowie-rem/feature-error-logging

* master: (249 commits)
Bib: Added refs
Netcdf should always build netcdf-4 (needed for example by exodusii.
trivial fixes of incorrect formatting in SNES linesearch routines
ISSetBlockSize_General: removed blockwise contiguity check.
netcdf: set zlib as optional dependency corretly [wrt --enable-netcdf-4] - otherwise netcdf configure errors out
config prefix: avoid ad-hoc path substitutions
config/install: no need to rename paths for installBinDir
rules: fix path in (evidently unimportant) uncrustify target
config pkgconfig: use ${prefix} in PETSc.pc and do not modify in install
fix gcov obj path
Improved polymorphism of interfaces for MatSetValuesBlocked()
-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
...

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 ...

Merge branch 'master' into knepley/feature-plex-elasticity-test

* master: (1553 commits)
-options_table was changed to options_view in 2014 but documentation was not updated to reflect it
config

Merge branch 'master' into knepley/feature-plex-elasticity-test

* master: (1553 commits)
-options_table was changed to options_view in 2014 but documentation was not updated to reflect it
configure: fix F2003 test
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.
PetscFileRetrieve(): Suppress output to STDERR when downloading a file.
MatMatMult: Fixed unused variable pN.
DMDestroy: Guard call to dm->ops->destroy * Similar guards are in place in many other methods (IS,Vec,Mat) and permit the DM to be destroyed even if DMSetType() was never called.
...

show more ...

Merge branch 'master' into knepley/feature-plex-parallel-submesh

* master: (2931 commits)
remove N in docs for SNESQN
replaced test tolerance with PETSC_SQRT_MACHINE_EPSILON
fortran: PetscComp

Merge branch 'master' into knepley/feature-plex-parallel-submesh

* master: (2931 commits)
remove N in docs for SNESQN
replaced test tolerance with PETSC_SQRT_MACHINE_EPSILON
fortran: PetscComplex type is missing from fortran
initialize variables so that static analyzer doesn't mistakenly think they are used uninitialized.
Move access of prefix until it is actually used
Remove DMDASplitComm2d(), used in one example that was not tested
Functions that do not return PetscErrorCode should not use PetscFunctionBegin/End paradgm
remove unneeded reassignment of same value
Missing CHKERRQ(); Mostly in Tao code
Remove clang static analyser warning about passing NULL variable to strncat()
missing newline in -ts_monitor_extreme
minor fixes for integer counters
Configure: Deal with '__func__' in C89 builds with newer Clang and GCC.
Jenkinsfile: Increased timeout for tests to 5 minutes.
3.9 changes: further clarify removal of -pc_factor_mat_solver_package
Options deprecations: add "PETSc" to inline warning
removing unused variable
MatShift support added to MATSUBMAT. Mimics MATSHELL functionality. Needed for matrix-free Hessians in TAO Newton-Line-Search methods.
Add -ts_monitor_extreme
Dev manual: add note on deprecating options database keys
...

Conflicts:
src/dm/impls/plex/examples/tests/ex4.c

show more ...

Merge branch 'master' into knepley/fix-plex-submesh-projection

* master: (425 commits)
remove N in docs for SNESQN
replaced test tolerance with PETSC_SQRT_MACHINE_EPSILON
fortran: PetscComplex

Merge branch 'master' into knepley/fix-plex-submesh-projection

* master: (425 commits)
remove N in docs for SNESQN
replaced test tolerance with PETSC_SQRT_MACHINE_EPSILON
fortran: PetscComplex type is missing from fortran
initialize variables so that static analyzer doesn't mistakenly think they are used uninitialized.
Move access of prefix until it is actually used
Remove DMDASplitComm2d(), used in one example that was not tested
Functions that do not return PetscErrorCode should not use PetscFunctionBegin/End paradgm
remove unneeded reassignment of same value
Missing CHKERRQ(); Mostly in Tao code
Remove clang static analyser warning about passing NULL variable to strncat()
missing newline in -ts_monitor_extreme
minor fixes for integer counters
Configure: Deal with '__func__' in C89 builds with newer Clang and GCC.
Jenkinsfile: Increased timeout for tests to 5 minutes.
3.9 changes: further clarify removal of -pc_factor_mat_solver_package
Options deprecations: add "PETSc" to inline warning
removing unused variable
MatShift support added to MATSUBMAT. Mimics MATSHELL functionality. Needed for matrix-free Hessians in TAO Newton-Line-Search methods.
Add -ts_monitor_extreme
Dev manual: add note on deprecating options database keys
...

Conflicts:
src/dm/impls/plex/examples/tests/ex4.c

show more ...