summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Silverstone <dsilvers@digital-scurf.org>2022-04-15 13:35:09 +0100
committerDaniel Silverstone <dsilvers@digital-scurf.org>2022-04-15 15:45:32 +0100
commit82959bdb8c60d32527ad9cc8ad07473eefcddc74 (patch)
tree81584b5adbf794cc11126d2170258bc7582a9f01
parent52a0c10bd81359ca28da8fb746558e739c38662b (diff)
downloadsubplot-82959bdb8c60d32527ad9cc8ad07473eefcddc74.tar.gz
(chore): Normalise NEWS file to - rather than *
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
-rw-r--r--NEWS.md59
1 files changed, 29 insertions, 30 deletions
diff --git a/NEWS.md b/NEWS.md
index 584eeef..416673c 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -26,12 +26,12 @@ the user of the Subplot software.
# Version 0.3.1, released 2021-11-16
-* The primary purpose of this release is to make the `PATH` bug fix
+- The primary purpose of this release is to make the `PATH` bug fix
available via crates.io, to fix use of Subplot in the Sequoia-PGP
project. There are no breaking changes, so only the patch level of
the version number is incremented.
-* The licence of Subplot has been changed to
+- The licence of Subplot has been changed to
[MIT-0](https://mit-license.org/), to make it as simple as possible
to use Subplot on other projects, without having to worry about
license compatibility. Previously, this was technically possible,
@@ -42,7 +42,7 @@ the user of the Subplot software.
though they would favor a copyleft licence otherwise, they're
willing to compromise this time.
-* A bug has been fixed in the Rust `lib/runcmd` function
+- A bug has been fixed in the Rust `lib/runcmd` function
implementation to prepend a directory to the `PATH`, in the
`subplotlib::steplibrary::runcmd::try_to_run_in` function. The bug
meant that the directories in `PATH` ended up in the wrong order.
@@ -55,7 +55,7 @@ This is still an ALPHA quality release, and includes breaking changes.
You definitely need to pay attention to these changes.
-* Subplot is moving to libraries and subplots being able to support
+- Subplot is moving to libraries and subplots being able to support
multiple step implementation languages at once. In this release,
bindings can indicate different functions for each language. Note
that a binding only needs to support one language. The new binding
@@ -72,7 +72,7 @@ You definitely need to pay attention to these changes.
cleanup: somelib::foo_cleanup
```
-* The Subplot code generator now uses the `pulldown-cmark` crate for
+- The Subplot code generator now uses the `pulldown-cmark` crate for
parsing Markdown input. The reason for this change is to not have to
have Pandoc installed in a CI or other environment that only
generates and runs test programs.
@@ -90,7 +90,7 @@ You definitely need to pay attention to these changes.
of Subplot is likely to introduce further changes, and we will
document the new metadata format then.
-* The generated test programs no longer clear the environment
+- The generated test programs no longer clear the environment
variables before running scenarios. This is partly to allow Subplot
to be more easily ported to operating systems other than Debian
(such as NixOS, but also Windows and macOS), but also because
@@ -100,7 +100,7 @@ You definitely need to pay attention to these changes.
where it is run: what software is installed, what services are
available, etc.
-* Subplot code generation now refuses documents that have no
+- Subplot code generation now refuses documents that have no
scenarios. Document generation still accepts them so that Subplot
can be used to produce typeset documents and web pages.
@@ -111,55 +111,54 @@ documents. They affect all uses of Subplot, regardless of step
implementation language and whether Subplot code or document
generation is used.
-* After a bug fix, Subplot now handles better the input files being
+- After a bug fix, Subplot now handles better the input files being
elsewhere than the current directory. If the Markdown input file is
in `foo/bar/yo.md`, the files referred to from the input file are
looked up relative to `foo/bar` instead of the current working
directory.
-* Subplot now has initial support for logging to make it easier to
+- Subplot now has initial support for logging to make it easier to
find out what it's doing, when it's doing something surprising. The
environment variables `SUBPLOT_LOG`, `SUBPLOT_LOG_FILE`, and
`SUBPLOT_LOG_FORMAT` (`oneline`, `json`, or `pretty`). What Subplot
logs is still rudimentary but will be improved over time. We'd
welcome suggestions.
-* The Subplot Debian package now builds in the resource into the
+- The Subplot Debian package now builds in the resource into the
Subplot binary.
-* Document titles can now use markup to indicate `literal` text.
+- Document titles can now use markup to indicate `literal` text.
-* Subplot now automatically handles versions of Pandoc that don't have
+- Subplot now automatically handles versions of Pandoc that don't have
a separate `pandoc-citeproc` binary, and want the `--citeproc`
option instead.
-* Subplot now works with version 1.48.0 of the Rust language and
+- Subplot now works with version 1.48.0 of the Rust language and
toolchain, in order to make it possible for the Sequoia-PGP project
to use Subplot.
## Python support
-* The generated Python test program now supports the `--run-all`
+- The generated Python test program now supports the `--run-all`
(`-k`) option to run all scenarios even if one or more fail.
## Rust support
-* Subplot now provides the `subplot-build` crate, for using Subplot
+- Subplot now provides the `subplot-build` crate, for using Subplot
code generation from another project's `build.rs` script.
-* We are in the process of elevating Rust into a supported language,
+- We are in the process of elevating Rust into a supported language,
so that it will be on par with Python. This release does not get
there, but starts the process.
## Bash support
-* We've not made much effort to improve the Bash support (modulo the
+- We've not made much effort to improve the Bash support (modulo the
environment cleanup). Compared to Python and Rust it is not a
well-support language in Subplot. Lars and Daniel do not feel it is
a target worth spending much of their free time on, but would
welcome help with that.
-
# Version 0.2.2, released 2021-08-07
This is release is meant for use by people other than Subplot's own
@@ -169,41 +168,41 @@ breaking changes in future releases.
## General
-* When a scenario step matches more than one binding, the error
+- When a scenario step matches more than one binding, the error
message now lists all the matching bindings to make it easier for
the user to fix the problem. (By Lars Wirzenius)
-* The documentation now explains core concepts relevant to Subplot,
+- The documentation now explains core concepts relevant to Subplot,
and suggests an initial workflow for a project using Subplot. (By
Lars Wirzenius)
## Python support
-* The `lib/daemon` Subplot library now uses custom Python code instead
+- The `lib/daemon` Subplot library now uses custom Python code instead
of the netcat tool. This removes a dependency, and also avoids the
problem of there being at least two more or less incompatible
versions of netcat in common use. (By Alexander Batischev)
-* The `lib/daemon` library now has a way to pass environment variables
+- The `lib/daemon` library now has a way to pass environment variables
to the daemon. (By Alexander Batischev)
## Bash support
-* The documentation now makes it clearer that the `files_get`
+- The documentation now makes it clearer that the `files_get`
function returns the contents of the embedded file and not a
filename. (By Richard Maw)
-* Some spelling and other language mistakes have been fixed in the
+- Some spelling and other language mistakes have been fixed in the
documentation for Bash support. (By Richard Maw)
-* The `dict` helper functions can now read embedded files. (By Richard
+- The `dict` helper functions can now read embedded files. (By Richard
Maw)
-* The generated Bash test program now supports the `--env` option to
+- The generated Bash test program now supports the `--env` option to
let the user pass in environment variables when invoking the test
program. (By Richard Maw)
-* Assertion functions now return an error rather then terminating the
+- Assertion functions now return an error rather then terminating the
test program. This lets cleanups run. (By Richard Maw)
# Version 0.2.1, released 2021-07-11
@@ -211,17 +210,17 @@ breaking changes in future releases.
This is the first release meant for use by people other than Subplot's
own developers.
-* The locations of the `dot` and `plantuml` programs and for the Java
+- The locations of the `dot` and `plantuml` programs and for the Java
byte code interpreter can now be configured when Subplot is invoked,
which is useful when they're not installed in the locations where
Debian puts them. Those programs are used by Subplot to render
diagrams.
-* The `./check` script now outputs the last one hundred lines or so of
+- The `./check` script now outputs the last one hundred lines or so of
the log file produced by the generated test program, if that program
fails. This makes it easier to debug failures under CI.
-* Additionally, there have been some minor tweaks only visible to
+- Additionally, there have been some minor tweaks only visible to
those developing Subplot itself.
# Version 0.2.0, released 2021-06-12