Skip to content

Commit 5d1cf1f

Browse files
branfosjbranfosj
authored
Merge pull request easybuilders#62 from orbsmiv/tracing-progress
port Tracing progress page to markdown
2 parents 6b644df + a891a41 commit 5d1cf1f

File tree

1 file changed

+95
-122
lines changed

1 file changed

+95
-122
lines changed

‎docs/tracing-progress.md

+95-122
Original file line numberDiff line numberDiff line change
@@ -1,130 +1,103 @@
1-
# Tracing progress
1+
# Tracing progress {: #trace }
22

3-
!!! warning
4-
This page will soon replace <https://docs.easybuild.io/en/latest/Tracing_progress.html>.
3+
To trace the progress of EasyBuild while it is installing software, you
4+
can use `eb --trace`.
55

6-
**
7-
It still needs to be ported from *reStructuredText* (.rst) to *MarkDown* (.md),
8-
and you can help with that!
9-
**
6+
!!! note
7+
Tracing support was added as an experimental feature in EasyBuild v3.4.0, and thus required
8+
using `--experimental`. Since EasyBuild v3.4.1, `--trace` is
9+
considered stable and no longer requires the use of
10+
`--experimental`.
1011

11-
- source: [`docs/Tracing_progress.rst` in `easybuilders/easybuild` repo](https://raw.githubusercontent.com/easybuilders/easybuild/develop/docs/Tracing_progress.rst)
12-
- target: [`docs/tracing-progress.md` in `easybuilders/easybuild-docs` repo](https://github.com/easybuilders/easybuild-docs/tree/main/docs/tracing-progress.md)
12+
## Trace output {: #trace_output }
1313

14-
See <https://github.com/easybuilders/easybuild-docs> for more information.
15-
16-
```rst
17-
.. _trace:
18-
19-
Tracing progress
20-
================
21-
22-
To trace the progress of EasyBuild while it is installing software, you can use ``eb --trace``.
23-
24-
.. note:: Tracing support was added as an experimental feature in EasyBuild v3.4.0, and thus required
25-
using ``--experimental``. Since EasyBuild v3.4.1, ``--trace`` is considered stable and no longer
26-
requires the use of ``--experimental``.
27-
28-
29-
.. contents::
30-
:depth: 3
31-
:backlinks: none
32-
33-
.. _trace_output:
34-
35-
Trace output
36-
------------
37-
38-
When ``eb --trace`` is used, EasyBuild will print additional output on top of the standard output,
39-
which only mentions which step of the installation procedure is being executed (without any further details).
14+
When `eb --trace` is used, EasyBuild will print additional output on top
15+
of the standard output, which only mentions which step of the
16+
installation procedure is being executed (without any further details).
4017

4118
This output includes:
4219

43-
* location of build and install directories
44-
* list of sources and patches
45-
* modules being loaded
46-
* executed commands
47-
* results of the sanity check
48-
* location of generated module file
49-
50-
For each (non-trivial) executed command, the location to a temporary log file will be provided so the output of that
51-
command can be monitored while it is running. In addition, the start time of the command is printed, to allow
52-
determining how long the command has been running.
53-
54-
.. _trace_example:
55-
56-
Example
57-
-------
58-
59-
.. code::
60-
61-
$ eb HDF5-1.10.1-intel-2017a.eb -df --trace --experimental
62-
== temporary log file in case of crash /tmp/eb-ieEeg3/easybuild-Ouw3jV.log
63-
== processing EasyBuild easyconfig /home/example/HDF5/HDF5-1.10.1-intel-2017a.eb
64-
== building and installing HDF5/1.10.1-intel-2017a...
65-
>> installation prefix: /prefix/software/HDF5/1.10.1-intel-2017a
66-
== fetching files...
67-
>> sources:
68-
>> /prefix/sources/h/HDF5/hdf5-1.10.1.tar.gz [SHA256: 048a9d149fb99aaa1680a712963f5a78e9c43b588d0e79d55e06760ec377c172]
69-
== creating build dir, resetting environment...
70-
>> build dir: /tmp/HDF5/1.10.1/intel-2017a
71-
== unpacking...
72-
>> running command 'tar xzf /prefix/sources/h/HDF5/hdf5-1.10.1.tar.gz' (output in /tmp/eb-ieEeg3/easybuild-run_cmd-P9kf6c.log) [started at: 2017-09-06 08:28:42]
73-
== patching...
74-
== preparing...
75-
>> loading toolchain module: intel/2017a
76-
>> (no build dependencies specified)
77-
>> loading modules for (runtime) dependencies:
78-
>> * zlib/1.2.11-GCCcore-6.3.0
79-
>> * Szip/2.1-intel-2017a
80-
>> defining build environment for intel/2017a toolchain
81-
== configuring...
82-
>> running command './configure --prefix=/prefix/software/HDF5/1.10.1-intel-2017a --with-szlib=/prefix/software/Szip/2.1-intel-2017a --with-zlib=/prefix/software/zlib/1.2.11-GCCcore-6.3.0 --with-pic --with-pthread --enable-shared --enable-cxx --enable-fortran FC="mpiifort" --enable-unsupported --enable-parallel' (output in /tmp/eb-ieEeg3/easybuild-run_cmd-dPat3D.log) [started at: 2017-09-06 08:28:44]
83-
== building...
84-
>> running command 'make -j 24 CXXFLAGS="$CXXFLAGS -DMPICH_IGNORE_CXX_SEEK" FC="mpiifort"' (output in /tmp/eb-ieEeg3/easybuild-run_cmd-25vKdK.log) [started at: 2017-09-06 08:31:01]
85-
== testing...
86-
== installing...
87-
>> running command 'make install' (output in /tmp/eb-ieEeg3/easybuild-run_cmd-BepE8P.log) [started at: 2017-09-06 08:34:09]
88-
== taking care of extensions...
89-
== postprocessing...
90-
== sanity checking...
91-
>> file 'bin/h52gif' found: OK
92-
>> file 'bin/h5c++' found: OK
93-
>> file 'bin/h5copy' found: OK
94-
>> file 'bin/h5debug' found: OK
95-
>> file 'bin/h5diff' found: OK
96-
>> file 'bin/h5dump' found: OK
97-
>> file 'bin/h5import' found: OK
98-
>> file 'bin/h5jam' found: OK
99-
>> file 'bin/h5ls' found: OK
100-
>> file 'bin/h5mkgrp' found: OK
101-
>> file 'bin/h5perf_serial' found: OK
102-
>> file 'bin/h5redeploy' found: OK
103-
>> file 'bin/h5repack' found: OK
104-
>> file 'bin/h5repart' found: OK
105-
>> file 'bin/h5stat' found: OK
106-
>> file 'bin/h5unjam' found: OK
107-
>> file 'bin/gif2h5' found: OK
108-
>> file 'bin/h5perf' found: OK
109-
>> file 'bin/h5pcc' found: OK
110-
>> file 'bin/h5pfc' found: OK
111-
>> file 'bin/ph5diff' found: OK
112-
>> file 'lib/libhdf5.so' found: OK
113-
>> file 'lib/libhdf5_cpp.so' found: OK
114-
>> file 'lib/libhdf5_fortran.so' found: OK
115-
>> file 'lib/libhdf5_hl_cpp.so' found: OK
116-
>> file 'lib/libhdf5_hl.so' found: OK
117-
>> file 'lib/libhdf5hl_fortran.so' found: OK
118-
>> (non-empty) directory 'include' found: OK
119-
== cleaning up...
120-
== creating module...
121-
>> generating module file @ /prefix/modules/all/HDF5/1.10.1-intel-2017a.lua
122-
== permissions...
123-
== packaging...
124-
== COMPLETED: Installation ended successfully
125-
== Results of the build can be found in the log file(s) /prefix/software/HDF5/1.10.1-intel-2017a/easybuild/easybuild-HDF5-1.10.1-20170906.083425.log
126-
== Build succeeded for 1 out of 1
127-
== Temporary log file(s) /tmp/eb-ieEeg3/easybuild-Ouw3jV.log* have been removed.
128-
== Temporary directory /tmp/eb-ieEeg3 has been removed.
129-
20+
- location of build and install directories
21+
- list of sources and patches
22+
- modules being loaded
23+
- executed commands
24+
- results of the sanity check
25+
- location of generated module file
26+
27+
For each (non-trivial) executed command, the location to a temporary log
28+
file will be provided so the output of that command can be monitored
29+
while it is running. In addition, the start time of the command is
30+
printed, to allow determining how long the command has been running.
31+
32+
## Example {: #trace_example }
33+
34+
``` console
35+
$ eb HDF5-1.10.1-intel-2017a.eb -df --trace --experimental
36+
== temporary log file in case of crash /tmp/eb-ieEeg3/easybuild-Ouw3jV.log
37+
== processing EasyBuild easyconfig /home/example/HDF5/HDF5-1.10.1-intel-2017a.eb
38+
== building and installing HDF5/1.10.1-intel-2017a...
39+
>> installation prefix: /prefix/software/HDF5/1.10.1-intel-2017a
40+
== fetching files...
41+
>> sources:
42+
>> /prefix/sources/h/HDF5/hdf5-1.10.1.tar.gz [SHA256: 048a9d149fb99aaa1680a712963f5a78e9c43b588d0e79d55e06760ec377c172]
43+
== creating build dir, resetting environment...
44+
>> build dir: /tmp/HDF5/1.10.1/intel-2017a
45+
== unpacking...
46+
>> running command 'tar xzf /prefix/sources/h/HDF5/hdf5-1.10.1.tar.gz' (output in /tmp/eb-ieEeg3/easybuild-run_cmd-P9kf6c.log) [started at: 2017-09-06 08:28:42]
47+
== patching...
48+
== preparing...
49+
>> loading toolchain module: intel/2017a
50+
>> (no build dependencies specified)
51+
>> loading modules for (runtime) dependencies:
52+
>> * zlib/1.2.11-GCCcore-6.3.0
53+
>> * Szip/2.1-intel-2017a
54+
>> defining build environment for intel/2017a toolchain
55+
== configuring...
56+
>> running command './configure --prefix=/prefix/software/HDF5/1.10.1-intel-2017a --with-szlib=/prefix/software/Szip/2.1-intel-2017a --with-zlib=/prefix/software/zlib/1.2.11-GCCcore-6.3.0 --with-pic --with-pthread --enable-shared --enable-cxx --enable-fortran FC="mpiifort" --enable-unsupported --enable-parallel' (output in /tmp/eb-ieEeg3/easybuild-run_cmd-dPat3D.log) [started at: 2017-09-06 08:28:44]
57+
== building...
58+
>> running command 'make -j 24 CXXFLAGS="$CXXFLAGS -DMPICH_IGNORE_CXX_SEEK" FC="mpiifort"' (output in /tmp/eb-ieEeg3/easybuild-run_cmd-25vKdK.log) [started at: 2017-09-06 08:31:01]
59+
== testing...
60+
== installing...
61+
>> running command 'make install' (output in /tmp/eb-ieEeg3/easybuild-run_cmd-BepE8P.log) [started at: 2017-09-06 08:34:09]
62+
== taking care of extensions...
63+
== postprocessing...
64+
== sanity checking...
65+
>> file 'bin/h52gif' found: OK
66+
>> file 'bin/h5c++' found: OK
67+
>> file 'bin/h5copy' found: OK
68+
>> file 'bin/h5debug' found: OK
69+
>> file 'bin/h5diff' found: OK
70+
>> file 'bin/h5dump' found: OK
71+
>> file 'bin/h5import' found: OK
72+
>> file 'bin/h5jam' found: OK
73+
>> file 'bin/h5ls' found: OK
74+
>> file 'bin/h5mkgrp' found: OK
75+
>> file 'bin/h5perf_serial' found: OK
76+
>> file 'bin/h5redeploy' found: OK
77+
>> file 'bin/h5repack' found: OK
78+
>> file 'bin/h5repart' found: OK
79+
>> file 'bin/h5stat' found: OK
80+
>> file 'bin/h5unjam' found: OK
81+
>> file 'bin/gif2h5' found: OK
82+
>> file 'bin/h5perf' found: OK
83+
>> file 'bin/h5pcc' found: OK
84+
>> file 'bin/h5pfc' found: OK
85+
>> file 'bin/ph5diff' found: OK
86+
>> file 'lib/libhdf5.so' found: OK
87+
>> file 'lib/libhdf5_cpp.so' found: OK
88+
>> file 'lib/libhdf5_fortran.so' found: OK
89+
>> file 'lib/libhdf5_hl_cpp.so' found: OK
90+
>> file 'lib/libhdf5_hl.so' found: OK
91+
>> file 'lib/libhdf5hl_fortran.so' found: OK
92+
>> (non-empty) directory 'include' found: OK
93+
== cleaning up...
94+
== creating module...
95+
>> generating module file @ /prefix/modules/all/HDF5/1.10.1-intel-2017a.lua
96+
== permissions...
97+
== packaging...
98+
== COMPLETED: Installation ended successfully
99+
== Results of the build can be found in the log file(s) /prefix/software/HDF5/1.10.1-intel-2017a/easybuild/easybuild-HDF5-1.10.1-20170906.083425.log
100+
== Build succeeded for 1 out of 1
101+
== Temporary log file(s) /tmp/eb-ieEeg3/easybuild-Ouw3jV.log* have been removed.
102+
== Temporary directory /tmp/eb-ieEeg3 has been removed.
130103
```

0 commit comments

Comments
 (0)