Skip to content

Commit

Permalink
Documentation: remove V=0 since it is default
Browse files Browse the repository at this point in the history
  • Loading branch information
cburstedde committed Feb 7, 2025
1 parent 0c1f82b commit 9db73da
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion doc/coding_standards.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 6 additions & 6 deletions doc/doxygen/installation.dox
Original file line number Diff line number Diff line change
Expand Up @@ -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=<PATH>`.
Expand Down Expand Up @@ -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.
*
Expand Down
2 changes: 1 addition & 1 deletion doc/p4est-build-wdeps.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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"
10 changes: 5 additions & 5 deletions doc/webpage/tutorial-build.html
Original file line number Diff line number Diff line change
Expand Up @@ -155,14 +155,14 @@ <h3>Configure, make, install</h3>
in your own programs. Omit the debug option only if you really must have the
fastest running code.
</li>
<li>Call <code>make -j8 V=0</code> to build the software.
<li>Call <code>make -j8</code> to build the software.
The <code>-j</code> switch allows for parallel make processes, speeding up the
build noticeably, and <code>V=0</code> disables echoing the compile command
lines.</li>
<li>If you're curious, call <code>make -j2 check V=0</code>.
build noticeably, and <code>V=1</code> would enable echoing the compile
command lines for added information.</li>
<li>If you're curious, call <code>make -j2 check</code>.
This will compile and execute our complimentary test programs.</li>
<li>If you have specified an installation prefix, you can run
<code>make -j10 install V=0</code>.
<code>make -j10 install</code>.
This call will neatly arrange all exported header files, library files,
example binaries, some configuration files and documentation in mostly
standard-conforming directories.</li>
Expand Down

0 comments on commit 9db73da

Please sign in to comment.