Skip to content

Fix dead links in cbmc user manual #5330

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 2, 2020
Merged

Fix dead links in cbmc user manual #5330

merged 2 commits into from
May 2, 2020

Conversation

danpoe
Copy link
Contributor

@danpoe danpoe commented May 1, 2020 •
edited
Loading

  • Each commit message has a non-empty body, explaining why the change was made.
  • n/a Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
  • n/a The feature or user visible behaviour I have added or modified has been documented in the User Guide in doc/cprover-manual/
  • n/a Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
  • n/a My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • n/a White-space or formatting changes outside the feature-related changed lines are in commits of their own.

peterschrammel
peterschrammel reviewed May 1, 2020
View reviewed changes
doc/cprover-manual/api.md Outdated
@@ -18,7 +18,7 @@ void assert(_Bool assertion);
The function **\_\_CPROVER\_assume** adds an expression as a constraint
to the program. If the expression evaluates to false, the execution
aborts without failure. More detail on the use of assumptions is in the
section on [Assumptions](./modeling-assumptions.md).
section on [Assumptions](http://www.cprover.org/cprover-manual/modeling/assumptions/).
Copy link
Member

Choose a reason for hiding this comment

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

I relative path would be strongly preferred.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed

thk123
thk123 approved these changes May 1, 2020
View reviewed changes
Copy link
Contributor

@thk123 thk123 left a comment

Choose a reason for hiding this comment

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

I think documentation for user features (such as program harness), even if they are advanced, should still live in the user manual. You shouldn't need to be a CBMC developer to understand them; None the less - this fixes broken links on cprover.org so approving for now

@danpoe danpoe force-pushed the fixes/dead-links-in-user-manual branch from 2d35287 to 93b9e97 Compare May 1, 2020 16:10
@danpoe danpoe merged commit 79b512e into diffblue:develop May 2, 2020
@danpoe danpoe deleted the fixes/dead-links-in-user-manual branch June 2, 2020 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thk123 thk123 thk123 approved these changes

@peterschrammel peterschrammel peterschrammel approved these changes

@chrisr-diffblue chrisr-diffblue Awaiting requested review from chrisr-diffblue

@kroening kroening Awaiting requested review from kroening kroening is a code owner

@smowton smowton Awaiting requested review from smowton

@tautschnig tautschnig Awaiting requested review from tautschnig tautschnig is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@danpoe @thk123 @peterschrammel