History

Corey Lewis 1cef25b49a Import documentation: CRefine notes We import some documentation with notes/issues on the refinement from Haskell to C. The file is a Markdown-ified version of previous documentation hosted at UNSW. Signed-off-by: Corey Lewis <corey.lewis@unsw.edu.au>		2022-04-27 15:37:37 +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	Import documentation: CRefine notes	2022-04-27 15:37:37 +10:00
ROOT	docs: add style guide to `run_tests`	2021-06-29 10:57:53 +10:00
Style.thy	docs: proof style for unfolding definitions	2022-04-12 14:36:09 +10:00
Style_pre.thy	docs: proof style for unfolding definitions	2022-04-12 14:36:09 +10:00
arch-split.md	docs: use archive link for locale docs	2021-12-21 16:28:29 +11:00
compacting-proofs.md	Matt's short guide on compacting proofs	2021-04-13 10:41:28 +10:00
conventions.md	docs: fix typo	2021-11-03 15:11:39 +11:00
crefine-notes.md	Import documentation: CRefine notes	2022-04-27 15:37:37 +10: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	docs: bump Isabelle version in setup instructions	2021-10-31 13:41:58 +11: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
CRefine Notes

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.