From 9db73da0f6c4701fa1212bf97efa5f2267c7cbbb Mon Sep 17 00:00:00 2001 From: Carsten Burstedde Date: Fri, 7 Feb 2025 11:20:36 +0100 Subject: [PATCH] Documentation: remove V=0 since it is default --- doc/coding_standards.txt | 2 +- doc/doxygen/installation.dox | 12 ++++++------ doc/p4est-build-wdeps.sh | 2 +- doc/webpage/tutorial-build.html | 10 +++++----- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/coding_standards.txt b/doc/coding_standards.txt index e0d9d493a..aafe37258 100644 --- a/doc/coding_standards.txt +++ b/doc/coding_standards.txt @@ -35,7 +35,7 @@ library tries to adhere to. relative/path/to/configure --enable-mpi --enable-debug CC=mpicxx \ CFLAGS="-Wall -Wextra -Wno-unused-parameter -O0 -g" - and run `make -j V=0`. Modify accordingly for production builds. + and run `make -j`. Modify accordingly for production builds. ## Boolean variables diff --git a/doc/doxygen/installation.dox b/doc/doxygen/installation.dox index 2ff328d9c..cd8ab4ede 100644 --- a/doc/doxygen/installation.dox +++ b/doc/doxygen/installation.dox @@ -60,13 +60,13 @@ * * \subsubsection complile_software 4. Compile the software * - * > `make -j V=0` + * > `make -j` * - * The environment variable `V=0` suppresses most of `make`'s console output. + * Adding the environment variable `V=1` would re-enable much `make` output. * * \subsubsection install_software 5. Install the software (optional) * - * > `make install V=0` + * > `make install` * * The software is installed by default into the prefix `./local`. * This can be changed by setting `configure --prefix=`. @@ -148,16 +148,16 @@ * * After configuration, the next step is the compilation of \c p4est: * - * > `make -j V=0` + * > `make -j` * - * > `make install -j V=0` + * > `make install -j` * * \subsubsection verification 5. Verification Step * * It's recommended to execute the \c p4est test programs post-installation * to ensure everything is in order: * - * > `make -j4 check V=0` + * > `make -j4 check` * * Where the `-j` option limits parallel make to at most four targets at the same time. * diff --git a/doc/p4est-build-wdeps.sh b/doc/p4est-build-wdeps.sh index 9d8440bb5..a8cd0b0c1 100755 --- a/doc/p4est-build-wdeps.sh +++ b/doc/p4est-build-wdeps.sh @@ -25,7 +25,7 @@ cd p4est && \ mkdir build && \ cd build && \ ../configure $CONFIG --with-sc="$PREFIX/libsc" --prefix="$PREFIX/p4est" && \ -make -j install V=0 && \ +make -j install && \ cd ../../ && \ rm -rf p4est/.git && \ rm -r p4est || bdie "p4est" diff --git a/doc/webpage/tutorial-build.html b/doc/webpage/tutorial-build.html index 5fe158958..91b4ee0de 100644 --- a/doc/webpage/tutorial-build.html +++ b/doc/webpage/tutorial-build.html @@ -155,14 +155,14 @@

Configure, make, install

in your own programs. Omit the debug option only if you really must have the fastest running code. -
  • Call make -j8 V=0 to build the software. +
  • Call make -j8 to build the software. The -j switch allows for parallel make processes, speeding up the -build noticeably, and V=0 disables echoing the compile command -lines.
    • -
  • If you're curious, call make -j2 check V=0. +build noticeably, and V=1 would enable echoing the compile +command lines for added information.
    • +
  • If you're curious, call make -j2 check. This will compile and execute our complimentary test programs.
  • If you have specified an installation prefix, you can run -make -j10 install V=0. +make -j10 install. This call will neatly arrange all exported header files, library files, example binaries, some configuration files and documentation in mostly standard-conforming directories.