Commit Graph

33 Commits

Author SHA1 Message Date
Gerwin Klein 12c8da5758 docs: split_simps and case over fun/primrec
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2022-05-05 09:18:47 +10:00
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
Corey Lewis 93f04fa675 docs: proof style for unfolding definitions
Signed-off-by: Corey Lewis <corey.lewis@unsw.edu.au>
2022-04-12 14:36:09 +10:00
Corey Lewis 86445726a3 docs: consistent indentation
Signed-off-by: Corey Lewis <corey.lewis@unsw.edu.au>
2022-04-12 14:36:09 +10:00
Gerwin Klein 5e705fc056 docs: text and comment style
Including an update to use that style in the style file itself.

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2022-03-28 11:06:10 +11:00
Gerwin Klein f33b02f3d0 docs: use archive link for locale docs
This link is stable over Isabelle releases and can be updated once
the repo switches over to the next release.

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-12-21 16:28:29 +11:00
Gerwin Klein 141d2f4b67 docs: fix typo
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-11-03 15:11:39 +11:00
Gerwin Klein 80a2ba76c6 docs: apply markdown lint
Rewrap and adjust list indent in conventions.md

Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-11-03 15:11:39 +11:00
Gerwin Klein 715501a969 docs: variable and parameter name conventions
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-11-03 15:11:39 +11:00
Gerwin Klein 78033ab5e4 docs: bump Isabelle version in setup instructions
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-10-31 13:41:58 +11:00
Gerwin Klein 28bc26c925 isabelle-2021: HOL-Word now in HOL-Library
Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2021-09-30 16:53:17 +10:00
Zoltan A. Kocsis 179a4d7acc
docs: add setup instructions for PIDE plug-ins (#319)
Signed-off-by: Zoltan Kocsis <zoltan.kocsis@data61.csiro.au>
2021-08-06 16:33:35 +10:00
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
Mitchell Buckley b1f1f56fd8 docs: improvements to style guide
* Add Style_pre.thy to contain helpful preliminary definitions.
* Change some style advice according to feedback from the team.

Co-authored-by: Corey Lewis <corlewis@gmail.com>
Co-authored-by: Matthew Brecknell <matthew@brecknell.net>
Signed-off-by: Mitchell Buckley <mitchell.alan.buckley@gmail.com>
2021-06-29 10:57:53 +10:00
Gerwin Klein 087dc1ecc9 docs: Add principles/goals to style guide
The rules in this style guide should work towards achieving these
goals and form the basis for arguing whether a rule should be
there or not.

Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-06-29 10:57:53 +10:00
Mitchell Buckley 3eaa6dce22 docs: start an isabelle style guide
Add docs/Style.thy.

This is a starting point for an isabelle style guide. Some of the
material is original and some is incorporated from confluence pages.
I believe that the basics are correct but it will need to be tweaked
and corrected by other proof engineers.

Signed-off-by: Mitchell Buckley <mitchell.alan.buckley@gmail.com>
2021-06-29 10:57:53 +10:00
Gerwin Klein 59973b553d docs: hook in new Haskell assertions doc
Signed-Off-By: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-06-07 15:01:35 +10:00
Zoltan A. Kocsis ec016bba3f
Import documentation: Haskell assertions (#285)
* Import documentation: Haskell assertions

We import some documentation regarding the role of assertions in Haskell, and how we use assertions in Haskell to transport information from abstract invariants to Haskell-to-C refinement proofs.

The file is a Markdown-ified version of previous documentation hosted at UNSW and Data61.

Co-authored-by: Zoltan A. Kocsis <zoltan.kocsis@data61.csiro.au>
Co-authored-by: Matthew Brecknell <Matthew.Brecknell@data61.csiro.au>
Signed-off-by: Zoltan A. Kocsis <zoltan.kocsis@data61.csiro.au>
2021-06-03 08:24:56 +10:00
Gerwin Klein e9c7c48ed4 setup docs: markdown lint and slight tweaks
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
2021-05-17 13:01:51 +10:00
Gerwin Klein fb150e8a7c add proog-eng plans to contents
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 16:27:42 +10:00
Gerwin Klein a250628cc5 make Jira links nicer
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 16:27:42 +10:00
Gerwin Klein fcceb13a9e Add list of proof engineering ideas
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 16:27:42 +10:00
Gerwin Klein 2a89db327c provide a table of contents
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 10:41:28 +10:00
Gerwin Klein 400c7b7131 Japheth's guide to find_consts
Co-authored-by: Japheth Lim <Japheth.Lim@data61.csiro.au>
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 10:41:28 +10:00
Gerwin Klein f00bf67a5a Japheth's guide to find_theorems
Co-authored-by: Japheth Lim <Japheth.Lim@data61.csiro.au>
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 10:41:28 +10:00
Gerwin Klein 52dd5b0819 Add arch-splitting documentation
Co-authored-by: Matthew Brecknell <Matthew.Brecknell@data61.csiro.au>
Co-authored-by: Joel Beeren <joel.beeren@data61.csiro.au>
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 10:41:28 +10:00
Gerwin Klein c2bf7fc064 Matt's short guide on de-duplicating proofs
Co-authored-by: Matthew Brecknell <Matthew.Brecknell@data61.csiro.au>
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 10:41:28 +10:00
Gerwin Klein e810756c33 Matt's short guide on compacting proofs
Co-authored-by: Matthew Brecknell <Matthew.Brecknell@data61.csiro.au>
Signed-off-by: Gerwin Klein <kleing@unsw.edu.au>
2021-04-13 10:41:28 +10:00
Gerwin Klein b9a48d8042
docs: factor out dependency specs (#161)
There is another (out-of-date) dependency description for l4v on the
docs site. To avoid this duplication, this commit factors out the
dependency part of the README, so that it be included directly on the
docs site without going stale.

Also, the README was getting way too long.

Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-12-02 12:32:26 +11:00
Gerwin Klein b0d01265ef trivial: fix broken links
Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-08-10 15:48:34 +08:00
Gerwin Klein 4606fbeaed function and property variables
Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-06-09 15:56:43 +10:00
Gerwin Klein aeda15d877 Add an example for function_prop pattern
Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-06-09 15:56:43 +10:00
Gerwin Klein eefaa6db97 docs: an initial guide on naming conventions
Signed-off-by: Gerwin Klein <gerwin.klein@data61.csiro.au>
2020-06-09 15:56:43 +10:00