Merge branch 'barry/2022-08-30/fix-snes-man-pages' into 'main'

Fix/update/improve manual pages in snes directory

See merge request petsc/petsc!5578

Fix/update/improve manual pages in snes directory

Minor changes to source code

Commit-type: housekeeping, documentation
/spend 8h

Merge branch 'jolivet/fix-style-one-liners' into 'main'

Remove braces from one-liners

See merge request petsc/petsc!5557

Remove braces from one-liners

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 'barry/2022-06-13/make-one-line-if-call' into 'main'

Change if () { PetscCall() } three liner to one liner

See merge request petsc/petsc!5344

Change if () { PetscCall() } three liner and friends to one liners

for i in `git ls-files | grep "\.[ch]$"` ; do sed 's?\$?ZZZ?g' $i | tr '\n' '$' | sed 's?\([ ]*\)if (\([-;,.\*+=a-z0-9A-Z_>]*\)) {\

Change if () { PetscCall() } three liner and friends to one liners

for i in `git ls-files | grep "\.[ch]$"` ; do sed 's?\$?ZZZ?g' $i | tr '\n' '$' | sed 's?\([ ]*\)if (\([-;,.\*+=a-z0-9A-Z_>]*\)) {\$[ ]*PetscCall(\([- ._+=a-z0-9A-Z>*,()]*);\)\$[ ]*}\$?\1if (\2) PetscCall(\3$?g' | tr '$' '\n' | sed 's?ZZZ?$?g' > $i.joe ; mv $i.joe $i ; done

for i in `git ls-files | grep "\.[hc]$"` ; do sed 's?\$?ZZZ?g' $i | tr '\n' '$' | sed 's?\([ }else]*\)if (\([-;,.\*+=a-z0-9A-Z_>]*\)) {\$[ ]*PetscCall(\([- ._+=a-z0-9A-Z>*,()]*);\)\$\([ ]*\)} \([- ._+=a-z0-9A-Z>*,()]*);\)\$?\1if (\2) PetscCall(\3$\4\5$?g' | tr '$' '\n' | sed 's?ZZZ?$?g' > $i.joe ; mv $i.joe $i ; done

Yes, really ugly but Barry still cannot master awk

Commit-type: housekeeping

show more ...

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

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

Fix manpages to avoid errors reported by doctext

See merge request petsc/petsc!4309

Fix manpages: Input/Output Parameters --> Parameter

Fix manpages: Input/Output Parameter --> Parameters

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 'gropp/doc-fixes-1' [PR #1838]

Merge from doc-fixes branch

Fixes for doctext update

Merged in psanan/man-pages-remove-keywords (pull request #1717)

Man pages: Remove .keywords fields

Approved-by: BarryFSmith <bsmith@mcs.anl.gov>

Man pages: remove .keywords: fields

This field is recognized by doctext from Sowing (http://wgropp.cs.illinois.edu/projects/software/sowing/doctext/node20.htm#Node20),
but it doesn't seem to be unif

Man pages: remove .keywords: fields

This field is recognized by doctext from Sowing (http://wgropp.cs.illinois.edu/projects/software/sowing/doctext/node20.htm#Node20),
but it doesn't seem to be uniformly used or maintained.

Thus, remove all .keywords: fields, and a following blank line, if present.

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 -exec gsed -i '/keywords:/ {N; /\n\s*$/d}' {} +
find src/ -type f -exec gsed -i '/keywords:/d' {} +
find include/ -type f -exec gsed -i '/keywords:/ {N; /\n\s*$/d}' {} +
find include/ -type f -exec gsed -i '/keywords:/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 ...