Skip to content

Commit c7b7bb0

Browse files
committed
Point documentation links to https://diffblue.github.io/cbmc/
The doxygen-generated documentation is now rendered at https://diffblue.github.io/cbmc/. All links previously pointing to cprover.diffblue.com are now pointed towards the rendering at github.io. Also includes minor text cleanup around those links. The script to publish to cprover.diffblue.com is deleted as it wasn't working or used anymore.
1 parent 5834261 commit c7b7bb0

File tree

6 files changed

+28
-79
lines changed

6 files changed

+28
-79
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[![Build Status][coverity_img]][coverity]
22
[![Build Status][codecov_img]][codecov]
33

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

66
About
77
=====

TOOLS_OVERVIEW.md

Lines changed: 23 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The tools in the CProver project are as follows:
2323
- [others (converter, driver, file_converter, java-converter)](#others)
2424

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

2828

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

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

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

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

5151

5252
## goto-analyzer
5353

5454
The `goto-analyzer` is a wrapper program around the
55-
[abstract interpretation](http://cprover.diffblue.com/background-concepts.html#abstract_interpretation_section)
55+
[abstract interpretation](https://diffblue.github.io/cbmc/background-concepts.html#abstract_interpretation_section)
5656
implementations. (For more detail on these implementations see
57-
[here](http://cprover.diffblue.com/group__analyses.html).)
57+
[here](https://diffblue.github.io/cbmc/group__analyses.html).)
5858
It is possible to configure which abstractions are used and what
5959
is done with the chosen abstractions (verification, display,
60-
simplification, etc.). The current best documentation is available
61-
[here](http://cprover.diffblue.com/goto__analyzer__parse__options_8h.html).
62-
63-
Other documentation useful for this tool can be found:
64-
- [Analysis Information](http://cprover.diffblue.com/group__analyses.html)
65-
66-
Details of all the options can be seen by running
67-
```
68-
goto-analyzer --help
69-
```
60+
simplification, etc.). See the [man
61+
page](https://diffblue.github.io/cbmc/man/goto-analyzer.html) for details.
7062

7163
## goto-cc
7264

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

84-
Further information on `goto-cc` can be found:
85-
- [Developer Tutorial](http://cprover.diffblue.com/tutorial.html) with
76+
Further information on `goto-cc` can be found at:
77+
- [Developer Tutorial](https://diffblue.github.io/cbmc/tutorial.html) with
8678
some very simple examples and notes.
87-
- [goto-cc](http://cprover.diffblue.com/group__goto-cc.html) information
79+
- [goto-cc](https://diffblue.github.io/cbmc/man/goto-cc.html) information
8880
on the `goto-cc` compilers
89-
- [goto Programs](http://cprover.diffblue.com/group__goto-programs.html)
81+
- [goto Programs](https://diffblue.github.io/cbmc/group__goto-programs.html)
9082
for information on goto programs and how they are used.
9183

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

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

121-
Details of all the options can be seen by running
122-
```
123-
goto-harness --help
124-
```
125-
126113

127114
## goto-instrument
128115

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

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

139126

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

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

149136
Details of all the options can be seen by running
150137
```
@@ -174,13 +161,13 @@ simple examples and information.
174161

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

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

185172

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

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

217204

218205
## smt2_solver
219206

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

225212
## symtab2gb

doc/architectural/compilation-and-development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ contained in the `doc/` directory and gives some options for these
235235
tools. All of these could be improved and patches are very welcome. In
236236
some cases the algorithms used are described in the relevant papers.
237237

238-
The doxygen documentation can be [accessed online](http://cprover.diffblue.com).
238+
The doxygen documentation can be [accessed online](https://diffblue.github.io/cbmc/).
239239
To build it locally, run `scripts/run_doxygen.sh`. HTML output will be created
240240
in `doc/html/`. The index page is `doc/html/index.html`. This script will
241241
filter out expected warning messages from doxygen, so that new problems are more

doc/cprover-manual/installation.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,7 @@ You are now ready to use CBMC. We recommend you follow the
4444

4545
### Building CBMC from Source
4646

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

5049
## Installing the Eclipse Plugin
5150

doc/doxygen-root/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ location.
6565

6666
## References
6767

68-
* The cprover documentation: http://cprover.diffblue.com/
68+
* The cprover documentation: https://diffblue.github.io/cbmc/
6969
* Sources: https://github.com/diffblue/cbmc/tree/develop/doc
7070

7171
* The cprover manual: http://www.cprover.org/cprover-manual/
@@ -74,4 +74,4 @@ location.
7474
* Doxygen manual: https://www.doxygen.nl/manual
7575
* Grouping documentation: https://www.doxygen.nl/manual/grouping.html
7676
* Markdown support: https://doxygen.nl/manual/markdown.html
77-
* Doxygen treatment of markdown pages: https://doxygen.nl/manual/markdown.html#markdown_dox
77+
* Doxygen treatment of markdown pages: https://doxygen.nl/manual/markdown.html#markdown_dox

scripts/publish_doc.sh

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)