Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update arch-split doc; rename arch_split->arch-split #801

Merged
merged 2 commits into from
Jul 26, 2024

Conversation

Xaphiosis
Copy link
Member

There's a noisy commit for the global rename, which isn't interesting beyond the commit message.
The main thing I'd like a review of is the updates to docs/arch-split.md (separate commit) to see whether things make sense. The changes are based off of the test deployment work I did for AARCH64 AInvs.

* prefer arch_global_naming
* prefer arch_requalify commands over interpretation
* indicate consts might need to be requalified in Arch theories
* explain (in Arch) + requalify pattern for generic consequences of
  arch-specific properties

Signed-off-by: Rafal Kolanski <[email protected]>
@Xaphiosis Xaphiosis added docs Documentation, READMEs, etc arch-split splitting proofs into generic and architecture dependent labels Jul 24, 2024
@Xaphiosis Xaphiosis requested review from lsf37 and corlewis July 24, 2024 01:35
docs/arch-split.md Outdated Show resolved Hide resolved
Copy link
Member

@lsf37 lsf37 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Nice how the docs are getting more and more coherent.

docs/arch-split.md Outdated Show resolved Hide resolved
Comment on lines +277 to +282
In some cases, consts/types/facts may be thrown into the `Arch` context without
further qualification. In such cases, normal requalification may be used:

```isabelle
requalify_consts Arch.empty_context (* standard locale version, likely due to missing global_naming *)
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even want to mention this, if we're wanting to fix all cases of it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possibly, because we do sometimes do lemma (in Arch) foo with an immediate requalify_facts Arch.foo, so it's worth knowing about at least. I think I explain that case in the docs now.

Unifying the tag between Github labels, docs, and so on will make it
less confusing to grep for and deal with.

Signed-off-by: Rafal Kolanski <[email protected]>
@Xaphiosis Xaphiosis merged commit 0875edf into seL4:master Jul 26, 2024
13 of 14 checks passed
@Xaphiosis Xaphiosis deleted the arch_split_doc branch July 26, 2024 00:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arch-split splitting proofs into generic and architecture dependent docs Documentation, READMEs, etc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants