Skip to content

Commit

Permalink
Get ready for "semver" version.
Browse files Browse the repository at this point in the history
  • Loading branch information
kristapsdz committed Dec 31, 2024
1 parent eec3dfe commit b72d4b7
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 3 deletions.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ sinclude Makefile.local
# while libraries have well-defined semantics of semver change, programs
# do not. Let the library guide our versioning until a better way is
# thought out.
VERSION = 1.4.0
VERSION = 2.0.0
# This is the major number of VERSION. It might later become
# MAJOR.MINOR, if the library moves a lot.
LIBVER = 1
LIBVER = 2
OBJS = autolink.o \
buffer.o \
diff.o \
Expand Down
10 changes: 9 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
title: lowdown --- simple markdown translator
date: 2021-09-23
date: 2024-12-30
author: Kristaps Dzonsons

# [%title]
Expand Down Expand Up @@ -44,6 +44,14 @@ output. This enables some semantic analysis of the content such as with
the [difference engine](https://kristaps.bsd.lv/lowdown/diff.html),
which shows the difference between two markdown trees in markdown.

As of version 2.0.0, *lowdown* uses
[semantic versioning](https://semver.org/) ("semver"). A major number
change indicates a change in the
[lowdown(3)](https://kristaps.bsd.lv/lowdown/lowdown.3.html) API, a
minor number indicates a change in functionality, and a patch number
indicates a bug-fix or change without functionality. The version 2.0.0
reflects API changes in 1.4.0 that preceded.

## Output

*lowdown* produces HTML5 output with **-thtml**,
Expand Down
31 changes: 31 additions & 0 deletions versions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1762,4 +1762,35 @@
</p>
</aside>
</article>
<article data-sblg-article="1" data-sblg-tags="version">
<header>
<h1>2.0.0</h1>
<address>Kristaps Dzonsons</address>
<time datetime="2024-12-30">2024-12-30</time>
</header>
<aside>
<p>
Formalise using semantic versioning (<q>semver</q>).
The prior version (1.4.0) introduced API changes that were
incompatible: future versions will follow semver to
prevent confusion.
</p>
<p>
Adds some missing template files to the share directory.
</p>
<p>
Lastly, to address downstream breakage when using nested
Mac OS X sandboxes, a special argument
<code>SANDBOX_INIT_ERROR_IGNORE</code> value may be passed
during the <code>make</code> build sequence.
If set to <code>always</code>, errors from the underlying
Mac OS X sandbox are always ignored.
If set to any other value, the user must set the
environment variable
<code>SANDBOX_INIT_ERROR_IGNORE</code> to ignore these
errors. This is only relevant to Mac OS X builds with the
sandbox feature enabled during configuration.
</p>
</aside>
</article>
</articles>

0 comments on commit b72d4b7

Please sign in to comment.