All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jim Cromie <jim.cromie@gmail.com>
To: jbaron@akamai.com, gregkh@linuxfoundation.org,
	linux-kernel@vger.kernel.org
Cc: linux@rasmusvillemoes.dk, Jim Cromie <jim.cromie@gmail.com>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org
Subject: [PATCH 18/18] dyndbg-docs: normalize comments in examples
Date: Thu,  5 Dec 2019 14:51:51 -0700	[thread overview]
Message-ID: <20191205215151.421926-21-jim.cromie@gmail.com> (raw)
In-Reply-To: <20191205215151.421926-1-jim.cromie@gmail.com>

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


      parent reply	other threads:[~2019-12-05 21:52 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-12-05 21:51 [PATCH v3 00/18] dynamic-debug cleanups, 2 new features Jim Cromie
2019-12-05 21:51 ` [PATCH 01/18] dyndbg-docs: eschew file /full/path query in docs Jim Cromie
2019-12-05 21:51 ` [PATCH 02/18] dyndbg: drop obsolete comment on ddebug_proc_open Jim Cromie
2019-12-05 21:51 ` [PATCH 03/18] dyndbg: raise verbosity needed to enable ddebug_proc_* logging Jim Cromie
2019-12-05 21:51 ` [PATCH 04/18] dyndbg: rename __verbose section to __dyndbg Jim Cromie
2019-12-05 21:51 ` [PATCH 05/18] dyndbg: fix overcounting of ram used by dyndbg Jim Cromie
2019-12-05 21:51 ` [PATCH 06/18] dyndbg: fix a BUG_ON in ddebug_describe_flags Jim Cromie
2019-12-05 21:51 ` [PATCH 07/18] dyndbg: refactor parse_linerange out of ddebug_parse_query Jim Cromie
2019-12-05 21:51 ` [PATCH 08/18] dyndbg: accept 'file foo.c:func1' and 'file foo.c:10-100' Jim Cromie
2019-12-05 21:51 ` [PATCH 09/18] dyndbg: refactor ddebug_read_flags out of ddebug_parse_flags Jim Cromie
2019-12-05 21:51 ` [PATCH 10/18] dyndbg: combine flags & mask into a struct, use that Jim Cromie
2019-12-05 21:51 ` [PATCH 11/18] dyndbg: add filter parameter to ddebug_parse_flags Jim Cromie
2019-12-05 21:51 ` [PATCH 12/18] dyndbg: extend ddebug_parse_flags to accept optional filter-flags Jim Cromie
2019-12-05 21:51 ` [PATCH 13/18] dyndbg: prefer declarative init in caller, to memset in callee Jim Cromie
2019-12-05 21:51 ` [PATCH 14/16] dyndbg: add inverted-flags, implement filtering on flags Jim Cromie
2019-12-05 21:51 ` [PATCH 14/18] dyndbg: add user-flag, negating-flags, and " Jim Cromie
2019-12-05 21:51 ` [PATCH 15/16] dyndbg: allow inverted-flag-chars in modflags Jim Cromie
2019-12-05 21:51 ` [PATCH 15/18] dyndbg: allow negating flag-chars " Jim Cromie
2019-12-05 21:51 ` [PATCH 16/18] dyndbg: make ddebug_tables list LIFO for add/remove_module Jim Cromie
2019-12-05 21:51 ` [PATCH 17/18] dyndbg: rename dynamic_debug to dyndbg Jim Cromie
2019-12-05 22:24   ` Andy Shevchenko
2019-12-06  7:49     ` Rasmus Villemoes
2019-12-06 17:33       ` jim.cromie
2019-12-05 21:51 ` Jim Cromie [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191205215151.421926-21-jim.cromie@gmail.com \
    --to=jim.cromie@gmail.com \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=jbaron@akamai.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@rasmusvillemoes.dk \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.