Fix manual pages based on reports from Jacob's lint tool

Commit-type: documentation

Merge branch 'barry/2023-03-01/fix-mat-man-pages' into 'main'

Cleanup of mat manual pages

See merge request petsc/petsc!6134

Cleanup of mat manual pages

Commit-type: documentation

Merge branch 'jacobf/2022-12-10/petscerrorcode-nodiscard' into 'main'

Feature: Non-discardable PetscErrorCode

See merge request petsc/petsc!5923

Make PetscErrorCode a non-discardable enum

Merge remote-tracking branch 'origin/release'

Merge branch 'barry/2022-11-17/fix-collective-on-man-pages/release' into 'release'

Remove unneeded " on xxx" from most Collective comments in manual pages; move no Fortran support to Collective line

Merge branch 'barry/2022-11-17/fix-collective-on-man-pages/release' into 'release'

Remove unneeded " on xxx" from most Collective comments in manual pages; move no Fortran support to Collective line

See merge request petsc/petsc!5850

show more ...

Remove unneeded " on xxx" from most Collective comments in manual pages

The phrase was unneeded 99% of the time

I did not remove in the dm directory since another MR is still active that affects th

Remove unneeded " on xxx" from most Collective comments in manual pages

The phrase was unneeded 99% of the time

I did not remove in the dm directory since another MR is still active that affects that directory

Commit-type: documentation
/spend 20m

show more ...

Merge branch 'jacobf/2022-09-21/2-bike-2-shed' into 'main'

Feature: Bicycle Storage Facility 2

See merge request petsc/petsc!5661

source code format changes due to .clang-format changes

Merge branch 'jacobf/2022-09-17/slimmer-petscobject' into 'main'

Feature: Slimmer PetscObject

See merge request petsc/petsc!5649

Remove parent, parentid, flops, time, mem, and memchildren. Deprecate PetscLogObjectParent(), PetscLogObjectMemory(), and PetscNewLog()

Merge branch 'haplav/htransm-petsccheck' into 'main'

htransm.c: SETERRQ -> PetscCheck

See merge request petsc/petsc!5623

htransm.c: SETERRQ -> PetscCheck

fix warning in checksource:
------Using if (condition) SETERRQ(...) instead of PetscCheck() ----
src/mat/impls/transpose/htransm.c:53: if (PetscDefined(USE_COMPLE

htransm.c: SETERRQ -> PetscCheck

fix warning in checksource:
------Using if (condition) SETERRQ(...) instead of PetscCheck() ----
src/mat/impls/transpose/htransm.c:53: if (PetscDefined(USE_COMPLEX)) SETERRQ(PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "No support for complex Hermitian transpose matrices");

show more ...

Merge branch 'barry/2022-08-15/fix-mat-manpages' into 'main'

Man pages in mat directory, manual material on matrices

See merge request petsc/petsc!5539

fixes for manual pages

Commit-type: i.e. error-checking, optimization, bug-fix, portability-fix, testing-fix, style-fix, feature, documentation, example
Funded-by:
Project:
Time: hours
Reported-

fixes for manual pages

Commit-type: i.e. error-checking, optimization, bug-fix, portability-fix, testing-fix, style-fix, feature, documentation, example
Funded-by:
Project:
Time: hours
Reported-by:
Thanks-to:
Development Tools: Vim, Emacs, Eclipse

show more ...

Fix manual pages in src/mat directory, very minor source code change

Commit-type: documentation
/spend 22h

Merge branch 'barry/2022-08-21/clang-format-source' into 'main'

format repository with clang-format

See merge request petsc/petsc!5541

clang-format: convert PETSc sources to comply with clang-format

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-03-30/strip-petscall-petsctrymethod' into 'main'

Do not wrap PetscTryMethod() PetscUseMethod() in PetscCall

See merge request petsc/petsc!5051

Do not wrap PetscTryMethod() PetscUseMethod() in PetscCall

It produces shadow declarations and also serves no purpose since these macros do the appropriate error checking already

There may be addit

Do not wrap PetscTryMethod() PetscUseMethod() in PetscCall

It produces shadow declarations and also serves no purpose since these macros do the appropriate error checking already

There may be additions needed for running with a static error checker

Commit-type: error-checking
/spend 15m
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 ...