Skip to content

Commit 170d805

Browse files
committed
Minor edits from express review <#141 (comment)>.
1 parent 29c0ea9 commit 170d805

File tree

4 files changed

+14
-6
lines changed

4 files changed

+14
-6
lines changed

manual/build.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,8 @@ manual, like this::
112112
cd manual
113113
make html
114114

115+
then open manual/html/index.html.
116+
115117
On Windows platforms, follow the `Sphinx installation instructions
116118
<https://www.sphinx-doc.org/en/master/usage/installation.html>`_ for
117119
Windows, then invoke Sphinx as shown in the Makefile in the manual

manual/source/extensions/mps/designs.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,22 +58,22 @@
5858
# design.mps.doc.fmt.ref
5959
mps_ref = re.compile(r'`(\.[a-z][A-Za-z.0-9_-]*[A-Za-z0-9])`_(?: )?')
6060

61-
# design.mps.fmt.function-decl
61+
# design.mps.doc.fmt.function-decl
6262
funcdef = re.compile(r'^``([^`]*\([^`]*\))``$', re.MULTILINE)
6363

64-
# design.mps.fmt.macro-decl
64+
# design.mps.doc.fmt.macro-decl
6565
macrodef = re.compile(r'^``((?:[A-Z][A-Z0-9_]+|{})(?:\([^`]*\))?)``$'
6666
.format('|'.join(map(re.escape, MACROS.split()))), re.MULTILINE)
67-
# design.mps.fmt.macro
67+
# design.mps.doc.fmt.macro
6868
macro = re.compile(r'``([A-Z][A-Z0-9_]+)``(?: )?')
6969

70-
# design.mps.fmt.type-def
70+
# design.mps.doc.fmt.type-def
7171
typedef = re.compile(r'^``typedef ([^`]*)``$', re.MULTILINE)
7272

73-
# design.mps.fmt.function-ref
73+
# design.mps.doc.fmt.function-ref
7474
func = re.compile(r'``([A-Za-z][A-Za-z0-9_]+\(\))``')
7575

76-
# design.mps.fmt.type-ref
76+
# design.mps.doc.fmt.type-ref
7777
typename = re.compile(r'``({0}|[A-Z][A-Za-z0-9_]*'
7878
r'(?:Class|Function|Method|Struct|Union)|'
7979
r'mps_[a-z_]+_[stu])``(?: )?'

manual/source/guide/overview.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
Overview of the Memory Pool System
99
==================================
1010

11+
.. IMPORTANT: If you change the paragraph below, also change
12+
readme.txt
13+
1114
The Memory Pool System is a very general, adaptable, flexible,
1215
reliable, and efficient memory management system. It permits the
1316
flexible combination of memory management techniques, supporting

readme.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ very brief overview and tell you where to find more information.
1919
Overview of the MPS
2020
-------------------
2121

22+
.. IMPORTANT: If you change the paragraph below, also change
23+
manual/source/guide/overview.rst
24+
2225
The Memory Pool System (MPS) is a very general, adaptable, flexible,
2326
reliable, and efficient memory management system. It permits the
2427
flexible combination of memory management techniques, supporting manual

0 commit comments

Comments
 (0)