1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 10:30:25 -08:00

Make sphinx fail on warnings so that ci detects problems with the manual early <https://github.com/ravenbrook/mps/issues/158#issuecomment-1440828613>. fixing warnings. undoing mystery merge <https://github.com/ravenbrook/mps/pull/159#issuecomment-1440931676>.

This commit is contained in:
Richard Brooksby 2023-02-22 22:53:17 +00:00
parent df6a03cbbe
commit 2f9ff7d0df
5 changed files with 7 additions and 9 deletions

View file

@ -26,6 +26,7 @@ python:
sphinx:
configuration: manual/source/conf.py
fail_on_warning: true
# A. REFERENCES
#

View file

@ -347,10 +347,6 @@ _`.interface.tags.alloc`: Two functions to extend the existing
_`.interface.tags.walker.type`: Type of walker function for
``mps_pool_walk()`` and ``mps_arena_walk()``.
``void mps_pool_walk(mps_arena_t arena, mps_pool_t pool, mps_objects_step_t step, void *p)``
``void mps_arena_walk(mps_arena_t arena, mps_objects_step_t step, void *p)``
_`.interface.tags.walker`: Functions to walk all the allocated
objects in an arena (only client pools in this case),
``format`` and ``tag_data`` can be ``NULL`` (``tag_data`` really wants

View file

@ -6,7 +6,7 @@
# You can set these variables from the command line.
PYTHON = python3
SPHINXOPTS =
SPHINXOPTS = -T -W --keep-going
SPHINXBUILD = tool/bin/sphinx-build
PAPER =
BUILDDIR = .

View file

@ -56,12 +56,13 @@ class MpsDirective(Directive):
else:
return
if hasattr(cls, 'node_class') and hasattr(cls, 'visit'):
app.add_node(cls.node_class, html=cls.visit, latex=cls.visit,
app.add_node(cls.node_class, override=True,
html=cls.visit, latex=cls.visit,
text=cls.visit, man=cls.visit)
if hasattr(cls, 'domain'):
app.add_directive_to_domain(cls.domain, name, cls)
app.add_directive_to_domain(cls.domain, name, cls, override=True)
else:
app.add_directive(name, cls)
app.add_directive(name, cls, override=True)
class MpsPrefixDirective(MpsDirective):
domain = 'mps'

View file

@ -557,7 +557,7 @@ the scanners, found in ``scan.c`` in the MPS source code.
.. note::
The reason that :c:data:`base` and :c:data:`limit` have type
:c:type:`void *` and not :c:type:`mps_addr_t` is that the
``void *`` and not :c:type:`mps_addr_t` is that the
latter is used only for :term:`addresses` managed by the MPS,
but :c:type:`mps_area_scan_t` may also be used to scan
:term:`roots` that are not managed by the MPS.