TheArchive/restic
1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2025-08-25 02:08:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

update documentation to reflect DEBUG_LOG for release builds

Browse Source
This commit is contained in:
Michael Eischer
2022-07-16 22:45:41 +02:00
parent 1ed775e3a8
commit b3cdee66a9
2 changed files with 22 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
doc/090_participating.rst
View File

@@ -14,18 +14,12 @@
Participating
#############
*********
Debugging
*********
**********
Debug Logs
**********
The program can be built with debug support like this:
.. code-block:: console
$ go run build.go -tags debug
Afterwards, extensive debug messages are written to the file in
environment variable ``DEBUG_LOG``, e.g.:
Set the environment variable ``DEBUG_LOG`` to let restic write extensive debug
messages to the specified filed, e.g.:
.. code-block:: console
@@ -66,6 +60,21 @@ statements originating in functions that match the pattern ``*unlock*``
$ DEBUG_FUNCS=*unlock* restic check
*********
Debugging
*********
The program can be built with debug support like this:
.. code-block:: console
$ go run build.go -tags debug
This will make the ``restic debug <subcommand>`` available which can be used to
inspect internal data structures. In addition, this enables profiling support
which can help with investigation performance and memory usage issues.
************
Contributing
************