From 3c98b19e120ab905bad4a10c3cb4c6dcde32aaf0 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 14 Jan 2023 00:11:37 +0000 Subject: [PATCH 01/17] Adding a github ci workflow to check the syntax of restructuredtext files. --- mps/.github/workflows/rst-check.yml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 mps/.github/workflows/rst-check.yml diff --git a/mps/.github/workflows/rst-check.yml b/mps/.github/workflows/rst-check.yml new file mode 100644 index 00000000000..b2806fe1b71 --- /dev/null +++ b/mps/.github/workflows/rst-check.yml @@ -0,0 +1,28 @@ +# .github/workflows/rst-check.yml -- check syntax of reStructuredText files +# +# This is a GitHub CI workflow +# +# to check the syntax of reStructuredText files. +# +# TODO: The scripts in this file might be better off in an auxillary +# file that can be also be run from the prompt. Possibly in the +# top-level Makefile. + +name: rst-check + +on: + # Run as part of CI checks on branch push and on merged pull request. + - push + - pull_request + +jobs: + rst-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Install docutils + run: sudo apt-get install -y docutils + - name: Check reStructuredText syntax in .rst files + run: find . -path ./manual/source -prune -o -type f -name '*.rst' -print | ( code=0; while read f; do if ! rst2html --report=2 --exit-status=2 "$f" > /dev/null; then code=1; fi done; exit "$code" ) + - name: Check reStructedText syntax in .txt files + run: find . -path ./manual/source -prune -o -type f -name '*.txt' -print | ( code=0; while read f; do if head -1 -- "$f" | fgrep -q -e '-*- rst -*-'; then if ! rst2html --report=2 --exit-status=2 "$f" > /dev/null; then code=1; fi; fi; done; exit "$code" ) From 95f4238221b2335d46e004b83c1346cfa31e4008 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 14 Jan 2023 00:13:26 +0000 Subject: [PATCH 02/17] Suppress travis ci on branch/2023-01-13/rst-check for faster testing of github ci. --- mps/.travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mps/.travis.yml b/mps/.travis.yml index 2153440b005..796c776d842 100644 --- a/mps/.travis.yml +++ b/mps/.travis.yml @@ -4,7 +4,7 @@ # Some branches don't need builds. Add them here to avoid using build # resources and unnecessary build messages. See # . -if: NOT branch IN (branch/2023-01-07/pull-request-merge-procedure) +if: NOT branch IN (branch/2023-01-13/rst-check) # The main build matrix for POSIX-like systems. language: c # see . From 6ffa63968778e043a192ff351ab8176df895fb37 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 14 Jan 2023 00:18:38 +0000 Subject: [PATCH 03/17] Run checking steps even if other steps fail. --- mps/.github/workflows/rst-check.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mps/.github/workflows/rst-check.yml b/mps/.github/workflows/rst-check.yml index b2806fe1b71..65f7fcef636 100644 --- a/mps/.github/workflows/rst-check.yml +++ b/mps/.github/workflows/rst-check.yml @@ -23,6 +23,8 @@ jobs: - name: Install docutils run: sudo apt-get install -y docutils - name: Check reStructuredText syntax in .rst files + if: always() run: find . -path ./manual/source -prune -o -type f -name '*.rst' -print | ( code=0; while read f; do if ! rst2html --report=2 --exit-status=2 "$f" > /dev/null; then code=1; fi done; exit "$code" ) - name: Check reStructedText syntax in .txt files + if: always() run: find . -path ./manual/source -prune -o -type f -name '*.txt' -print | ( code=0; while read f; do if head -1 -- "$f" | fgrep -q -e '-*- rst -*-'; then if ! rst2html --report=2 --exit-status=2 "$f" > /dev/null; then code=1; fi; fi; done; exit "$code" ) From c0ebe680830683bde38e6a2f0fcb76282077c254 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 14 Jan 2023 00:38:53 +0000 Subject: [PATCH 04/17] Moving checking to its own script so it can be used at the command line, which also simplifies the github workflow. --- mps/.github/workflows/rst-check.yml | 12 +---- mps/tool/checkrst | 74 +++++++++++++++++++++++++++++ 2 files changed, 76 insertions(+), 10 deletions(-) create mode 100755 mps/tool/checkrst diff --git a/mps/.github/workflows/rst-check.yml b/mps/.github/workflows/rst-check.yml index 65f7fcef636..65ec61d8acf 100644 --- a/mps/.github/workflows/rst-check.yml +++ b/mps/.github/workflows/rst-check.yml @@ -3,10 +3,6 @@ # This is a GitHub CI workflow # # to check the syntax of reStructuredText files. -# -# TODO: The scripts in this file might be better off in an auxillary -# file that can be also be run from the prompt. Possibly in the -# top-level Makefile. name: rst-check @@ -22,9 +18,5 @@ jobs: - uses: actions/checkout@v3 - name: Install docutils run: sudo apt-get install -y docutils - - name: Check reStructuredText syntax in .rst files - if: always() - run: find . -path ./manual/source -prune -o -type f -name '*.rst' -print | ( code=0; while read f; do if ! rst2html --report=2 --exit-status=2 "$f" > /dev/null; then code=1; fi done; exit "$code" ) - - name: Check reStructedText syntax in .txt files - if: always() - run: find . -path ./manual/source -prune -o -type f -name '*.txt' -print | ( code=0; while read f; do if head -1 -- "$f" | fgrep -q -e '-*- rst -*-'; then if ! rst2html --report=2 --exit-status=2 "$f" > /dev/null; then code=1; fi; fi; done; exit "$code" ) + - name: Check reStructuredText syntax + run: tool/checkrst diff --git a/mps/tool/checkrst b/mps/tool/checkrst new file mode 100755 index 00000000000..e6d6e695181 --- /dev/null +++ b/mps/tool/checkrst @@ -0,0 +1,74 @@ +#!/bin/sh +# tool/checkrst -- check syntax of reStructuredText in the MPS +# +# Copyright (c) 2023 Ravenbrook Limited. See end of file for license. +# +# This script finds reStructuredText files in the MPS tree and runs +# them through docutils to check for syntax errors. +# +# It can be invoked from the command line of from Continuous +# Integration scripts. See .github/workflows/rst-check.yml +# +# This script excludes manual/source because the reStructuredText +# there is in an extended Sphinx format that can't be checked by the +# basic docutils. It can be checked by building the manual. See +# manual/Makefile. + +{ + find . -path ./manual/source -prune -o -type f -name '*.rst' -print + find . -path ./manual/source -prune -o -type f -name '*.txt' -print | + while read f; do + if head -1 -- "$f" | fgrep -q -e '-*- rst -*-'; then + echo "$f" + fi + done +} | { + code=0 + while read f; do + if ! rst2html --report=2 --exit-status=2 "$f" > /dev/null; then + code=1 + fi + done + exit "$code" +} + +# A. REFERENCES +# +# [None] +# +# +# B. DOCUMENT HISTORY +# +# 2023-01-13 RB Created. +# +# +# C. COPYRIGHT AND LICENSE +# +# Copyright (C) 2023 Ravenbrook Limited . +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are +# met: +# +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the +# distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS +# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A +# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# +# +# $Id$ From 5c963ee204e6268e1f90a935e7caa3b028b1692a Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 14 Jan 2023 00:42:45 +0000 Subject: [PATCH 05/17] Refining pruning rules for command-line use. --- mps/tool/checkrst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/mps/tool/checkrst b/mps/tool/checkrst index e6d6e695181..c643b6f8256 100755 --- a/mps/tool/checkrst +++ b/mps/tool/checkrst @@ -15,8 +15,10 @@ # manual/Makefile. { - find . -path ./manual/source -prune -o -type f -name '*.rst' -print - find . -path ./manual/source -prune -o -type f -name '*.txt' -print | + find . -path ./manual/source -prune -o \ + -path ./manual/tool -prune -o \ + -type f -name '*.rst' -print + find . -type f -name '*.txt' -print | while read f; do if head -1 -- "$f" | fgrep -q -e '-*- rst -*-'; then echo "$f" From 378674486cf1ca03faa83f62694d4b7980057a24 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 14 Jan 2023 00:52:44 +0000 Subject: [PATCH 06/17] Fixing basic restructuredtext syntax and reference errors found by tool/checkrst. --- mps/design/poolawl.txt | 2 +- mps/design/protix.txt | 9 +++------ mps/design/protocol.txt | 2 +- mps/design/shield.txt | 2 +- mps/procedure/release-build.rst | 2 +- 5 files changed, 7 insertions(+), 10 deletions(-) diff --git a/mps/design/poolawl.txt b/mps/design/poolawl.txt index cd2625d3c67..ebad6106ee1 100644 --- a/mps/design/poolawl.txt +++ b/mps/design/poolawl.txt @@ -246,7 +246,7 @@ segment sizes are rounded up to the arena grain size. _`.fun.awlsegcreate.where`: The segment is allocated using a generation preference, using the generation number stored in the -``AWLStruct`` (the ``gen`` field), see `.poolstruct.gen`_ above. +``AWLStruct`` (the ``gen`` field), see `.poolstruct`_ above. ``Res awlSegInit(Seg seg, Pool pool, Addr base, Size size, ArgList args)`` diff --git a/mps/design/protix.txt b/mps/design/protix.txt index 88a764f66a8..529b43990a2 100644 --- a/mps/design/protix.txt +++ b/mps/design/protix.txt @@ -88,12 +88,9 @@ okay), the protection is set to ``PROT_READ|PROT_WRITE|PROT_EXEC``. .. _design.mps.prot.if.set: prot#.if.set _`.fun.set.assume.mprotect`: We assume that the call to ``mprotect()`` -always succeeds. - -_`.fun.set.assume.mprotect`: This is because we should always call the -function with valid arguments (aligned, references to mapped pages, -and with an access that is compatible with the access of the -underlying object). +always succeeds. We should always call the function with valid +arguments (aligned, references to mapped pages, and with an access +that is compatible with the access of the underlying object). _`.fun.sync`: ``ProtSync()`` does nothing in this implementation as ``ProtSet()`` sets the protection without any delay. diff --git a/mps/design/protocol.txt b/mps/design/protocol.txt index 8d285fd9e19..93ac13efd0d 100644 --- a/mps/design/protocol.txt +++ b/mps/design/protocol.txt @@ -569,7 +569,7 @@ following: A function called by ``SomeClassGet()``. All the class initialization code is actually in this function. -_`.impl.subclass`: The subclass test `.if.subclass`_ is implemented +_`.impl.subclass`: The subclass test `.if.is-subclass`_ is implemented using an array of superclasses [Cohen_1991]_ giving a fast constant-time test. (RB_ tried an approach using prime factors [Gibbs_2004]_ but found that they overflowed in 32-bits too easily to diff --git a/mps/design/shield.txt b/mps/design/shield.txt index 489bec6743d..248b72c4346 100644 --- a/mps/design/shield.txt +++ b/mps/design/shield.txt @@ -257,7 +257,7 @@ _`.proof.sync`: As the depth of a segment cannot be negative | ⇒ all segments are synced (by `.inv.unsynced.depth`_) _`.proof.access`: If the mutator is running then all segments must be -synced (`.inv.unsynced.suspend`_). Which means that the hardware +synced (`.inv.unsynced.suspended`_). Which means that the hardware protection (protection mode) must reflect the software protection (shield mode). Hence all shielded memory will be hardware protected while the mutator is running. This ensures `.prop.mutator.access`_. diff --git a/mps/procedure/release-build.rst b/mps/procedure/release-build.rst index eff46a92999..233789e71a5 100644 --- a/mps/procedure/release-build.rst +++ b/mps/procedure/release-build.rst @@ -280,7 +280,7 @@ B. Document History .. _NB: mailto:nb@ravenbrook.com .. _RHSK: mailto:rhsk@ravenbrook.com .. _GDR: mailto:gdr@ravenbrook.com -.. _PNJ mailto:pnj@ravenbrook.com +.. _PNJ: mailto:pnj@ravenbrook.com C. Copyright and License ------------------------ From 643aaa11a7a47c9fd683a0d073bde331023d4cc4 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 14 Jan 2023 01:12:53 +0000 Subject: [PATCH 07/17] Improving the naming so that results are clearer in github output. --- mps/.github/workflows/rst-check.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mps/.github/workflows/rst-check.yml b/mps/.github/workflows/rst-check.yml index 65ec61d8acf..57779a0e282 100644 --- a/mps/.github/workflows/rst-check.yml +++ b/mps/.github/workflows/rst-check.yml @@ -4,7 +4,7 @@ # # to check the syntax of reStructuredText files. -name: rst-check +name: reStructuredText syntax check on: # Run as part of CI checks on branch push and on merged pull request. @@ -12,7 +12,7 @@ on: - pull_request jobs: - rst-check: + checkrst: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 From abc601c008cb8cd184593b0158742fd68786868d Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 14 Jan 2023 01:35:20 +0000 Subject: [PATCH 08/17] Fixing warnings found by shellcheck. --- mps/tool/checkrst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/mps/tool/checkrst b/mps/tool/checkrst index c643b6f8256..2d7320159df 100755 --- a/mps/tool/checkrst +++ b/mps/tool/checkrst @@ -19,14 +19,14 @@ -path ./manual/tool -prune -o \ -type f -name '*.rst' -print find . -type f -name '*.txt' -print | - while read f; do - if head -1 -- "$f" | fgrep -q -e '-*- rst -*-'; then + while read -r f; do + if head -1 -- "$f" | grep -F -q -e '-*- rst -*-'; then echo "$f" fi done } | { code=0 - while read f; do + while read -r f; do if ! rst2html --report=2 --exit-status=2 "$f" > /dev/null; then code=1 fi From ec01a8cd0787db9d63f34556d443cbbc36a0b7f7 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 14 Jan 2023 09:33:00 +0000 Subject: [PATCH 09/17] Fixing duplicate tag design.mps.config.var introduced in commit a07f027f02 --- mps/design/config.txt | 2 +- mps/design/tests.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/mps/design/config.txt b/mps/design/config.txt index 0afb21d778f..7f6337c9e54 100644 --- a/mps/design/config.txt +++ b/mps/design/config.txt @@ -169,7 +169,7 @@ predefined when compiling the module sources:: CONFIG_VAR_ -_`.var`: The variety codes are as follows: +_`.var.codes`: The variety codes are as follows: _`.var.hot`: ``HOT`` diff --git a/mps/design/tests.txt b/mps/design/tests.txt index 4613447bd4b..93636ce9467 100644 --- a/mps/design/tests.txt +++ b/mps/design/tests.txt @@ -32,7 +32,7 @@ _`.run`: Run these commands:: where ```` is the appropriate makefile for the platform (see `manual/build.txt`_), ```` is the variety (see -design.mps.config.var_) and ```` is the collection of tests +design.mps.config.var.codes_) and ```` is the collection of tests (see `.target`_ below). For example:: make -f lii6ll VARIETY=cool testrun From 08ea75ae92333280dd34ac879de54280a2a3004b Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 14 Jan 2023 09:35:36 +0000 Subject: [PATCH 10/17] Oops, forgot to fix up the rst ref in commit ec01a8c --- mps/design/tests.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mps/design/tests.txt b/mps/design/tests.txt index 93636ce9467..c6c2686f5fd 100644 --- a/mps/design/tests.txt +++ b/mps/design/tests.txt @@ -40,7 +40,7 @@ design.mps.config.var.codes_) and ```` is the collection of tests If ```` is omitted, tests are run in both the cool and hot varieties. -.. _design.mps.config.var: config#.var +.. _design.mps.config.var.codes: config#.var.codes .. _manual/build.txt: https://www.ravenbrook.com/project/mps/master/manual/build.txt From 9536772ad7d1170d0aa5956f271b8f6c99b4f744 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 14 Jan 2023 10:01:17 +0000 Subject: [PATCH 11/17] Fixing duplicate tags introduced by 955c41b0fe as a consequence of 66a840b94 --- mps/design/poolamc.txt | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/mps/design/poolamc.txt b/mps/design/poolamc.txt index 5771ba5a1c3..5b1ef101da7 100644 --- a/mps/design/poolamc.txt +++ b/mps/design/poolamc.txt @@ -14,14 +14,20 @@ AMC pool class single: pool class; AMC design -Introduction -~~~~~~~~~~~~ +Guide Introduction +~~~~~~~~~~~~~~~~~~ -_`.intro`: This document contains a guide (`.guide`_) to the MPS AMC +.. The intro and readership tags were found to be duplicated by + changelist 182116 / commit e9841d23a but not referenced. But that + was just a consequence of two documents being smushed together by + RHSK in changelist 168424 / commit b0433b3e9: a guide and a design. + It would be good to sort that out. RB 2023-01-14 + +_`.guide.intro`: This document contains a guide (`.guide`_) to the MPS AMC pool class, followed by the historical initial design (`.initial-design`_). -_`.readership`: Any MPS developer. +_`.guide.readership`: Any MPS developer. Guide From d8d2c5018d1b4b2c9875c2e643a0eda1dbfb5131 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 14 Jan 2023 10:04:48 +0000 Subject: [PATCH 12/17] Fixing duplicate tag design.mps.arena.tract.field.base. looks like a copy-paste error. --- mps/design/arena.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mps/design/arena.txt b/mps/design/arena.txt index d3688296833..e8df0817c29 100644 --- a/mps/design/arena.txt +++ b/mps/design/arena.txt @@ -293,7 +293,7 @@ that the private representation can share a common prefix with private representation whether such an object is allocated or not, without requiring an extra field. -_`.tract.field.base`: The seg field is a pointer to the segment +_`.tract.field.seg`: The seg field is a pointer to the segment containing the tract, or ``NULL`` if the tract is not contained in any segment. From 40b4195a6a55f2dc0b73a45ad993fd69c8d38839 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 14 Jan 2023 10:07:29 +0000 Subject: [PATCH 13/17] Fixing duplicate tag design.mps.prmc.if.init.thread. looks like a copy-paste error. --- mps/design/prmc.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mps/design/prmc.txt b/mps/design/prmc.txt index 6c55634a8b0..8a5d71ad016 100644 --- a/mps/design/prmc.txt +++ b/mps/design/prmc.txt @@ -105,7 +105,7 @@ design.mps.check_. ``Res MutatorContextInitFault(MutatorContext context, ...)`` -_`.if.init.thread`: Initialize with the context of the mutator at the +_`.if.init.fault`: Initialize with the context of the mutator at the point where it was stopped by a protection fault. The arguments are platform-specific and the return may be ``void`` instead of ``Res`` if this always succeeds. From 1d3d8d844e7e66ce4a62b801f6c1590bc6778f93 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sun, 15 Jan 2023 20:00:57 +0000 Subject: [PATCH 14/17] Making script name more readable. --- mps/.github/workflows/rst-check.yml | 4 ++-- mps/tool/{checkrst => check-rst} | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) rename mps/tool/{checkrst => check-rst} (97%) diff --git a/mps/.github/workflows/rst-check.yml b/mps/.github/workflows/rst-check.yml index 57779a0e282..3463d5bb1e6 100644 --- a/mps/.github/workflows/rst-check.yml +++ b/mps/.github/workflows/rst-check.yml @@ -12,11 +12,11 @@ on: - pull_request jobs: - checkrst: + check-rst: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: Install docutils run: sudo apt-get install -y docutils - name: Check reStructuredText syntax - run: tool/checkrst + run: tool/check-rst diff --git a/mps/tool/checkrst b/mps/tool/check-rst similarity index 97% rename from mps/tool/checkrst rename to mps/tool/check-rst index 2d7320159df..02ee76b981d 100755 --- a/mps/tool/checkrst +++ b/mps/tool/check-rst @@ -1,5 +1,5 @@ #!/bin/sh -# tool/checkrst -- check syntax of reStructuredText in the MPS +# tool/check-rst -- check syntax of reStructuredText in the MPS # # Copyright (c) 2023 Ravenbrook Limited. See end of file for license. # From 48cf8253d32a0b7316ce94c6e3713a080255bf4b Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sun, 15 Jan 2023 20:10:53 +0000 Subject: [PATCH 15/17] Enabling manual triggering of restructuredtext syntax check. --- mps/.github/workflows/rst-check.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mps/.github/workflows/rst-check.yml b/mps/.github/workflows/rst-check.yml index 3463d5bb1e6..329b1b20431 100644 --- a/mps/.github/workflows/rst-check.yml +++ b/mps/.github/workflows/rst-check.yml @@ -10,6 +10,7 @@ on: # Run as part of CI checks on branch push and on merged pull request. - push - pull_request + - workflow_dispatch # allow manual triggering jobs: check-rst: From ab102cb8c737f5d84eb6ff22c61581abf8581043 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Tue, 17 Jan 2023 13:21:43 +0000 Subject: [PATCH 16/17] Clarifying that this checks the mps source tree, not the mps. signing. --- mps/tool/check-rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/mps/tool/check-rst b/mps/tool/check-rst index 02ee76b981d..66052e4a765 100755 --- a/mps/tool/check-rst +++ b/mps/tool/check-rst @@ -1,5 +1,6 @@ #!/bin/sh -# tool/check-rst -- check syntax of reStructuredText in the MPS +# tool/check-rst -- check syntax of reStructuredText in the MPS source tree +# Richard Brooksby, Ravenbrook Limited, 2023-01-13 # # Copyright (c) 2023 Ravenbrook Limited. See end of file for license. # From 398911b8c7cb503343d9b66393ad85a7e7c039cc Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Wed, 25 Jan 2023 21:06:19 +0000 Subject: [PATCH 17/17] Linking comment about smushed document to github issue 128 that logs it. --- mps/design/poolamc.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/mps/design/poolamc.txt b/mps/design/poolamc.txt index 5b1ef101da7..670dafd00a1 100644 --- a/mps/design/poolamc.txt +++ b/mps/design/poolamc.txt @@ -21,7 +21,8 @@ Guide Introduction changelist 182116 / commit e9841d23a but not referenced. But that was just a consequence of two documents being smushed together by RHSK in changelist 168424 / commit b0433b3e9: a guide and a design. - It would be good to sort that out. RB 2023-01-14 + It would be good to sort that out. See also + . RB 2023-01-14 _`.guide.intro`: This document contains a guide (`.guide`_) to the MPS AMC pool class, followed by the historical initial design