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

Merge branch 'barry/2022-04-29/rm-petsccheckfalse-sys' into 'main'

Remove PetscCheckFalse() from sys directory

See merge request petsc/petsc!5187

Remove PetscCheckFalse() from sys directory

Commit-type: housekeeping
/spend 30m

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

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 'dalcinl/fix-null' into 'master'

Sys: Replace 0 -> NULL for pointers

See merge request petsc/petsc!2482

Sys: Replace 0 -> NULL for pointers

Merge remote-tracking branch 'origin/psanan/docs-remove-manconcepts' [PR #1733]

Man pages: remove Concepts: fields

These fields were previously stripped from the man pages by logic removed in
21a59cba2737d49dc2f0bd12c08db0d2a3f3f209

Remove these fields from all man pages (but

Man pages: remove Concepts: fields

These fields were previously stripped from the man pages by logic removed in
21a59cba2737d49dc2f0bd12c08db0d2a3f3f209

Remove these fields from all man pages (but not from examples).

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 -not -path "*/examples/*" -not -name "*.html" -not -name "*.bib" -exec gsed -i '/Concepts:/ {N; /\n\s*$/d}' {} +
find src -type f -not -path "*/examples/*" -not -name "*.html" -not -name "*.bib" -exec gsed -i '/Concepts:/d' {} +
find include -type f -not -path "*/examples/*" -not -name "*.html" -not -name "*.bib" -exec gsed -i '/Concepts:/ {N; /\n\s*$/d}' {} +
find include -type f -not -path "*/examples/*" -not -name "*.html" -not -name "*.bib" -exec gsed -i '/Concepts:/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 ...

Merge branch 'master' into knepley/feature-plex-parallel-submesh

* master: (2931 commits)
remove N in docs for SNESQN
replaced test tolerance with PETSC_SQRT_MACHINE_EPSILON
fortran: PetscComp

Merge branch 'master' into knepley/feature-plex-parallel-submesh

* master: (2931 commits)
remove N in docs for SNESQN
replaced test tolerance with PETSC_SQRT_MACHINE_EPSILON
fortran: PetscComplex type is missing from fortran
initialize variables so that static analyzer doesn't mistakenly think they are used uninitialized.
Move access of prefix until it is actually used
Remove DMDASplitComm2d(), used in one example that was not tested
Functions that do not return PetscErrorCode should not use PetscFunctionBegin/End paradgm
remove unneeded reassignment of same value
Missing CHKERRQ(); Mostly in Tao code
Remove clang static analyser warning about passing NULL variable to strncat()
missing newline in -ts_monitor_extreme
minor fixes for integer counters
Configure: Deal with '__func__' in C89 builds with newer Clang and GCC.
Jenkinsfile: Increased timeout for tests to 5 minutes.
3.9 changes: further clarify removal of -pc_factor_mat_solver_package
Options deprecations: add "PETSc" to inline warning
removing unused variable
MatShift support added to MATSUBMAT. Mimics MATSHELL functionality. Needed for matrix-free Hessians in TAO Newton-Line-Search methods.
Add -ts_monitor_extreme
Dev manual: add note on deprecating options database keys
...

Conflicts:
src/dm/impls/plex/examples/tests/ex4.c

show more ...

Merge branch 'master' into knepley/feature-snes-ex13-spectral

* master: (2350 commits)
migrate warning fix from next-tmp
Revert "Remove dead code."
clarifying comment in the code
Remove dead

Merge branch 'master' into knepley/feature-snes-ex13-spectral

* master: (2350 commits)
migrate warning fix from next-tmp
Revert "Remove dead code."
clarifying comment in the code
Remove dead code.
Add JuMP citation
Copyedits and updates to developers manual
Add more protection to intrinsics
MPI: protect arguments in MPI macros
Add the missing conditionals for 64-bit build
Plex+VTK: Fix field type determination
Fix bug in name cleanup
Bib: Added ref
Plex+VTK: Fix field type determination
Plex: Updated test output - I am now hating this shit
forgot to save file after moving prototypes to petscsys.h
update Apple example project settings per Xcode
Two functions should actually be public, used, for example from Apple MacOS and iOS programs
includes should always be included relative to include directory
Apple removed old locations of docsets
SNES ex12: Updated test output
...

Conflicts:
src/snes/examples/tutorials/ex13.c

show more ...

cleanup PETSC_DESIRE_FEATURE_TEST_MACROS

Commit-type: style-fix

Merge commit 'd47bf9aaf1e5266cc3f0ff499f934c85788965a9' into jed/fix-matcreatempibaij/maint

Obtain changed (v3.5) handling of MatMPIBAIJSetPreallocationCSR to match
documentation.

Merge branch 'master' into knepley/feature-plex-sphere-mesh

* master: (2633 commits)
Bib: Added ref
SNES ex56: Update test output
add a citation to petsc.bib
Plex: Initialize variables
ini

Merge branch 'master' into knepley/feature-plex-sphere-mesh

* master: (2633 commits)
Bib: Added ref
SNES ex56: Update test output
add a citation to petsc.bib
Plex: Initialize variables
initialize ap as complained by the nightly tests
Plex ex3: Update to new point function API
initialize some variables as complained by nightly tests
SNES ex12: Mix misnaming Nf --> Nc
update tests
add tests
add MatView_SeqXAIJ_ASCII_structonly(); enable A->structure_only in MatSetValuesBlocked_SeqBAIJ
typo
fill-in some references
Bib: Fixed ref
Plex: Added PLY to file support
Plex: Adding PLY support
PetscDS: Turn off Fortran bindings for Constants
Plex tests: Updated to new point function API
SNES ex56: Moved tests to new format
DM: Allow field projection functions to take an array of scalars - This will allow us to pass in user data to kernels without void *, more efficiency than aux fields
...

Conflicts:
config/builder.py
include/petscdmplex.h
src/dm/impls/plex/examples/tests/ex1.c
src/dm/impls/plex/plexcreate.c
src/dm/impls/plex/plexgmsh.c
src/snes/examples/tutorials/ex63.c

show more ...

Merge branch 'master' into knepley/feature-plex-pragmatic-parallel

* master: (1379 commits)
Minor fixes for tchem examples due to changes in PETSc infrastructure
update webpage about API changes

Merge branch 'master' into knepley/feature-plex-pragmatic-parallel

* master: (1379 commits)
Minor fixes for tchem examples due to changes in PETSc infrastructure
update webpage about API changes
add help menu for MatCreateSubMatricesMPI()
rename struct Mat_SubMat -> Mat_SubSppt
add a little information to the manual about using tchem
rename MatCreateSubMatrixComposite -> MatCreateSubMatrixVirtual; Mat_SubMatrix -> Mat_SubVirtual
need to protect the \ passed on the makefile on my Mac
Bib: Updated ref
update src/mat/examples/tests/output/ex23_#.out
rename MatGetSubMat -> MatCreateSubMat
Mark MatCreateMPIAIJWithSplitArrays() and MatMPIAIJSetPreallocationCSR() with MAT_NO_OFF_PROC_ENTRIES
superlu: libray is installed in PREFIX/lib64 - fix this to use PREFIX/lib
backport fixes cc105cc3 2b35c90a - required for 3bf428d - that was backported from master - 80c96bb
'echo -n' fails on opensolaris/osx - so avoid using it.
fix diffs in nightlybuilds due to options in ~/.petscrc
add Kelley03 to src/docs/tex/petsc.bib
build: determine moudles, mpi.h used during buildtime and print in 'info'
fix analyzer warnings
fix build failure on opensolaris - where -lm from flibs is removed due to -lm in cxxlibs. But then - only flib gets used for some configure tests [blaslapack, parms]
config: prefer __restrict over C99 restrict keyword
...

show more ...