Merge branch 'psanan/docs-seealso-formatting' into 'main'

Docs: Fix man page .seealso entries missing spaces after commas

Closes #1176

See merge request petsc/petsc!5202

Merge remote-tracking branch 'origin/release'

Docs: Fix man page .seealso entries missing spaces after commas

```python

import os
import re
import fileinput

START_PATTERN = re.compile(r"^( *\.seealso:? )(.*$)")
FIX_PATTERN = re.compile(r",([^

Docs: Fix man page .seealso entries missing spaces after commas

```python

import os
import re
import fileinput

START_PATTERN = re.compile(r"^( *\.seealso:? )(.*$)")
FIX_PATTERN = re.compile(r",([^ $\n])")

def _fix_comma(matchobj):
return "`, `%s" % matchobj.group(1)

def process_file(filename_full):
""" Find/fix commas w/o trailing spaces or newlines in .seealso blocks """
with fileinput.FileInput(filename_full, inplace=True) as the_file:
in_block = False
for line in the_file:
line_stripped = line.strip()
# end ".seealso blocks" on a blank line or C-style comment close
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:
in_block = True
if in_block:
if re.search(FIX_PATTERN, line):
line_fixed = re.sub(FIX_PATTERN, _fix_comma, line)
print(line_fixed, end="") # prints to file
else:
print(line, end="") # prints to file
else:
print(line, end="") # prints to 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 files in local tree(s) """
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)
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 'jed/snes-convergence-test-doc' into 'release'

SNES doc: fixes and cross-references for -snes_convergence_test skip

See merge request petsc/petsc!5197

SNES doc: fixes and cross-references for -snes_convergence_test skip

-snes_no_convergence_test was removed in PETSc-3.0, but a documentation
relic was still hanging around confusing people.

Commit-

SNES doc: fixes and cross-references for -snes_convergence_test skip

-snes_no_convergence_test was removed in PETSc-3.0, but a documentation
relic was still hanging around confusing people.

Commit-type: documentation

show more ...

Merge branch 'psanan/docs-sphinx-man-pages' into 'main'

Integrate Man Pages into Sphinx Docs

Closes #1132 and #1015

See merge request petsc/petsc!4989

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 'jacobf/2022-04-05/petscattrformat-all-the-rest' into 'main'

Enable PETSC_ATTRIBUTE_FORMAT()

See merge request petsc/petsc!5085

Enable PETSC_ATTRIBUTE_FORMAT()

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 'barry/2022-03-30/fix-mpiu_allreduce' into 'main'

Fix mpiu_allreduce to always return PetscErrorCodes, never MPI error codes

See merge request petsc/petsc!5052

Fix mpiu_allreduce to always return PetscErrorCodes, never MPI error codes

Both for debug and optimized builds

Also removes shadow declaration errors from use of mpiu_allreduce

Commit-type: error-

Fix mpiu_allreduce to always return PetscErrorCodes, never MPI error codes

Both for debug and optimized builds

Also removes shadow declaration errors from use of mpiu_allreduce

Commit-type: error-checking
Reported-by: Lisandro Dalcin <dalcinl@gmail.com>

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

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()

make PetscInfo() variadic

SETERRQ[1-9]+ begone

Merge branch 'release'

Merge branch 'knepley/fix-snes-monitor-lg' into 'release'

Knepley/fix snes monitor lg

See merge request petsc/petsc!4615

SNES: Somehow the LG monitor was broken in SNES