Skip to content
Snippets Groups Projects
Commit 247428ee authored by Ralf Jung's avatar Ralf Jung
Browse files

Merge branch 'fix-doc-links' into 'master'

[doc] Fix links to doc files

Closes #281

See merge request iris/iris!350
parents 359c21c2 d5763982
No related branches found
No related tags found
No related merge requests found
......@@ -9,7 +9,7 @@ For using the Coq library, check out the
For understanding the theory of Iris, a LaTeX version of the core logic
definitions and some derived forms is available in
[docs/iris.tex](tex/iris.tex). A compiled PDF version of this document is
[tex/iris.tex](tex/iris.tex). A compiled PDF version of this document is
[available online](http://plv.mpi-sws.org/iris/appendix-3.2.pdf).
## Building Iris
......@@ -83,7 +83,7 @@ followed by `make build-dep`.
[MoSeL](http://iris-project.org/mosel/), which extends Coq with contexts for
intuitionistic and spatial BI++ assertions. It also contains tactics for
interactive proofs. Documentation can be found in
[ProofMode.md](docs/proof_mode.md).
[proof_mode.md](docs/proof_mode.md).
* The folder [heap_lang](theories/heap_lang) defines the ML-like concurrent heap
language
* The subfolder [lib](theories/heap_lang/lib) contains a few derived
......@@ -137,7 +137,7 @@ Contacting the developers:
Miscellaneous:
* Information on how to set up your editor for unicode input and output is
collected in [Editor.md](docs/editor.md).
collected in [editor.md](docs/editor.md).
* If you are writing a paper that uses Iris in one way or another, you could use
the [Iris LaTeX macros](tex/iris.sty) for typesetting the various Iris
connectives.
......@@ -100,7 +100,7 @@ Further tactics:
the goal is for a single, atomic operation -- `wp_bind` can be used to bring
the goal into the right shape.
- `wp_apply pm_trm`: Apply a lemma whose conclusion is a `WP`, automatically
applying `wp_bind` as needed. See the [ProofMode docs](ProofMode.md) for an
applying `wp_bind` as needed. See the [ProofMode docs](./proof_mode.md) for an
explanation of `pm_trm`.
There is no tactic for `Fork`, just do `wp_apply wp_fork`.
......
......@@ -2,9 +2,9 @@
This work-in-progress document serves to explain how Iris proofs are typically
carried out in Coq: what are the common patterns, what are the common pitfalls.
This complements the tactic documentation for the [proof mode](ProofMode.md) and
[HeapLang](HeapLang.md) as well as the documentation of syntactic conventions in
the [style guide](StyleGuide.md).
This complements the tactic documentation for the [proof mode](./proof_mode.md) and
[HeapLang](./heap_lang.md) as well as the documentation of syntactic conventions in
the [style guide](./style_guide.md).
## Order of `Requires`
......
......@@ -3,7 +3,7 @@ Tactic overview
Many of the tactics below apply to more goals than described in this document
since the behavior of these tactics can be tuned via instances of the type
classes in the file [proofmode/classes](proofmode/classes.v). Most notably, many
classes in the file [proofmode/classes](theories/proofmode/classes.v). Most notably, many
of the tactics can be applied when the connective to be introduced or to be eliminated
appears under a later, an update modality, or in the conclusion of a
weakest precondition.
......@@ -260,12 +260,12 @@ For example, given:
You can write
iIntros (x Hx) "!# $ [[] | #[HQ HR]] /= !>".
iIntros (x Hx) "!> $ [[] | #[HQ HR]] /= !>".
which results in:
x : nat
H : x = 0
Hx : x = 0
______________________________________(1/1)
"HQ" : Q
"HR" : R
......@@ -361,4 +361,4 @@ HeapLang tactics
================
If you came here looking for the `wp_` tactics, those are described in the
[HeapLang documentation](HeapLang.md).
[HeapLang documentation](./heap_lang.md).
......@@ -2,8 +2,8 @@
This document lays down syntactic conventions about how we usually write our
Iris proofs in Coq. It is a work-in-progress. This complements the tactic
documentation for the [proof mode](ProofMode.md) and [HeapLang](HeapLang.md) as
well as the [proof guide](ProofGuide.md).
documentation for the [proof mode](./proof_mode.md) and [HeapLang](./heap_lang.md) as
well as the [proof guide](.doco/proof_guide.md).
## Implicit generalization
......@@ -114,8 +114,8 @@ is used by clients.
* R: cameras
* UR: unital cameras or resources algebras
* F: functors (can be combined with all of the above, e.g. OF is an OFE functor)
* G: global camera functor management (typeclass; see `ProofGuide.md`)
* G: global camera functor management (typeclass; see [proof\_guide.md](./proof_guide.md))
* I: bunched implication logic (of type `bi`)
* SI: step-indexed bunched implication logic (of type `sbi`)
* T: canonical structures for algebraic classes (for example ofeT for OFEs, cmraT for cameras)
* Σ: global camera functor management (`gFunctors`; see `ProofGuide.md`)
* Σ: global camera functor management (`gFunctors`; see [proof\_guide.md](./proof_guide.md))
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment