docs: add documentation for dm.libdm_log_level #324
Conversation
|
The |
|
lint and test are fixed on master. You can rebase to pickup the fixes |
cyphar
force-pushed
the
libdm-debug-flag-docs
branch
from
93bf1fb to
58dc7f0
Compare
Codecov Report
@@ Coverage Diff @@
## master #324 +/- ##
==========================================
+ Coverage 48.84% 48.85% +<.01%
==========================================
Files 186 186
Lines 12413 12413
==========================================
+ Hits 6063 6064 +1
+ Misses 5976 5975 -1
Partials 374 374 |
|
moby/moby#33845 has been merged, so this can now be reviewed. |
|
Sorry, there is another fix on master for the CI failures. |
| @@ -700,6 +700,34 @@ ENOSPC and will shutdown filesystem. | |||
| $ sudo dockerd --storage-opt dm.xfs_nospace_max_retries=0 | |||
| ``` | |||
|
|
|||
| ##### `dm.libdm_log_level` | |||
There was a problem hiding this comment.
Wow, level 5. This file needs a reorg, not in this PR.
| @@ -700,6 +700,34 @@ ENOSPC and will shutdown filesystem. | |||
| $ sudo dockerd --storage-opt dm.xfs_nospace_max_retries=0 | |||
| ``` | |||
|
|
|||
| ##### `dm.libdm_log_level` | |||
|
|
|||
| Specifies the maxmimum `libdm` log level that will be forwarded to `dockerd`'s | |||
There was a problem hiding this comment.
Maybe "the dockerd log"?
|
|
||
| Specifies the maxmimum `libdm` log level that will be forwarded to `dockerd`'s | ||
| log (as specified by `--log-level`). This option is primarily intended for | ||
| debugging bugs involving interactions with `libdm`, and non-default values will |
There was a problem hiding this comment.
"debugging bugs"? How about "diagnosing problems with libdm"?
| Specifies the maxmimum `libdm` log level that will be forwarded to `dockerd`'s | ||
| log (as specified by `--log-level`). This option is primarily intended for | ||
| debugging bugs involving interactions with `libdm`, and non-default values will | ||
| likely cause erroneous warnings to be output when no actual error has occurred. |
There was a problem hiding this comment.
Maybe "Using values other than the defaults will cause false positive warnings to be logged."
| likely cause erroneous warnings to be output when no actual error has occurred. | ||
|
|
||
| Values specified must fall within the range of valid `libdm` log levels. At the | ||
| time of writing, the following is the list of `libdm` log levels as well as |
There was a problem hiding this comment.
Rather than listing these, can you provide a link to the libdm docs?
There was a problem hiding this comment.
libdm doesn't have API documentation, see https://bugzilla.redhat.com/show_bug.cgi?id=526867. I actually pulled these values from the source code (I was debugging another issue in libdm).
cyphar
force-pushed
the
libdm-debug-flag-docs
branch
from
58dc7f0 to
d8bf905
Compare
This is a new option added specifically to allow for debugging of bugs in Docker's storage drivers or libdm itself. Signed-off-by: Aleksa Sarai <asarai@suse.de>
cyphar
force-pushed
the
libdm-debug-flag-docs
branch
from
d8bf905 to
c771081
Compare
|
/cc @albers @sdurrheimer - in case completion scripts need to be updated |
|
Misty's comments look to be all addressed, so I'll merge |
This is a new option added specifically to allow for debugging of bugs
in Docker's storage drivers or libdm itself.
See moby/moby#33845
Signed-off-by: Aleksa Sarai asarai@suse.de