Add very simple debug mode documentation.

mattip · Sep 13, 2021 · 58b1281 · 58b1281
1 parent bfd1990
commit 58b1281
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/docs/debug-mode.rst b/docs/debug-mode.rst
@@ -0,0 +1,17 @@
+Debug Mode
+==========
+
+HPy includes a debug mode that may be activated at *run time* with
+*no overhead*. This is possible because the whole of the HPy API is provided
+as part of the HPy context, so debug mode can pass in a special debugging
+context (that wraps the normal context) without affecting the performance of
+the regular context at all.
+
+The debugging context can already check for:
+
+* Leaked handles.
+* Handles used after they are closed.
+
+An HPy module may be loaded in debug mode using::
+
+  mod = hpy.universal.load(module_name, so_filename, debug=True)
diff --git a/docs/index.rst b/docs/index.rst
@@ -40,6 +40,7 @@ There are several advantages to write your C extension in HPy:
    overview
    porting-guide
    API <api>
+   debug-mode
    api-reference/index
    misc/index