Skip to content

Point documentation links to https://diffblue.github.io/cbmc/ #7152

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

Merged
merged 1 commit into from
Oct 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![Build Status][coverity_img]][coverity]
[![Build Status][codecov_img]][codecov]

[CProver Documentation](http://cprover.diffblue.com)
[CProver Documentation](https://diffblue.github.io/cbmc/)

About
=====
Expand Down
59 changes: 23 additions & 36 deletions TOOLS_OVERVIEW.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The tools in the CProver project are as follows:
- [others (converter, driver, file_converter, java-converter)](#others)

The rest of this document provides a section on each of these tools in alphabetical order.
Most links in this document are to the [CProver online documentation](http://cprover.diffblue.com/index.html).
Most links in this document are to the [CProver online documentation](https://diffblue.github.io/cbmc/).


## cbmc
Expand All @@ -34,39 +34,31 @@ including generating traces. This includes invoking various sub-tools and
modules.

For details on usage of the `cbmc` tool see the following documentation
- [Developer Tutorial](http://cprover.diffblue.com/tutorial.html)
- [Developer Tutorial](https://diffblue.github.io/cbmc/tutorial.html)
includes a very brief tutorial on many aspects of `cbmc` and other tools.

For details on the architecture of the `cbmc` tool and how the analysis is performed
see the following documents:
- [CBMC Architecture](http://cprover.diffblue.com/cbmc-architecture.html)
- [CBMC Architecture](https://diffblue.github.io/cbmc/cbmc-architecture.html)
gives a high level overview of the `cbmc` architecture and data flow.
- [Background Concepts](http://cprover.diffblue.com/background-concepts.html)
- [Background Concepts](https://diffblue.github.io/cbmc/background-concepts.html)
overviews all the key concepts used in the `cbmc` analysis.

For details on compiling, testing, contributing, and documentation related to
development see:
- [CProver Developer Documentation](http://cprover.diffblue.com/index.html)
- [CProver Developer Documentation](https://diffblue.github.io/cbmc/)


## goto-analyzer

The `goto-analyzer` is a wrapper program around the
[abstract interpretation](http://cprover.diffblue.com/background-concepts.html#abstract_interpretation_section)
[abstract interpretation](https://diffblue.github.io/cbmc/background-concepts.html#abstract_interpretation_section)
implementations. (For more detail on these implementations see
[here](http://cprover.diffblue.com/group__analyses.html).)
[here](https://diffblue.github.io/cbmc/group__analyses.html).)
It is possible to configure which abstractions are used and what
is done with the chosen abstractions (verification, display,
simplification, etc.). The current best documentation is available
[here](http://cprover.diffblue.com/goto__analyzer__parse__options_8h.html).

Other documentation useful for this tool can be found:
- [Analysis Information](http://cprover.diffblue.com/group__analyses.html)

Details of all the options can be seen by running
```
goto-analyzer --help
```
simplification, etc.). See the [man
page](https://diffblue.github.io/cbmc/man/goto-analyzer.html) for details.

## goto-cc

Expand All @@ -81,12 +73,12 @@ will behave like `gcc`). The additional object code is used as the internal
representation for `cbmc` and related tools. These can also be extracted and
used themselves.

Further information on `goto-cc` can be found:
- [Developer Tutorial](http://cprover.diffblue.com/tutorial.html) with
Further information on `goto-cc` can be found at:
- [Developer Tutorial](https://diffblue.github.io/cbmc/tutorial.html) with
some very simple examples and notes.
- [goto-cc](http://cprover.diffblue.com/group__goto-cc.html) information
- [goto-cc](https://diffblue.github.io/cbmc/man/goto-cc.html) information
on the `goto-cc` compilers
- [goto Programs](http://cprover.diffblue.com/group__goto-programs.html)
- [goto Programs](https://diffblue.github.io/cbmc/group__goto-programs.html)
for information on goto programs and how they are used.

Note that `goto-cc` can emulate GCC, Visual Studio, and CodeWarrior
Expand Down Expand Up @@ -115,25 +107,20 @@ can then be analysed (using the harness). Harnesses can be either function
call environments, or memory snapshots.

Documentation on `goto-harness` can be found
[here](http://cprover.diffblue.com/md__home_travis_build_diffblue_cbmc_doc_architectural_goto-harness.html)
[in it's man page](https://diffblue.github.io/cbmc/man/goto-harness.html)
including details and examples.

Details of all the options can be seen by running
```
goto-harness --help
```


## goto-instrument

This is a collection of tools for analysing and modifying goto programs
(programs created with #goto-cc). Generally these take a goto program
and output another goto program.

Further examples and documentation can be found:
- [goto-instrument](http://cprover.diffblue.com/group__goto-instrument.html)
Further examples and documentation can be found at:
- [goto-instrument](https://diffblue.github.io/cbmc/group__goto-instrument.html)
has an overview of `goto-instrument` and a small tutorial example.
- [Developer Tutorial](http://cprover.diffblue.com/tutorial.html) has high
- [Developer Tutorial](https://diffblue.github.io/cbmc/tutorial.html) has high
level overview and some example commands for `goto-instrument`.


Expand All @@ -144,7 +131,7 @@ Java programs. This is a fork of [goto-analyzer](#goto-analyzer) with
a Java Virtual Machine front end.

Documentation useful for this tool can be found:
- [Analysis Information](http://cprover.diffblue.com/group__analyses.html)
- [Analysis Information](https://diffblue.github.io/cbmc/group__analyses.html)

Details of all the options can be seen by running
```
Expand Down Expand Up @@ -174,13 +161,13 @@ simple examples and information.

For details on how analysis is performed in the `cbmc` and
`jbmc` tools see see the following documents:
- [CBMC Architecture](http://cprover.diffblue.com/cbmc-architecture.html)
- [CBMC Architecture](https://diffblue.github.io/cbmc/cbmc-architecture.html)
gives a high level overview of the `cbmc` architecture and data flow that *should also apply to* `jbmc`.
- [Background Concepts](http://cprover.diffblue.com/background-concepts.html)
- [Background Concepts](https://diffblue.github.io/cbmc/background-concepts.html)
overviews all the key concepts used in the `jbmc` analysis.

For details on compiling, testing, contributing, and documentation related to development see:
- [CProver Development Documentation](http://cprover.diffblue.com/index.html)
- [CProver Development Documentation](https://diffblue.github.io/cbmc/)


## jdiff
Expand Down Expand Up @@ -212,14 +199,14 @@ Note that to use `memory-analyzer` the program must be compiled with
compile with the `-g` option.

For further documentation and examples see
[here](http://cprover.diffblue.com/md__home_travis_build_diffblue_cbmc_doc_architectural_memory-analyzer.html).
[here](https://diffblue.github.io/cbmc/man/memory-analyzer.html).


## smt2_solver

This is an (Satisfiability Modulo Theories) SMT solver that
parses SMT-LIB 2 format files and uses CProver's internal bit-blasting
solver (see [solvers](http://cprover.diffblue.com/group__solvers.html))
solver (see [solvers](https://diffblue.github.io/cbmc/group__solvers.html))
to resolve queries.

## symtab2gb
Expand Down
2 changes: 1 addition & 1 deletion doc/architectural/compilation-and-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ contained in the `doc/` directory and gives some options for these
tools. All of these could be improved and patches are very welcome. In
some cases the algorithms used are described in the relevant papers.

The doxygen documentation can be [accessed online](http://cprover.diffblue.com).
The doxygen documentation can be [accessed online](https://diffblue.github.io/cbmc/).
To build it locally, run `scripts/run_doxygen.sh`. HTML output will be created
in `doc/html/`. The index page is `doc/html/index.html`. This script will
filter out expected warning messages from doxygen, so that new problems are more
Expand Down
3 changes: 1 addition & 2 deletions doc/cprover-manual/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ You are now ready to use CBMC. We recommend you follow the

### Building CBMC from Source

See the [CPROVER Developer
Documentation](http://cprover.diffblue.com/compilation-and-development.html).
See the [CPROVER Developer Documentation](https://diffblue.github.io/cbmc/compilation-and-development.html).

## Installing the Eclipse Plugin

Expand Down
4 changes: 2 additions & 2 deletions doc/doxygen-root/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ location.

## References

* The cprover documentation: http://cprover.diffblue.com/
* The cprover documentation: https://diffblue.github.io/cbmc/
* Sources: https://github.com/diffblue/cbmc/tree/develop/doc

* The cprover manual: http://www.cprover.org/cprover-manual/
Expand All @@ -74,4 +74,4 @@ location.
* Doxygen manual: https://www.doxygen.nl/manual
* Grouping documentation: https://www.doxygen.nl/manual/grouping.html
* Markdown support: https://doxygen.nl/manual/markdown.html
* Doxygen treatment of markdown pages: https://doxygen.nl/manual/markdown.html#markdown_dox
* Doxygen treatment of markdown pages: https://doxygen.nl/manual/markdown.html#markdown_dox
37 changes: 0 additions & 37 deletions scripts/publish_doc.sh

This file was deleted.