From 61ed02211a8b4d9d716da3117d84905f3c939d8b Mon Sep 17 00:00:00 2001 From: Werner Koch Date: Thu, 5 Sep 2019 13:12:14 +0200 Subject: [PATCH] doc: Update description of --debug -- Signed-off-by: Werner Koch --- doc/dirmngr.texi | 10 +++++----- doc/gpg-agent.texi | 29 +++++------------------------ doc/gpg.texi | 5 +++-- doc/gpgsm.texi | 28 +++++----------------------- doc/scdaemon.texi | 32 +++++--------------------------- 5 files changed, 23 insertions(+), 81 deletions(-) diff --git a/doc/dirmngr.texi b/doc/dirmngr.texi index eb49ad96c..eb9a92160 100644 --- a/doc/dirmngr.texi +++ b/doc/dirmngr.texi @@ -198,11 +198,11 @@ however carefully selected to best aid in debugging. @item --debug @var{flags} @opindex debug -Set debugging flags. This option is only useful for debugging and its -behavior may change with a new release. All flags are or-ed and may -be given in C syntax (e.g. 0x0042) or as a comma separated list of -flag names. To get a list of all supported flags the single word -"help" can be used. +Set debug flags. All flags are or-ed and @var{flags} may be given in +C syntax (e.g. 0x0042) or as a comma separated list of flag names. To +get a list of all supported flags the single word "help" can be used. +This option is only useful for debugging and the behavior may change +at any time without notice. @item --debug-all @opindex debug-all diff --git a/doc/gpg-agent.texi b/doc/gpg-agent.texi index 78b997140..9d0dcea6c 100644 --- a/doc/gpg-agent.texi +++ b/doc/gpg-agent.texi @@ -256,30 +256,11 @@ however carefully selected to best aid in debugging. @item --debug @var{flags} @opindex debug -This option is only useful for debugging and the behavior may change at -any time without notice. FLAGS are bit encoded and may be given in -usual C-Syntax. The currently defined bits are: - -@table @code -@item 0 (1) -X.509 or OpenPGP protocol related data -@item 1 (2) -values of big number integers -@item 2 (4) -low level crypto operations -@item 5 (32) -memory allocation -@item 6 (64) -caching -@item 7 (128) -show memory statistics -@item 9 (512) -write hashed data to files named @code{dbgmd-000*} -@item 10 (1024) -trace Assuan protocol -@item 12 (4096) -bypass all certificate validation -@end table +Set debug flags. All flags are or-ed and @var{flags} may be given +in C syntax (e.g. 0x0042) or as a comma separated list of flag names. +To get a list of all supported flags the single word "help" can be +used. This option is only useful for debugging and the behavior may +change at any time without notice. @item --debug-all @opindex debug-all diff --git a/doc/gpg.texi b/doc/gpg.texi index ebf7573c9..fe9e0bfbe 100644 --- a/doc/gpg.texi +++ b/doc/gpg.texi @@ -2894,10 +2894,11 @@ however carefully selected to best aid in debugging. @item --debug @var{flags} @opindex debug -Set debugging flags. All flags are or-ed and @var{flags} may be given +Set debug flags. All flags are or-ed and @var{flags} may be given in C syntax (e.g. 0x0042) or as a comma separated list of flag names. To get a list of all supported flags the single word "help" can be -used. +used. This option is only useful for debugging and the behavior may +change at any time without notice. @item --debug-all @opindex debug-all diff --git a/doc/gpgsm.texi b/doc/gpgsm.texi index e8dd34bc6..ecc43cd3c 100644 --- a/doc/gpgsm.texi +++ b/doc/gpgsm.texi @@ -688,29 +688,11 @@ however carefully selected to best aid in debugging. @item --debug @var{flags} @opindex debug -This option is only useful for debugging and the behaviour may change -at any time without notice; using @code{--debug-levels} is the -preferred method to select the debug verbosity. FLAGS are bit encoded -and may be given in usual C-Syntax. The currently defined bits are: - -@table @code -@item 0 (1) -X.509 or OpenPGP protocol related data -@item 1 (2) -values of big number integers -@item 2 (4) -low level crypto operations -@item 5 (32) -memory allocation -@item 6 (64) -caching -@item 7 (128) -show memory statistics -@item 9 (512) -write hashed data to files named @code{dbgmd-000*} -@item 10 (1024) -trace Assuan protocol -@end table +Set debug flags. All flags are or-ed and @var{flags} may be given +in C syntax (e.g. 0x0042) or as a comma separated list of flag names. +To get a list of all supported flags the single word "help" can be +used. This option is only useful for debugging and the behavior may +change at any time without notice. Note, that all flags set using this option may get overridden by @code{--debug-level}. diff --git a/doc/scdaemon.texi b/doc/scdaemon.texi index 21c3fd826..c1ca443b9 100644 --- a/doc/scdaemon.texi +++ b/doc/scdaemon.texi @@ -160,33 +160,11 @@ helpers to debug problems. @item --debug @var{flags} @opindex debug -This option is only useful for debugging and the behavior may change at -any time without notice. FLAGS are bit encoded and may be given in -usual C-Syntax. The currently defined bits are: - -@table @code -@item 0 (1) -command I/O -@item 1 (2) -values of big number integers -@item 2 (4) -low level crypto operations -@item 5 (32) -memory allocation -@item 6 (64) -caching -@item 7 (128) -show memory statistics -@item 9 (512) -write hashed data to files named @code{dbgmd-000*} -@item 10 (1024) -trace Assuan protocol. -See also option @option{--debug-assuan-log-cats}. -@item 11 (2048) -trace APDU I/O to the card. This may reveal sensitive data. -@item 12 (4096) -trace some card reader related function calls. -@end table +Set debug flags. All flags are or-ed and @var{flags} may be given +in C syntax (e.g. 0x0042) or as a comma separated list of flag names. +To get a list of all supported flags the single word "help" can be +used. This option is only useful for debugging and the behavior may +change at any time without notice. @item --debug-all @opindex debug-all