AdaCore / AdaCore/learn

Inconsistent content between "Verification Method" and "Notes"

Open
#1,041 1 comment 0 reactions 1 assignee View on GitHub

@frank-at-adacore is already working on this.

Since May 7, 2024.

Dominant language
Ada
Stars
117
Forks
49
Avg merge
44m
Merged PRs (30d)
8

Description

This was reported by Yannick in an earlier version of this document, but I suspect is still applicable.

Yannick's report:

It seems that the fields "Verification Method" and "Notes" are used inconsistently to list the verification methods for a given rule. Take for example rule EXU02 (No Unhandled Application-Defined Exceptions). Its field "Verification Method" points at GNATcheck as verification method:

 GNATcheck rule: Unhandled_Exceptions

and its field "Notes" points at SPARK as verification method:

SPARK can prove that no exception will be raised (or fail to prove it and indicate the failure).

This is the case for many rules. It would be better to always have a short description of the verification methods in the field "Verification Method" and a longer explanation in "Notes".

Also note that there is no restriction or GNATcheck rule called "Unhandled_Exceptions". But the restriction "No_Exception_Propagation" could be used here.

Vasiliy sent a small reply:

No_Exception_Propagation is uncheckable with gnatcheck though.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.