Skip to content

Commit fa0d47a

Browse files
author
moonshine
committed
adding toc preprocessor tag to documentation files
FossilOrigin-Name: 6cfa46432830d1c14bd3456feec4a6f97495d5464b520b2b5f393a85f3d59807
1 parent 63ea7e6 commit fa0d47a

34 files changed

+66
-140
lines changed

‎CODE-OF-CONDUCT.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
<!-- SPDX-FileType: Documentation -->
77
<!-- SPDX-FileComment: Original by Dan Shearer, December 2019 -->
88

9+
<!-- toc -->
10+
911
# LumoSQL Code of Conduct
1012

1113
Version 1.5 – Updated 18th February, 2022
@@ -16,7 +18,7 @@ about mandating kindness. We are in a global pandemic when kindness is needed mo
1618
than ever.**
1719

1820
The LumoSQL Project welcomes contributions from anyone who shares
19-
[the LumoSQL Project Goals](https://lumosql.org/src/lumodoc/doc/trunk/doc/lumo-project-aims.md)
21+
[the LumoSQL Project Goals](./doc/about-design-philosophy.md)
2022
This document outlines both expected and prohibited behaviour.
2123

2224
# Short Summary
@@ -137,7 +139,7 @@ accepted or tolerated.
137139

138140
If you believe you’re experiencing unacceptable behaviour
139141
as outlined above please contact one of the
140-
[current authors](https://lumosql.org/src/lumosql/file?name=AUTHORS).
142+
[current authors](./AUTHORS).
141143

142144
After receiving a concise description of your situation, they will review and
143145
determine next steps.

‎CONTRIBUTING.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
<!-- SPDX-FileType: Documentation -->
77
<!-- SPDX-FileComment: Original by Dan Shearer, December 2019 -->
88

9+
<!-- toc -->
10+
911
# Contributing to the LumoSQL Project
1012

1113
Welcome! We'd love to have your contributions to [the LumoSQL
@@ -111,6 +113,6 @@ You can address the bot directly and chat with it, including by the shortcut "@
111113

112114
> <font size="6"> &#9757;&#127998; </font> The meeting logs are just HTML files, so if something *really* incorrect gets into the notes by accident we can edit them manually. But this should be very rare.
113115
114-
> Obviously, chat in #lumosql is covered by the [LumoSQL Code of Conduct](../CODE-OF-CONDUCT.md), which says "be a decent person".
116+
> Obviously, chat in #lumosql is covered by the [LumoSQL Code of Conduct](./CODE-OF-CONDUCT.md), which says "be a decent person".
115117
116118

‎LICENCES/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This directory contains the licence which applies to all material in the LumoSQL
44

55
# MIT Licence
66

7-
The [MIT License](https://en.wikipedia.org/wiki/MIT_License) applies to all
7+
The [MIT Licence](https://en.wikipedia.org/wiki/MIT_License) applies to all
88
files in this project. The MIT licence is the most-widely used Open Source
99
licence, including by some of the world's largest companies. The MIT licence
1010
grants everyone the right to use the code for any purpose under copyright law.
@@ -13,9 +13,9 @@ Every file should have a copyright statement at the top and also a
1313
it doesn't, the MIT licence still applies. It also applies to any file which is
1414
not clearly code, such as configuration or input data.
1515

16-
The [LumoSQL Documentation](https://lumosql.org/src/lumodoc/doc/tip/doc/README.md)
17-
is also generally covered by this MIT License. There are documentation-specific
18-
licenses and we will adopt one of them if the MIT License ever becomes a problem.
16+
The [LumoSQL Documentation](https://web.lumosql.org)
17+
is also generally covered by this MIT licence. There are documentation-specific
18+
licences and we will adopt one of them if the MIT licence ever becomes a problem.
1919

2020
To even further avoid potential misunderstanding, we maintain the site
21-
[license.lumosql.org](https://license.lumosql.org) with the full text of the MIT License.
21+
[license.lumosql.org](https://license.lumosql.org) with the full text of the MIT Licence.

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
<!-- SPDX-FileType: Documentation -->
77
<!-- SPDX-FileComment: Original by Dan Shearer, December 2019 -->
88

9+
<!-- toc -->
10+
911
# LumoSQL
1012

1113
[LumoSQL](lumosql.org) is a modification (not a fork) of the

‎doc/about-backends.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
<!-- SPDX-FileType: Documentation -->
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2019 -->
66

7+
<!-- toc -->
78

89
# LumoSQL Backend Storage Engines
910

‎doc/about-benchmarking.md

+1-15
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,7 @@
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2020 -->
66

77

8-
Table of Contents
9-
=================
10-
11-
* [About Benchmarking](#about-benchmarking)
12-
* [All SQLite Performance Papers are Nonsense](#all-sqlite-performance-papers-are-nonsense)
13-
* [Limiting the Problem Space](#limiting-the-problem-space)
14-
* [What Questions Will Benchmarking Answer?](#what-questions-will-benchmarking-answer)
15-
* [Details of Benchmarking Code](#details-of-benchmarking-code)
16-
* [Metrics](#metrics)
17-
* [SQL in benchmark.tcl](#sql-in-benchmarktcl)
18-
* [SQL Logic Test](#sql-logic-test)
19-
* [C speed tests with SQLite C API](#c-speed-tests-with-sqlite-c-api)
20-
* [Computer architectures and operating systems](#computer-architectures-and-operating-systems)
21-
* [C speed tests with the SQLite/LumoSQL KV API](#c-speed-tests-with-the-sqlitelumosql-kv-api)
22-
* [List of Relevant Benchmarking and Test Knowledge](#list-of-relevant-benchmarking-and-test-knowledge)
8+
<!-- toc -->
239

2410
About Benchmarkings
2511
==================

‎doc/about-design-philosophy.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
<!-- SPDX-FileType: Documentation -->
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2022 -->
66

7+
<!-- toc -->
8+
79
# LumoSQL enforces rules by data guarantees.
810

911
Normally it is the algorithms in software that enforce rules, for example You do not have permission to read salary information for that person. That rule is written in just one program, written by just one developer. What if the developer made a mistake? What if it is your own salary information but the algorithm doesn’t know that? This is how everyday problems occur that make people say “computers are just so stupid”. With LumoSQL, that same salary data is encrypted with several cryptographic keys. One of those keys will belong to the person whose salary it is, so they can always read it. Another one will belong to the HR group in the company, so anyone who has a key that belongs to that group can read the data and update it. And another read-only key may be issued to the tax department, and that key stops working as soon as there is a change to the salary data.

‎doc/about-encryption.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
<!-- SPDX-FileType: Documentation -->
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2022 -->
66

7+
<!-- toc -->
8+
79
# Encryption
810

911
LumoSQL open source encryption to replace [SQLCipher](https://www.zetetic.net/sqlcipher/)/[SEE](https://www.hwaci.com/sw/sqlite/see.html). The authors of SQLite produce the closed-source SQLite Encryption Extension (SEE). There are several open source solutions to replace SEE, the most popular of which is SQLCipher, which has an open source version with limited functionality. Closed source encryption is not acceptable for privacy or security in the 21st century. The first version of this will be exposing the page-level crypto in LMDBv1.0 via the new LumoSQL crypto API, with metadata handled by the new pragmas.

‎doc/about-goals.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,7 @@
55
<!--- SPDX-FileComment: Original by Dan Shearer, 2020 --->
66

77

8-
Table of Contents
9-
=================
10-
11-
* [Overall Objective of LumoSQL](#overall-objective-of-lumosql)
12-
* [The Advantages of LumoSQL](#the-advantages-of-lumosql)
13-
* [Development Goals](#developmenr-goals)
8+
<!-- toc -->
149

1510

1611
![](./images/lumo-project-aims-intro.jpg "Mongolian horseback archery, rights request pending from https://www.toursmongolia.com/")

‎doc/about-legal-aspects.md

+2-11
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,9 @@
44
<!-- SPDX-FileType: Documentation -->
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2020 -->
66

7-
![](./images/lumo-legal-aspects-intro.png "XXXXXXXX")
8-
9-
Table of Contents
10-
=================
7+
<!-- toc -->
118

12-
* [LumoSQL Licensing](#lumosql-licensing)
13-
* [Why MIT? Why Not MIT?](#why-mit-why-not-mit)
14-
* [In Detail: Patents, MIT and Apache 2.0](#in-detail-patents-mit-and-apache-20)
15-
* [In Detail: the SQLite Public Domain Licensing Problem](#in-detail-the-sqlite-public-domain-licensing-problem)
16-
* [History and Rationale](#history-and-rationale)
17-
* [Encryption Legal Issues](#encryption-legal-issues)
18-
* [LumoSQL Requirements and Decisions](#lumosql-requirements-and-decisions)
9+
![](./images/lumo-legal-aspects-intro.png "XXXXXXXX")
1910

2011
# LumoSQL Licensing
2112

‎doc/about-not-forking-tool.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
<!-- SPDX-FileType: Documentation -->
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2022 -->
66

7+
<!-- toc -->
78

89
Not-Forking Upstream Source Code Tracker
910
========================================

‎doc/context-development-landscape.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,7 @@
55
<!--- SPDX-FileComment: Original by Dan Shearer, 2020 --->
66

77

8-
Table of Contents
9-
=================
10-
11-
* [LumoSQL Context](#lumosql-context)
12-
* [The SQLite Landscape](#the-sqlite-landscape)
13-
* [LumoSQL and The SQLite Project](#lumosql-and-the-sqlite-project)
14-
* [SQLite Downstreams](#sqlite-downstreams)
15-
* [How Widely-used is SQLite Compared to Others?](#how-widely-used-is-sqlite-compared-to-others)
16-
8+
<!-- toc -->
179

1810

1911
![](./images/lumo-ecosystem-intro.png "LumoSQL logo")

‎doc/context-development-notes.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,7 @@
44
<!--- SPDX-FileType: Documentation --->
55
<!--- SPDX-FileComment: Original by Dan Shearer, 2020 --->
66

7-
8-
9-
Table of Contents
10-
=================
11-
12-
* [LumoSQL 2019 Prototype Conclusions And Lessons](#lumosql-2019-prototype-conclusions-and-lessons)
13-
* [Facts Established by 2019 LumoSQL Prototype](#facts-established-by-2019-lumosql-prototype)
14-
* [Lessons Learned from sqlightning](#lessons-learned-from-sqlightning)
15-
7+
<!-- toc -->
168

179
![](./images/lumo-ecosystem-intro.png "LumoSQL logo")
1810

‎doc/context-online-database-servers.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,7 @@
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2020 -->
66

77

8-
Table of Contents
9-
=================
10-
11-
* [LumoSQL Architecture](#lumosql-architecture)
12-
* [Online Database Servers](#online-database-servers)
13-
* [SQLite as an Embedded Database](#sqlite-as-an-embedded-database)
14-
8+
<!-- toc -->
159

1610
LumoSQL Architecture
1711
====================

‎doc/context-relevant-codebases.md

+1-14
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,7 @@
44
<!--- SPDX-FileType: Documentation --->
55
<!--- SPDX-FileComment: Original by Dan Shearer, 2019 --->
66

7-
8-
Table of Contents
9-
=================
10-
11-
* [Codebases Relevant to LumoSQL](#codebases-relevant-to-lumosql)
12-
* [What is a Relevant Codebase?](#what-is-a-relevant-codebase)
13-
* [Useful Dead SQLite Forks](#useful-dead-sqlite-forks)
14-
* [Oracle BDB and Oracle BDB-SQL Codebases](#oracle-bdb-and-oracle-bdb-sql-codebases)
15-
* [Distributed or Clustered Codebases](#distributed-or-clustered-codebases)
16-
* [Modular Code to Potentially Incorporate in LumoSQL](#modular-code-to-potentially-incorporate-in-lumosql)
17-
* [On-disk File Format-related Knowledge](#on-disk-file-format-related-knowledge)
18-
* [List of Relevant Benchmarking and Test Knowledge](#list-of-relevant-benchmarking-and-test-knowledge)
19-
* [SQLite and Encryption Issues](#sqlite-and-encryption-issues)
20-
* [List of from-scratch MySQL SQL and MySQL Server implementations](#list-of-from-scratch-mysql-sql-and-mysql-server-implementations)
7+
<!-- toc -->
218

229
Codebases Relevant to LumoSQL
2310
=============================

‎doc/context-relevant-knowledgebase.md

+1-11
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,7 @@
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2019 -->
66

77

8-
Table of Contents
9-
=================
10-
11-
* [Knowledge Relevant to LumoSQL](#knowledge-relevant-to-lumosql)
12-
* [List of SQLite Code-related Knowledge](#list-of-sqlite-code-related-knowledge)
13-
* [List of MVCC-capable KV store-related Knowledge](#list-of-mvcc-capable-kv-store-related-knowledge)
14-
* [List of On-disk SQLite Format-related Knowledge](#list-of-on-disk-sqlite-format-related-knowledge)
15-
* [List of Relevant SQL Checksumming-related Knowledge](#list-of-relevant-sql-checksumming-related-knowledge)
16-
* [List of Relevant Benchmarking and Test Knowledge](#list-of-relevant-benchmarking-and-test-knowledge)
17-
* [List of Just a Few SQLite Encryption Projects](#list-of-just-a-few-sqlite-encryption-projects)
18-
* [List of from-scratch MySQL SQL and MySQL Server implementations](#list-of-from-scratch-mysql-sql-and-mysql-server-implementations)
8+
<!-- toc -->
199

2010
Knowledge Relevant to LumoSQL
2111
=============================

‎doc/context-wals.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,7 @@
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2020 -->
66

77

8-
Table of Contents
9-
=================
10-
11-
12-
* [Database Storage Systems](#database-storage-systems)
13-
* [WALs in SQLite](#wals-in-sqlite)
14-
* [Single-level Store](#single-level-store)
8+
<!-- toc -->
159

1610

1711
# How LumoSQL Architecture Differs from SQLite

‎doc/context-what-are-savepoints.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
<!-- SPDX-FileType: Documentation -->
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2020 -->
66

7+
<!-- toc -->
8+
79
# Observations on Savepoints in SQLite Internals
810

911
Dan Shearer

‎doc/design-api.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,7 @@
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2020 -->
66

77

8-
Table of Contents
9-
=================
10-
11-
* [SQLite API Interception Points](#sqlite-api-interception-points)
12-
13-
8+
<!-- toc -->
149

1510
![](./images/lumo-implementation-intro.jpg "Metro Station Construction Futian Shenzhen China, CC license, https://www.flickr.com/photos/dcmaster/36740345496")
1611

‎doc/design-corruption-detection-and-magic.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,7 @@
44
<!-- SPDX-FileType: Documentation -->
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2020 -->
66

7-
Table of Contents
8-
=================
9-
10-
* [Summary of SQL Database Corruption Detection](#summary-of-sql-database-corruption-detection)
11-
* [SQLite and Integrity Checking](#sqlite-and-integrity-checking)
12-
* [LumoSQL Checksums and the SQLite On-disk File Format](#lumosql-checksums-and-the-sqlite-on-disk-file-format)
13-
* [Design of the SQLite Checksum VFS Loadable Extension](#design-of-the-sqlite-checksum-vfs-loadable-extension)
14-
* [Goals for Corruption Detection](#goals-for-corruption-detection)
15-
* [Design for Corruption Detection](#design-for-corruption-detection)
16-
* [For Non-row Data](#for-non-row-data)
17-
* [For Row Data](#for-row-data)
18-
* [Implementation for Corruption Detection](#implementation-for-corruption-detection)
19-
7+
<!-- toc -->
208

219
![](./images/lumo-corruption-detection-and-magic-intro.png "Not Yet Done")
2210

‎doc/design-rbac.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
<!-- SPDX-FileType: Documentation -->
77
<!-- SPDX-FileComment: Original by Dan Shearer, August 2020 -->
88

9+
<!-- toc -->
10+
911
LumoSQL Minimal At-Rest Discretionary Access Control System
1012
===========================================================
1113

‎doc/design-virtual-machine.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<!-- SPDX-FileType: Documentation -->
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2020 -->
66

7-
7+
<!-- toc -->
88

99
SQLite Virtual Machine Layer
1010
----------------------------

‎doc/how-to-install.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
<!-- SPDX-FileType: Documentation -->
55
<!-- SPDX-FileComment: Original by Dan Shearer, 2020 -->
66

7+
<!-- toc -->
8+
79
# Install LumoSQL
810

911
Installation consists of obtaining all relevant 3rd party dependencies (tcl, tclx, perl with modules TextGlob and Git, file, gnumake, gzip, gnutar, fossil or git, wget or curl), then downloading and installing the not-forking tool as an executable command, and downloading LumoSQL build tools that work currently as `make` commands.

‎doc/lumo-benchmark-filter.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,7 @@
66
<!-- SPDX-FileType: Documentation -->
77
<!-- SPDX-FileComment: Original by Claudio Calvelli, November 2020 -->
88

9-
10-
Table of Contents
11-
=================
12-
13-
* [Displaying/processing benchmark results](#displayingprocessing-benchmark-results)
14-
* [Full set of options](#full-set-of-options)
9+
<!-- toc -->
1510

1611
Displaying/processing benchmark results
1712
=======================================

‎doc/lumo-build-benchmark.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
<!-- SPDX-FileType: Documentation -->
77
<!-- SPDX-FileComment: Original by Claudio Calvelli, December 2020 -->
88

9+
<!-- toc -->
10+
911
# LumoSQL Build and Benchmark System
1012

1113
[LumoSQL](https://lumosql.org) implements a meta-build system for SQLite, using

‎doc/lumo-malbrain-backend.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
<!-- SPDX-FileType: Documentation -->
77
<!-- SPDX-FileComment: Original by Dan Shearer, February 2021 -->
88

9+
<!-- toc -->
10+
911
Notes Regarding Karl Malbrain's C Btree Code
1012
=============================================
1113

‎doc/lumo-proposed-debug.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
2+
<!-- toc -->
3+
14
# Temporary Note of Debug Proposal
25

36
As discussed at https://sqlite.org/forum/forumpost/42e647999d , which also has demo code.

0 commit comments

Comments
 (0)