History

Matthew Brecknell ef87791124 docs: add style guide to `run_tests` Signed-off-by: Mitchell Buckley <mitchell.alan.buckley@gmail.com>		2021-06-29 10:57:53 +10:00
..
plans	make Jira links nicer	2021-04-13 16:27:42 +10:00
Makefile	docs: add style guide to `run_tests`	2021-06-29 10:57:53 +10:00
README.md	docs: hook in new Haskell assertions doc	2021-06-07 15:01:35 +10:00
ROOT	docs: add style guide to `run_tests`	2021-06-29 10:57:53 +10:00
Style.thy	docs: improvements to style guide	2021-06-29 10:57:53 +10:00
Style_pre.thy	docs: improvements to style guide	2021-06-29 10:57:53 +10:00
arch-split.md	Add arch-splitting documentation	2021-04-13 10:41:28 +10:00
compacting-proofs.md	Matt's short guide on compacting proofs	2021-04-13 10:41:28 +10:00
conventions.md	trivial: fix broken links	2020-08-10 15:48:34 +08:00
de-duplicating-proofs.md	Add arch-splitting documentation	2021-04-13 10:41:28 +10:00
find-consts.md	Japheth's guide to find_consts	2021-04-13 10:41:28 +10:00
find-theorems.md	Japheth's guide to find_consts	2021-04-13 10:41:28 +10:00
haskell-assertions.md	Import documentation: Haskell assertions (#285 )	2021-06-03 08:24:56 +10:00
setup.md	setup docs: markdown lint and slight tweaks	2021-05-17 13:01:51 +10:00
tests.xml	docs: add style guide to `run_tests`	2021-06-29 10:57:53 +10:00

README.md

Documentation

This directory contains markdown and theory files with conventions and other documentation for the l4v repository.

This is work in progress and contributions are welcome. Feel encouraged to raise pull requests for more material and/or corrections.

Topics

Current topics are:

Setup for doing seL4 proofs
Naming conventions in this repository
Using find_theorems effectively
Using find_consts effectively
De-duplicating proofs
Compacting proofs
Architecture Split Why and How-To
Haskell Assertions: how to use assertions in Haskell to use information from AInvs on Haskell and C levels

Plans

The directory plans/ contains ideas and plans for proof-engineering improvements in this repo. They are at the idea stage, not fully worked out yet. Feel free to contribute new ideas, to make an existing one more concrete, or to pick one up and work on it.