Skip to content

Commit 99e49de

Browse files
authored
Add version 0.5 and its publishing date to the utxo-db-api doc (#1438)
Soon, we'll publish a technical report that is related to lsm-tree, which refers to version 0.5 of the "Storing the Cardano ledger state on disk: API design concepts" document. Currently the latter only mentions version 0.6 on its title page, but to reduce confusion with publishing dates, we'll also add version 0.5 to the list of published versions, with the appropriate date. I'v added changelogs to the two `utxo-db` and `utxo-db-api` docs, to facilitate the versioning information. The changelogs look something like this: ![image](https://github.com/user-attachments/assets/f6132fea-d578-466d-a71a-028773a677c0) ![image](https://github.com/user-attachments/assets/44920a03-8423-4762-88cf-281d8aad4fd8)
2 parents 9129bb0 + 2e6872f commit 99e49de

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

docs/tech-reports/utxo-db/utxo-db-api.tex

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
\usetikzlibrary{shapes.geometric}
1515
\usetikzlibrary{matrix}
1616
\usepackage{natbib}
17+
\usepackage{changelog}
1718
\usepackage{hyperref}
1819
\usepackage[capitalise,noabbrev,nameinlink]{cleveref}
1920
\hypersetup{
@@ -43,6 +44,11 @@
4344

4445
\maketitle
4546

47+
\begin{changelog}[simple, sectioncmd=\section*]
48+
\shortversion{author=Joris Dral, v=0.6, date=August 2023, changes={Editorial changes, final version}}
49+
\shortversion{author={Duncan Coutts, Douglas Wilson}, v=0.5, date=November 2021, changes=Unfinished version}
50+
\end{changelog}
51+
4652
\section{Purpose}
4753

4854
This document is intended to explore and communicate -- to a technical audience

docs/tech-reports/utxo-db/utxo-db.tex

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
\usepackage{dcolumn}
1313
\usepackage{graphicx}
1414
\usepackage{natbib}
15+
\usepackage{changelog}
1516
\usepackage{hyperref}
1617
\usepackage[capitalise,noabbrev,nameinlink]{cleveref}
1718
\hypersetup{
@@ -34,6 +35,10 @@
3435

3536
\maketitle
3637

38+
\begin{changelog}[simple, sectioncmd=\section*]
39+
\shortversion{author={Duncan Coutts, Douglas Wilson}, v=1.0, date=April 2021, changes=Final version}
40+
\end{changelog}
41+
3742
\section{Introduction}
3843
\label{introduction}
3944

@@ -1124,7 +1129,7 @@ \subsubsection{B+ trees}
11241129
existing Haskell implementation of a B+ tree on hackage%
11251130
\footnote{\url{https://hackage.haskell.org/package/haskey}}.
11261131

1127-
We do not expect to be able to meet the minimum performance targets (see
1132+
We do not expect to be able to meet the minimum performance targets (see
11281133
\cref{performance-requirements}) with a B+ tree based solution. The ability to
11291134
reuse an existing implementation is a clear benefit for development time. This
11301135
could therefore be a useful interim solution, on route to the final delivery.

0 commit comments

Comments
 (0)