document 'make workspace'

diff --git a/Makefile b/Makefile
index c6c80eb1068eb9b0fa7a810db2a6779ef651c44b..01d7298aa64dc8bec4d0b12eebb1a96215d5d1c3 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -5,29 +5,35 @@ WORKSPACEFILES=$(addprefix workspace/,$(FILES))
 all: docs workspace crates
 .PHONY: docs workspace crates
 
 all: docs workspace crates
 .PHONY: docs workspace crates
 

-# Documentation
+## Documentation

 docs: $(DOCFILES)
 
 .tmp/docs/%.rs: src/%.rs Makefile
        @mkdir -p .tmp/docs
        @echo "$< -> $@"
 docs: $(DOCFILES)
 
 .tmp/docs/%.rs: src/%.rs Makefile
        @mkdir -p .tmp/docs
        @echo "$< -> $@"

-       @sed 's|^\(\s*//\)@|\1|;s|\s*/\*@\*/||' $< > $@
+       @# sed-fu: remove the "@" from "//@", and remove trailing "/*@*/".
+       @sed 's|^\(\s*//\)@|\1|;s|\s*/\*@\*/$$||' $< > $@

 
 docs/%.html: .tmp/docs/%.rs
        @./pycco-rs $<
 
 
 docs/%.html: .tmp/docs/%.rs
        @./pycco-rs $<
 

-# Workspace
+## Workspace
+# The generated files are shipped only for the benefit of Windows users, who
+# typically don't have the necessary tools for generating the workspace
+# available.

 workspace: $(WORKSPACEFILES)
 
 workspace/src/%.rs: src/%.rs Makefile dup-unimpl.sed
        @mkdir -p .tmp/docs
        @echo "$< -> $@"
 workspace: $(WORKSPACEFILES)
 
 workspace/src/%.rs: src/%.rs Makefile dup-unimpl.sed
        @mkdir -p .tmp/docs
        @echo "$< -> $@"

+       @# sed-fu: remove lines starting with "//@", and replace those ending in "/*@*/" by "unimplemented!()".
+       @# Also coalesce multiple adjacent such lines to one.

        @sed '/^\s*\/\/@/d;s|\(\s*\)\S.*/\*@\*/|\1unimplemented!()|' $< | sed -f dup-unimpl.sed > $@
 
 workspace/src/main.rs:
        # Don't touch this file
 
        @sed '/^\s*\/\/@/d;s|\(\s*\)\S.*/\*@\*/|\1unimplemented!()|' $< | sed -f dup-unimpl.sed > $@
 
 workspace/src/main.rs:
        # Don't touch this file
 

-# Crates
+## Crates

 crates: $(WORKSPACEFILES)
        @cargo build
        @cd solutions && cargo build
 crates: $(WORKSPACEFILES)
        @cargo build
        @cd solutions && cargo build

diff --git a/README.rst b/README.rst
index 8254d96f957638145c39d57ace25ebfa0205d519..3d4188fa0af5fcb167eda04962de7d764c085bca 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -12,6 +12,8 @@ You can either read through the sources in ``src/``, or generate the HTML in
 ``docs/`` using ``make docs`` (this step needs Pycco_), or go directly to 
 `the rendered output`_.
 
 ``docs/`` using ``make docs`` (this step needs Pycco_), or go directly to 
 `the rendered output`_.
 

+The files ``workspace/src/part*.rs`` are generated by ``make workspace``.
+

 .. _Pycco: https://fitzgen.github.io/pycco/
 .. _the rendered output: https://www.ralfj.de/projects/rust-101/main.html
 
 .. _Pycco: https://fitzgen.github.io/pycco/
 .. _the rendered output: https://www.ralfj.de/projects/rust-101/main.html