Fix up manual pages in include/ including adding tick marks

Commit-type: documentation
/spend 4h

Merge branch 'barry/2022-08-09/fix-manualpage-rot' into 'main'

Stop make allmanpages if an error is detected. Otherwise errors are hidden and never fixed.

See merge request petsc/petsc!5510

Put blank lines around some manual page comments to see if that fixes sowing not processing them correctly

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 '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 'knepley/feature-plex-parallel-submesh' into 'main'

Adding parallel handling of extracted submanifolds

See merge request petsc/petsc!5101

DMLabel+Plex: Added label propagation - This is the process of updating a label locally, and then making it consistent in the overlap specified by a point SF - Added DMLabelPropagateBegin(), DMLabelP

DMLabel+Plex: Added label propagation - This is the process of updating a label locally, and then making it consistent in the overlap specified by a point SF - Added DMLabelPropagateBegin(), DMLabelPropagatePush(), and DMLabelPropagateEnd() - Updated SBR refinement

show more ...

Merge branch 'jed/fix-degree-3-geom-distribution' into 'main'

DMPlex: add failing test for cubic geometry distribution

See merge request petsc/petsc!4859

Section: Add PetscSectionSymDistribute()

Merge branch 'haplav/fix-dmlabelcompare-collectiveness' into 'main'

make DMCompareLabels and DMLabelCompare really collective

See merge request petsc/petsc!4691

make DMCompareLabels,DMLabelCompare really collective

Merge branch 'haplav/feature-dmlabelcompare' into 'main'

add DMLabelCompare() and DMCompareLabels()

See merge request petsc/petsc!4345

add DMLabelCompare,DMCompareLabels

add DMLabelGetNonEmptyStratumValuesIS()

Merge branch 'knepley/feature-orientation-rethink' into 'main'

Plex: Rethink Plex orientation

See merge request petsc/petsc!4218

DMLabel: Added more searching
- Added DMLabelGetValueIndex()
- Added DMLabelGetStratumPointIndex()

Merge branch 'knepley/feature-dm-remove-hybrid' into 'master'

Knepley/feature dm remove hybrid

See merge request petsc/petsc!2614

DM+Plex: Removed the idea of hybrid and ghost cells, in favor of cell type
- Improved Plex tests to work for other cell types
- Plex creation, interpolation, submesh, and refinement routines now set

DM+Plex: Removed the idea of hybrid and ghost cells, in favor of cell type
- Improved Plex tests to work for other cell types
- Plex creation, interpolation, submesh, and refinement routines now set the cell type
- Distribution sorts strata by cell type
- Fixed orientation of prisms from input formats
- Added Plex ex40 to test regular refinement
- CellRefiner is a PetscObject
- dm_plex_cell_refiner chooses the refinement strategy
- Removed SimplexToTensor stuff in favor of ToHex refiner
- Most functions take DMPolytopeType instead of CellRefiner
- CellRefinerInCellTest_Internal()
- CellRefinerGetAffineTransforms_Internal()
- CellRefinerGetAffineFaceTransforms_Internal()
- DMForest now responds to DMPlexGetOverlap() and propagates its overlap to the underlying Plex
- Use DMPlexComputeCellType_Internal() to classify a cell based only on topology
- Added DMPlexGetSimplexOrBoxCells() to replace DMPlexGetInteriorCellStratum()
- Added DM_POLYTOPE_POINT_PRISM_TENSOR
- Added DMPolytopTypeGetDim() and DMPolyTopeTypeGetConeSize()
- Added DMLabelSetStratumBounds()
- Added DMPlexSetCellType()
- Added celltypes to DMView()
- Added DMPolytopeTypeGetNumVertices()
- Added DMPlexCreateReferenceCellByType()
- Added DMPolytopeTypeFromGmsh()
- Made DMPlexRefineUniform() public

show more ...

Merge branch 'maint'

Remove use of _ and __ in front of PETSc include guards. Reason: C99 Reserved Identifiers

Commit-type: portability-fix

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

Merged in balay/fix-DMLabel-object-type (pull request #1475)

DMLabel: _n_DMLabel -> _p_DMLabel