lkml.org 
[lkml]   [2019]   [Dec]   [5]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH 18/18] dyndbg-docs: normalize comments in examples
Date
given that:
~# cat batch-of-dyndbg-cmd-queries > /sys/kernel/debug/dyndbg/control

works, and since '#' is a legal comment character accepted
by >control, the syntax is much more like bash than c++.

So replace '//' with '#'.
Someone might copy-paste these examples, lets make them more usable

Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
---
.../admin-guide/dynamic-debug-howto.rst | 51 ++++++++++---------
1 file changed, 27 insertions(+), 24 deletions(-)

diff --git a/Documentation/admin-guide/dynamic-debug-howto.rst b/Documentation/admin-guide/dynamic-debug-howto.rst
index d91dbb52721d..33eed4713bb8 100644
--- a/Documentation/admin-guide/dynamic-debug-howto.rst
+++ b/Documentation/admin-guide/dynamic-debug-howto.rst
@@ -189,11 +189,11 @@ format
characters (``"``) or single quote characters (``'``).
Examples::

- format svcrdma: // many of the NFS/RDMA server pr_debugs
- format readahead // some pr_debugs in the readahead cache
- format nfsd:\040SETATTR // one way to match a format with whitespace
- format "nfsd: SETATTR" // a neater way to match a format with whitespace
- format 'nfsd: SETATTR' // yet another way to match a format with whitespace
+ format svcrdma: # many of the NFS/RDMA server pr_debugs
+ format readahead # some pr_debugs in the readahead cache
+ format nfsd:\040SETATTR # one way to match a format with whitespace
+ format "nfsd: SETATTR" # a neater way to match a format with whitespace
+ format 'nfsd: SETATTR' # yet another way to match a format with whitespace

line
The given line number or range of line numbers is compared
@@ -204,10 +204,10 @@ line
the first line in the file, an empty last line number means the
last line number in the file. Examples::

- line 1603 // exactly line 1603
- line 1600-1605 // the six lines from line 1600 to line 1605
- line -1605 // the 1605 lines from line 1 to line 1605
- line 1600- // all lines from line 1600 to the end of the file
+ line 1603 # exactly line 1603
+ line 1600-1605 # the six lines from line 1600 to line 1605
+ line -1605 # the 1605 lines from line 1 to line 1605
+ line 1600- # all lines from line 1600 to the end of the file

Flags Specification::

@@ -345,44 +345,47 @@ Examples

::

- // enable the message at line 1603 of file svcsock.c
+ # enable the message at line 1603 of file svcsock.c
nullarbor:~ # echo -n 'file svcsock.c line 1603 +p' >
<debugfs>/dyndbg/control

- // enable all the messages in file svcsock.c
+ # enable all the messages in file svcsock.c
nullarbor:~ # echo -n 'file svcsock.c +p' >
<debugfs>/dyndbg/control

- // enable all the messages in the NFS server module
+ # enable all the messages in the NFS server module
nullarbor:~ # echo -n 'module nfsd +p' >
<debugfs>/dyndbg/control

- // enable all 12 messages in the function svc_process()
+ # enable all 12 messages in the function svc_process()
nullarbor:~ # echo -n 'func svc_process +p' >
<debugfs>/dyndbg/control

- // disable all 12 messages in the function svc_process()
+ # disable all 12 messages in the function svc_process()
nullarbor:~ # echo -n 'func svc_process -p' >
<debugfs>/dyndbg/control

- // enable messages for NFS calls READ, READLINK, READDIR and READDIR+.
+ # enable messages for NFS calls READ, READLINK, READDIR and READDIR+.
nullarbor:~ # echo -n 'format "nfsd: READ" +p' >
<debugfs>/dyndbg/control

- // enable messages in files of which the paths include string "usb"
+ # enable messages in files of which the paths include string "usb"
nullarbor:~ # echo -n '*usb* +p' > <debugfs>/dyndbg/control

- // enable all messages
+ # enable all messages
nullarbor:~ # echo -n '+p' > <debugfs>/dyndbg/control

- // add module, function to all enabled messages
+ # add module, function to all enabled messages
nullarbor:~ # echo -n '+mf' > <debugfs>/dyndbg/control

- // boot-args example, with newlines and comments for readability
- Kernel command line: ...
- // see whats going on in dyndbg=value processing
+ # boot-args example, with newlines and comments for readability
+ # Kernel command line: ...
+
+ # see whats going on in dyndbg=value processing
dyndbg.verbose=1
- // enable pr_debugs in 2 builtins, #cmt is stripped
+
+ # enable pr_debugs in 2 builtins, #cmt is stripped
dyndbg="module params +p #cmt ; module sys +p"
- // enable pr_debugs in 2 functions in a module loaded later
- pc87360.dyndbg="func pc87360_init_device +p; func pc87360_find +p"
+
+ # enable pr_debugs in 2 functions in a module loaded later
+ pc87360.dyndbg="func *_init_device +p; func *_find +p"
--
2.23.0
\
 
 \ /
  Last update: 2019-12-05 22:53    [W:0.141 / U:4.844 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site