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/release'

Merge branch 'psanan/docs-migrate-classic-to-doc-tree' into 'release'

Migrate data for classic build from src/docs to doc/classic

See merge request petsc/petsc!4434

docs: more petsc/src/docs -> petsc/doc updates

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

Merge remote-tracking branch 'origin/release' into master

Merge branch 'psanan/docs-remove-old-manual-tex-references-2010-10-08' into 'release'

Docs: remove some stray remaining references to old LaTeX manual

See merge request petsc/petsc!3322

Docs: remove references to old LaTeX-only PETSc manual

Merge branch 'barry/2020-08-16/fix-source-formatting' into 'master'

Turn on checkbadSource test to generate an error when found; fix all source code that causes errors

See merge request petsc/petsc

Merge branch 'barry/2020-08-16/fix-source-formatting' into 'master'

Turn on checkbadSource test to generate an error when found; fix all source code that causes errors

See merge request petsc/petsc!3064

show more ...

Turn on checkbadSource test to generate an error when found; fix all source code that causes errors

Commit-type: portability-fix, testing-fix, style-fix, feature, maintainability
/spend 1.5h

Merge branch 'master' into knepley/feature-plex-functionals

* master: (984 commits)
netcdf: set zlib as optional dependency corretly [wrt --enable-netcdf-4] - otherwise netcdf configure errors out

Merge branch 'master' into knepley/feature-plex-functionals

* master: (984 commits)
netcdf: set zlib as optional dependency corretly [wrt --enable-netcdf-4] - otherwise netcdf configure errors out
fix gcov obj path
-options_table was changed to options_view in 2014 but documentation was not updated to reflect it
configure: fix F2003 test
Dev manual: remove duplicate entry
Plex test ex5: Removed "future" test, as it resulted in issues in the nightly tests.
Some minor typos in TS
Add ADIOS2.py which I forgot to git add in the past
Plex ex5: Disable test
Doc: Added note for interface change
KSPLSQRMonitorDefault fixed for quad precision
Tao: Added alternative output for chwirut2 test.
TS ex45,ex46: Removed overly refined tests for faster nightly tests.
KSP ex72: Fixed needlessly long-running PCTFS tests.
SNES ex56: Reduced test size to speed up nightly test suite.
KSPSolve_LSQR: don't compute unused norm of rhs
SNES ex13: Reduced problem sizes for nightly tests.
PetscOptionsDeprecated(): fix for NULL prefix
PetscOptionsDeprecated(): add option to print additional info
SNES ex12: Reduced sizes for BDDC tests.
...

show more ...

Merge branch 'master' into knepley/feature-plex-elasticity-test

* master: (1553 commits)
-options_table was changed to options_view in 2014 but documentation was not updated to reflect it
config

Merge branch 'master' into knepley/feature-plex-elasticity-test

* master: (1553 commits)
-options_table was changed to options_view in 2014 but documentation was not updated to reflect it
configure: fix F2003 test
Plex test ex5: Removed "future" test, as it resulted in issues in the nightly tests.
Some minor typos in TS
Add ADIOS2.py which I forgot to git add in the past
Plex ex5: Disable test
Doc: Added note for interface change
KSPLSQRMonitorDefault fixed for quad precision
Tao: Added alternative output for chwirut2 test.
TS ex45,ex46: Removed overly refined tests for faster nightly tests.
KSP ex72: Fixed needlessly long-running PCTFS tests.
SNES ex56: Reduced test size to speed up nightly test suite.
KSPSolve_LSQR: don't compute unused norm of rhs
SNES ex13: Reduced problem sizes for nightly tests.
PetscOptionsDeprecated(): fix for NULL prefix
PetscOptionsDeprecated(): add option to print additional info
SNES ex12: Reduced sizes for BDDC tests.
PetscFileRetrieve(): Suppress output to STDERR when downloading a file.
MatMatMult: Fixed unused variable pN.
DMDestroy: Guard call to dm->ops->destroy * Similar guards are in place in many other methods (IS,Vec,Mat) and permit the DM to be destroyed even if DMSetType() was never called.
...

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

* master: (562 commits)
fix clang-analyzer warning
Developers manual never use system randomizers in PETSc and example source code.
missing

Merge branch 'master' into knepley/feature-pc-patch

* master: (562 commits)
fix clang-analyzer warning
Developers manual never use system randomizers in PETSc and example source code.
missing CHKERRQ()
DT: Reverting the tgamma change broke MPFR - I guess we need a nightly build with it in
Add a test for ex21
Fix error in ex21
Add missing fortran interface that handles null objects
DMComposite: add missing guards
MatPreallocate: fix overpreallocation of local rows
style fixes
MatView_MPI_DA: do not print twice the class prefix
MatSetOperation: stash the original MatView_XXX in the viewnative function pointer
DMCreateInterpolation_DA gracefully error instead of catching FPE signals
MatIncreaseOverlap: preserve communicator of index sets
MatMPIAIJ: fix indentation and missing CHKERRQ
ISBuildTwoSided: remove tabs and fix style
Fix documentation
PetscViewerDraw: fix unininitialized warning from valgrind
MatConvert_SeqAIJ_SeqBAIJ: remove error for non square matrices and add MAT_REUSE_MATRIX case
Mat: MAT_INPLACE_MATRIX can be used for transposition with rectangular matrices
...

Conflicts:
src/dm/dt/interface/dtfe.c
src/dm/impls/plex/plex.c
src/dm/impls/plex/plexfem.c
src/snes/examples/tutorials/ex13.c
src/snes/examples/tutorials/ex62.c
src/snes/examples/tutorials/makefile
src/snes/examples/tutorials/output/ex62_18.out
src/snes/examples/tutorials/output/ex62_19.out
src/snes/examples/tutorials/output/ex62_20.out
src/snes/examples/tutorials/output/ex62_20_parmetis.out
src/snes/examples/tutorials/output/ex62_21.out
src/snes/examples/tutorials/output/ex62_22.out
src/snes/examples/tutorials/output/ex62_23.out
src/snes/examples/tutorials/output/ex62_24.out
src/snes/examples/tutorials/output/ex62_25.out
src/snes/examples/tutorials/output/ex62_26.out
src/snes/examples/tutorials/output/ex62_27.out
src/snes/examples/tutorials/output/ex62_28.out
src/snes/examples/tutorials/output/ex62_29.out
src/snes/examples/tutorials/output/ex62_2d_p3_1.out
src/snes/examples/tutorials/output/ex62_30.out
src/snes/examples/tutorials/output/ex62_31.out
src/snes/examples/tutorials/output/ex62_32.out
src/snes/examples/tutorials/output/ex62_33.out
src/snes/examples/tutorials/output/ex62_34.out
src/snes/examples/tutorials/output/ex62_35.out
src/snes/examples/tutorials/output/ex62_36.out
src/snes/examples/tutorials/output/ex62_pc_simple.out
src/snes/examples/tutorials/output/ex62_pc_simplec.out
src/snes/examples/tutorials/output/ex62_quad_q2p1_full.out
src/snes/examples/tutorials/output/ex62_quad_q2q1_full.out
src/snes/utils/dmplexsnes.c

show more ...

Merge branch 'master' into knepley/feature-error-logging

* master: (221 commits)
dashboard: count and list example compile failures like:
fix fix-pr879-jczhang-optimize-vecscatter-multi-copy
a

Merge branch 'master' into knepley/feature-error-logging

* master: (221 commits)
dashboard: count and list example compile failures like:
fix fix-pr879-jczhang-optimize-vecscatter-multi-copy
add manual page cross links for SNESLineSearchSetPostCheck() and related routines
fix help manual of MatCreateSubmatrices() Reported-by: Tim Steinhoff <kandanovian@gmail.com>
Add manual pages for PetscRealPart() and PetscImaginaryPart()
fix compile error with missing MPI_C_DOBULE_COMPLEX
fix typo Reported-by: Febrian Setianto <febrian.setianto@gmail.com>
plex tutorial ex5: updated test requirements
DMPlexLoad_HDF5_Xdmf_Internal: fix for complex PetscScalar.
DMPlexLoad_HDF5_Xdmf_Internal: fix for 64-bit PetscInt.
DMPlexBuildFromCellList_Internal: use DMPlexInvertCell_Internal (with PetscInt* arg)
petscviewer.h: removed notice which is no longer relevant
DMPlexCreateFromFile: document option
check only if PETSC_USE_DEBUG
DMPlexBuildFromCellList_Internal optionally inverts cells.
ex5: new test 4 with -compare without repartitioning
ex5: new test 3 using -compare
ex5: HDF5 write+read moved to separate function
ex5: option -format processed in ProcessOptions()
ex5: added missing hdf5 requirement
...

Conflicts:
include/petsclog.h

show more ...

Merge branch 'psanan/manpages-notes-newlines' [PR #932]

* psanan/manpages-notes-newlines:
A large number of man pages are improperly formatted because of the lack of a newline after "Notes:", "Fortr

Merge branch 'psanan/manpages-notes-newlines' [PR #932]

* psanan/manpages-notes-newlines:
A large number of man pages are improperly formatted because of the lack of a newline after "Notes:", "Fortran Notes:", or "Developer Notes:".
This batch adds those newlines, with 4 spaces of indentation afterwards.
The uniform indentation arguably makes the man pages a little less readable in the source itself,
but overall this hopefully has a large positive impact on the readability of the HTML pages.

show more ...

Man pages: add newlines after "Notes:"

This allows for proper formatting from sowing.

On OS X (using gsed, not the default BSD sed), from the PETSc root directory:

find src include -type f \(

Man pages: add newlines after "Notes:"

This allows for proper formatting from sowing.

On OS X (using gsed, not the default BSD sed), from the PETSc root directory:

find src include -type f \( -name "*.c" -or -name "*.h" -or -name "*.cxx" \) | xargs gsed -i 's/Notes\s*:\s*\(\w.*\)/Notes:\n \1/'

This adds a newline and 4 spaces whenever "Notes:" is followed by any "word" character, in any .c, .h, or .cxx file in src/ or include/

show more ...

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