Fix up manual pages in include/ including adding tick marks

Commit-type: documentation
/spend 4h

Merge branch 'jeremy/vec-stride-sum' into 'main'

Add VecStrideSum and VecStrideSumAll

See merge request petsc/petsc!5484

vec add VecStrideSum and VecStrideSumAll interfaces + CPU impl

Merge branch 'barry/2022-06-24/linenumbers-petscstack' into 'main'

Fixes/improvements for PETSc stack handling

See merge request petsc/petsc!5368

VecLockWriteSet_Private() has to be public (has manual page!) so fix to be public

Commit-type: housekeeping
/spend 10m

Merge branch 'barry/2022-05-03/cleanup-makefiles' into 'main'

remove unneeded stuff from makefiles

See merge request petsc/petsc!5211

Get values of makefile SOURCE etc from the file system instead of makefiles

Use SUBMANSEC from include files for manual sections instead of the makefile

Unfortunately this has to be one large commi

Get values of makefile SOURCE etc from the file system instead of makefiles

Use SUBMANSEC from include files for manual sections instead of the makefile

Unfortunately this has to be one large commit since the changes all have to be done at once

Commit-type: docs
/spend 10m

show more ...

Merge branch 'jacobf/2022-05-05/better-locked-vec-diagnostic' into 'main'

Feature: Better VecSetErrorIfLocked() Diagnostic

See merge request petsc/petsc!5226

Merge branch 'jczhang/feature-vec-coo' into 'main'

Support vector COO assembly

See merge request petsc/petsc!5171

show file:func():line info on where/when a vector was locked for read-only access in the error message

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

Vec: support VecSetValuesCOO, VecSetPreallocationCOO etc

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

deprecate PETSC_STATIC_INLINE

add PetscAssert() and PetscAssertFalse()

SETERRQ[1-9]+ begone

Merge branch 'jczhang/change-VecGetArrayAndMemType-semantics' into 'main'

Let VecGetArrayAndMemType always return device pointer when possible

See merge request petsc/petsc!4308

Vec: add Vec{Get,Restore}ArrayWriteAndMemType()

Merge branch 'barry/2022-01-16/cleanup-swarm' into 'main'

Clean up DMSwarm source code formatting

See merge request petsc/petsc!4724

When subclassing a Vec do not have horrible if (isseq) VecView_Seq() style code, use VecViewNative()

Do not generate errors if VecView() called with HDF viewer and HDF not installed since this canno

When subclassing a Vec do not have horrible if (isseq) VecView_Seq() style code, use VecViewNative()

Do not generate errors if VecView() called with HDF viewer and HDF not installed since this cannot
happen since HDF does not exist

Commit-type: style-fix
\spend 15m

show more ...