Remove duplicated user documentation #3299
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
November 8, 2018 17:24
Remove the version of the user manual published at http://cprover.diffblue.com/cbmc-user-manual.html and link to http://www.cprover.org/cprover-manual/ instead, in order to make a clearer separation between the _user_ and _developer_ documentation. There is updated source intended for the user manual, with almost identical contents to the removed cbmc-user-manual.md, in the doc/cprover-manual folder.
'assumptions.md' contains similar contents to the other files in the doc/cprover-manual folder. The version in the other files is more up-to-date. This commit removes the duplicate to avoid confusion when using or updating the documentation. Also, this removes the section "Bounded Model Checking with CBMC" from cbmc-tutorial.md, because there is an idential copy of that section in introduction.md.
johnnonweiler
requested review from
chrisr-diffblue,
kroening,
peterschrammel,
smowton and
tautschnig
as code owners
allredj
reviewed
Nov 9, 2018
There was a problem hiding this comment.
Diffblue compatibility check is currently unavailable.
Please create manual bump.
(cbmc commit: a6c547f).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/90827502
owen-mc-diffblue
approved these changes
Nov 9, 2018
peterschrammel
approved these changes
Nov 11, 2018
| @@ -1,23 +1,5 @@ | |||
| [CPROVER Manual TOC](../../) | |||
|
|
|||
| ## Bounded Model Checking with CBMC | |||
There was a problem hiding this comment.
Where is this duplicated?
There was a problem hiding this comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR deletes the Doxygen version of the user manual
cbmc-user-manual.md, with a view to using the version in thedoc/cprover-manualfolder instead, and updates associated links. (The new version has similar contents, but is divided into multiple files.)Duplicated documentation in the
doc/cprover-manualfolder is also deleted, to avoid any confusion about which version to use and maintain.The removed version had a big advantage in that it was being automatically published to http://cprover.diffblue.com by Travis CI. I'm making this PR on the assumption that something similar can be setup for the new version soon.