summaryrefslogtreecommitdiff
path: root/subplot.md
AgeCommit message (Collapse)AuthorFilesLines
2021-10-08subplot.md: Add a missing scenario in test inputDaniel Silverstone1-0/+31
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-09-18chore: Fix up embedded metadata blocks in subplot.mdDaniel Silverstone1-58/+60
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-09-16feat! parse Markdown input with pull-cmark instead of PandocLars Wirzenius1-19/+17
This is a first step towards being able to use Subplot codegen from a project's build.rs, and with only pure-Rust build dependencies. Replace Pandoc for parsing Markdown input with pulldown-cmark. This is mostly a drop-in replacement, but not entirely. The YAML parsing is more strict now. Note that this is a breaking change. Some subplots that used to work, and still work with docgen, no longer work with the new parser. Major differences are: * Only specific fields are supported. All the Markdown files in the Subplot source tree work. If anything else is needed, and it likely is, the new parser needs to be extended. * The bindings, functions, classes, and bibliography fields MUST be lists of strings. A single string value will no longer work. Sponsored-by: pep.foundation
2021-09-13Merge branch 'multi-lang-docs' into 'main'Lars Wirzenius1-39/+152
Implement polyglot bindings See merge request subplot/subplot!210
2021-09-11subplot.md: Improve bindings documentationDaniel Silverstone1-10/+50
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-09-09fix: handle most inline markup in metadata titlesLars Wirzenius1-0/+22
Actually, we only didn't handle `foo` code markup. Sponsored-by: author
2021-09-07subplot: Properly support polyglot bindingsDaniel Silverstone1-0/+21
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-09-07bindings: Parse polyglot bindingsDaniel Silverstone1-29/+81
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-08-24fix: arch diagram says steps can be written in Bash, Python, RustLars Wirzenius1-6/+6
Sponsored-by: author
2021-07-31docs: explain concepts, suggest a workflowLars Wirzenius1-0/+44
Sponsored-by: author
2021-07-20feat: when more than one bindings match a step, list all of themLars Wirzenius1-2/+19
Sponsored-by: author
2021-07-13Fix implemented typoRichard Maw1-1/+1
2021-07-12Fix html typoRichard Maw1-1/+1
I'm assuming this was accidental since the intended error is a missing input file.
2021-07-12Fix typo of officiallyRichard Maw1-1/+1
Could've gone either way to official or officially but I guessed probably meant to be officially, since "official stamped" implies separate attributes which would otherwise be comma or and separated while "officially stamped" is a compound attribute.
2021-07-12Fix typo in precond_fooRichard Maw1-2/+2
I'm assuming these were meant to be _done rather than _none since later functions use _done and the names are close together.
2021-07-12Fix typoRichard Maw1-1/+1
2021-07-12Make it a little more obvious file helpers return contentsRichard Maw1-2/+2
While reading through the lack of examples left it not obvious whether the embedded file helpers returned a path to a resource or temporary file, or the contents of the file itself.
2021-06-11subplot.md: Test JSON should be sortedDaniel Silverstone1-7/+7
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-06-09fix: typos in architecture diagramsLars Wirzenius1-2/+2
Sponsored-by: author
2021-05-01bin: sp-filter -> subplot-filterDaniel Silverstone1-7/+7
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-05-01subplot: Add delay step in some scenariosDaniel Silverstone1-0/+4
In order to work on filesystems where the time granularity is not sub-second, some scenarios need to wait a bit. Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-04-24subplot.md: Document scenario language a bit moreDaniel Silverstone1-0/+76
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-04-09subplot.md: Use subplot extract rather than sp-extractDaniel Silverstone1-2/+2
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-04-09subplot.md: Use subplot metadata over sp-metaDaniel Silverstone1-8/+8
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-04-09testing: Rework sp-{doc,code}gen into subplot {doc,code}gen in testsDaniel Silverstone1-65/+65
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-02-13feat: allow subplot.md to be used to test an installed SubplotLars Wirzenius1-0/+48
2021-02-11doc(subplot.md): add section to explain given/when/thenLars Wirzenius1-0/+45
We may want to copy or move this to a separate, more user-oriented document later, but this is the one place we currently have for Subplot documentation.
2021-02-11doc(subplot.md): move section on metadata after general markup oneLars Wirzenius1-30/+30
It seems more logical to discuss markup in general first and the YAML metadata detail later.
2021-02-11fix(subplot.md): add missing template to YAML metadata exampleLars Wirzenius1-0/+1
This is an example that's never parsed by Subplot so the missing "template" has gone unnoticed.
2021-01-16subplot.md: Add example of noNumberLinesDaniel Silverstone1-0/+35
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2020-12-18check: Add verification of bad filename checkDaniel Silverstone1-0/+33
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2020-12-18subplot.md: Document the type map a littleDaniel Silverstone1-2/+23
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2020-12-03subplot.md: Add missing template metadata entriesDaniel Silverstone1-0/+19
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2020-12-03chore: Add template metadata to top level subplotsDaniel Silverstone1-0/+1
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2020-12-02test: add scenario for testing value expansionLars Wirzenius1-0/+61
2020-11-21Merge branch 'env' into 'main'Daniel Silverstone1-0/+60
add --env to generated Python test programs See merge request larswirzenius/subplot!97
2020-11-21fix: document structureLars Wirzenius1-1/+1
2020-11-19add scenarioLars Wirzenius1-0/+60
2020-11-17fix: set TMPDIR for each scenario to its datadirLars Wirzenius1-0/+50
2020-11-05doc: Add info and scenario for pikchrDaniel Silverstone1-0/+41
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2020-10-19Merge branch 'spelling' into 'main'Lars Wirzenius1-1/+1
Fixed a spelling mistake. Closes #89 See merge request larswirzenius/subplot!87
2020-10-19Fixed a spelling mistake.Dan Alderman1-1/+1
2020-10-05fix: handle all kinds of inline elements in titles, headingsLars Wirzenius1-0/+40
This only matters for codegen and others who interpret the document title and headings as text. Docgen handles everything via Pandoc already.
2020-09-28refactor(subplot.{py,yaml}): use steps/functions from lib/runcmdLars Wirzenius1-0/+1
Drop the (many) steps and step functions to run Subplot binaries and use the ones from lib/runcmd instead
2020-09-28fix(subplot.{md,py,yaml}): run Subplot binaries from the source treeLars Wirzenius1-0/+44
This is akin to installing them to a directory in PATH. Instead of doing that, we amend PATH so that the directory in the source tree with the binaries are in there. This adds a "given an installed subplot" step to every scenario that needs to run a Subplot binary.
2020-09-28refactor(subplot.{md,yaml}): rename steps to check outputLars Wirzenius1-19/+19
The old steps "then output matches /.../" and "stderr matches /.../" come originally from runcmd.yaml. For lib/runcmd.yaml they have been replaced with 'then stdout contains "..."' and 'stderr contains "..."'. Change all uses of the old wording to the new one. Don't use lib/runcmd.yaml yet, but keep the binding subplot.yaml to bind the new wording to the function from lib/runcmd.py (which it did before already, so no change).
2020-09-28refactor(subplot.{md,yaml}): rename step to check for successLars Wirzenius1-15/+15
The old step "then program finished successfully" comes originally from runcmd.yaml. For lib/runcmd.yaml it has been replaced with "then command is successful". Change all uses of the old wording to the new one. Don't use lib/runcmd.yaml yet, but keep the binding subplot.yaml to bind the new wording to the function from lib/runcmd.py (which it did before already, so no change).
2020-09-28refactor(subplot.{md,yaml}): rename step step to check for failureLars Wirzenius1-14/+14
The old step "then exit code is non-zero" comes originally from runcmd.yaml. For lib/runcmd.yaml it has been replaced with "then command fails". Change all uses of the old wording to the new one. Don't use lib/runcmd.yaml yet, but keep the binding subplot.yaml to bind the new wording to the function from lib/runcmd.py (which it did before already, so no change).
2020-09-28refactor(subplot.{md,py,yaml}): use step functions from lib/runcmd.pyLars Wirzenius1-2/+1
Use the Python functions from lib/runcmd.py instead of the ones from ./runcmd.py. This changes some bindings in subplot.yaml to use functions from lib/runcmd.py, and changes some step functions in subplot.py to be defined in terms of functions in lib/runcmd.py. The actual steps in subplot.md are not changed and no bindings from lib/runcmd.yaml are yet used. Some bindings that used to come from runcmd.yaml are here added to subplot.yaml. This is temporary change that will be undone later by replacing those bindings with ones from lib/runcmd.yaml, but doing that in this commit would make it bigger and harder to follow.
2020-09-26Merge branch 'patterns' into 'main'Daniel Silverstone1-3/+19
add: simple word pattern kinds Closes #85 See merge request larswirzenius/subplot!73
generated by cgit v1.2.1 (git 2.18.0) at 2024-05-14 12:21:15 +0000