diff --git a/doc/sphinx/user/extending/index.md b/doc/sphinx/user/extending/index.md index e28a9e12235..d2aee78727c 100644 --- a/doc/sphinx/user/extending/index.md +++ b/doc/sphinx/user/extending/index.md @@ -125,8 +125,7 @@ which there is an extensive amount of documentation: that also have extensive sections on developing code with deal.II as well as on debugging. It also answers - a number of questions we frequently get about the use of C++ in also have information that may be relevant if diff --git a/doc/sphinx/user/install/docker-container/developing-in-container.md b/doc/sphinx/user/install/docker-container/developing-in-container.md index 89b51fb8960..eee1491ad1f 100644 --- a/doc/sphinx/user/install/docker-container/developing-in-container.md +++ b/doc/sphinx/user/install/docker-container/developing-in-container.md @@ -5,8 +5,8 @@ The workflow described previously does not include advice on how to modify ASPECT inside the container. We recommend a slightly different workflow for advanced users that want to modify parts of ASPECT. The ASPECT -docker container itself is built on top of a deal.II container that contains all dependencies for +docker container itself is built on top of a deal.II +container that contains all dependencies for compiling ASPECT. Therefore it is possible to run the deal.II container, mount an ASPECT source directory from your host system and compile it inside of the container. diff --git a/doc/sphinx/user/install/local-installation/using-candi.md b/doc/sphinx/user/install/local-installation/using-candi.md index f02bee49713..b6d0e7c7f7d 100644 --- a/doc/sphinx/user/install/local-installation/using-candi.md +++ b/doc/sphinx/user/install/local-installation/using-candi.md @@ -1,8 +1,8 @@ # Using candi to compile dependencies -In its default configuration `candi` downloads and compiles a deal.II configuration that is able to run +In its default configuration `candi` downloads and compiles a +deal.II configuration that is able to run ASPECT, but it also contains a number of packages that are not required. We strive to keep the development version of ASPECT compatible diff --git a/doc/sphinx/user/run-aspect/debug-mode.md b/doc/sphinx/user/run-aspect/debug-mode.md index 35840fac192..7461c8765d9 100644 --- a/doc/sphinx/user/run-aspect/debug-mode.md +++ b/doc/sphinx/user/run-aspect/debug-mode.md @@ -1,8 +1,7 @@ (sec:run-aspect:debug-mode)= # Debug or optimized mode -ASPECT utilizes a deal.II feature called *debug mode*. By default, +ASPECT utilizes a deal.II feature called *debug mode*. By default, ASPECT is configured in debug mode, i.e., it calls a version of the deal.II library that contains lots of checks for the correctness of function arguments, the consistency of @@ -11,8 +10,7 @@ many similar consistency checks enabled only in debug mode. Finally, you can only expect a good debugging experience (for example using *gdb*) because we only enable debug symbols in *debug mode* (at least by default). -If you program with deal.II, for example to extend +If you program deal.II, for example to extend ASPECT, it has been our experience over the years that, by number, most programming errors are of the kind where one forgets to initialize a vector, one accesses data that has not been updated, one tries to