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

chkerr and friends wrapped

Merge branch 'barry/2022-03-20/rm-petsccheckfalse-tao' into 'main'

Remove use of PetscCheckFalse() from Tao

See merge request petsc/petsc!4998

Remove use of PetscCheckFalse() from Tao

Commit-type: error-checking, housekeeping
/spend 45m

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 remote-tracking branch 'origin/jose/fix-manpages'

Fix manpages to avoid errors reported by doctext

See merge request petsc/petsc!4309

Fix manpages: more errors reported by doctext

Merge branch 'stefanozampini/update-checkbadsource' into 'main'

Update badsource rules

See merge request petsc/petsc!4064

Update badsource rules

- Zero or more spaces are not allowed for more returning types
- zero spaces not allowed for for|if|while

Merge branch 'jacobf/2021-03-26/clang-static-linter' into 'main'

Feature: libClang PETSc Macro Static Analyzer

See merge request petsc/petsc!3773

Linter using libClang that checks PetscValidHeaderSpecifcType, PetscValidHeaderSpecific, PetscValidHeader, PetscValid[XXX]Pointer, PetscValidType, PetscCheckSameComm, PetscValidLogicalCollectiveXXX f

Linter using libClang that checks PetscValidHeaderSpecifcType, PetscValidHeaderSpecific, PetscValidHeader, PetscValid[XXX]Pointer, PetscValidType, PetscCheckSameComm, PetscValidLogicalCollectiveXXX for validity. Automatically generates diff files for problems with a known solution.

show more ...

Merge branch 'barry/2021-04-06/fix-bad-error-code-returns' into 'main'

Fix bad error code returns in various places in PETSc

See merge request petsc/petsc!3846

Fix code that did not pass appropriate PETSc error flags to SETERRQ()

Add checkbadSource check for use of SETERRQ() without an appropriate error flag

Commit-type: error-checking, bug-fix, testing-f

Fix code that did not pass appropriate PETSc error flags to SETERRQ()

Add checkbadSource check for use of SETERRQ() without an appropriate error flag

Commit-type: error-checking, bug-fix, testing-fix, style-fix
/spend 2.5h

show more ...