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 '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 'jolivet/feature-alen' into 'main'

Add PETSC_STATIC_ARRAY_LENGTH

See merge request petsc/petsc!5055

Add PETSC_STATIC_ARRAY_LENGTH

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/2021-12-09/attribute-format-mat' into 'main'

Feature: Attribute Format - Mat

See merge request petsc/petsc!4634

applied attribute format fixes to mat headers

Merge branch 'jose/fix-ksp-complex' into 'main'

KSP: fix several solvers to work with complex matrices

See merge request petsc/petsc!4206

PCQR for MATNORMALHERMITIAN

Merge branch 'jolivet/feature-qr-normal' into 'main'

PCQR for MATNORMAL

See merge request petsc/petsc!4182

SPQR: support for MATNORMAL

Merge branch 'jolivet/fix-some-missing-chkerr' into 'main'

Some missing CHKERR[Q|MPI]

See merge request petsc/petsc!4190

Some missing CHKERR[Q|MPI]

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 'tisaac/feature-spqr' into 'main'

Implement interface to SuiteSparseQR (SPQR) sparse direct QR factorization.

See merge request petsc/petsc!3976

Implement interface to SuiteSparseQR (SPQR) sparse direct QR factorization.

Merge branch 'barry/2021-05-02/fix-logging-no-symbolic-factorization' into 'main'

For factorization types/packages that do not perform a seperate symbolic phase...

See merge request petsc/petsc!3943

For factorization types/packages that do not perform a seperate symbolic phase do not log the event.

Also log the "numerical" factorization as an entire factorization

An alternative would be to pro

For factorization types/packages that do not perform a seperate symbolic phase do not log the event.

Also log the "numerical" factorization as an entire factorization

An alternative would be to provide MatXXXFactorSetUp_XXX that is called in lieu of the symbolic function
for such types/packages but requires more changes to the code.

Commit-type: bug fix for logging
/spend 45m
Reported-by: Xiaoye S. Li <xsli@lbl.gov>
Reported-by: Stephen Jardin <jardin@pppl.gov>
Reported-by: Jin Chen <jchen@pppl.gov>
Reported-by: Nan Ding <nanding@lbl.gov>
Reported-by: Yang Liu <liuyangzhuan@lbl.gov>

show more ...

Merge branch 'barry/2021-03-16/mat-factor-get-can-use-ordering' into 'main'

Change MatFactorGetUseOrdering() to MatFactorGetCanUseOrdering()

See merge request petsc/petsc!3739

Introduce PCFactorSetDefaultOrdering_Factor() to allow each factorization package
to indicate its preferered ordering, which may be external (its own) or one of PETSc.

This also affects factorizatio

Introduce PCFactorSetDefaultOrdering_Factor() to allow each factorization package
to indicate its preferered ordering, which may be external (its own) or one of PETSc.

This also affects factorization like dense PETsc where the ordering passed in by PETSc is ignored and not needed.

Also fixed options for MUMPS and SuiteSparse where users needed to pass a particular options database option
to the package (MUMP or KLU) indicating they should use the PETSc provided ordering. Now if the PETSc provided ordering is provided
these packages automatically use them without need a special option. This simplifies ordering usage for external packages

Commit-type: optimization, bug-fix, testing-fix, style-fix
/spend 6h

show more ...