diff options
author | Jim Cromie <jim.cromie@gmail.com> | 2022-09-04 15:40:56 -0600 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2022-09-07 17:04:49 +0200 |
commit | ace7c4bbb240d076a9e2079027252420d920d0d0 (patch) | |
tree | 074710e002b039f4c95a46e5514206e0e9eb038a /lib/dynamic_debug.c | |
parent | 753914ed85ac396977116f5807af809083c7806a (diff) | |
download | linux-ace7c4bbb240d076a9e2079027252420d920d0d0.tar.gz linux-ace7c4bbb240d076a9e2079027252420d920d0d0.tar.bz2 linux-ace7c4bbb240d076a9e2079027252420d920d0d0.zip |
doc-dyndbg: edit dynamic-debug-howto for brevity, audience
Rework/modernize docs:
- use /proc/dynamic_debug/control in examples
its *always* there (when dyndbg is config'd), even when <debugfs> is not.
drop <debugfs> talk, its a distraction here.
- alias ddcmd='echo $* > /proc/dynamic_debug/control
focus on args: declutter, hide boilerplate, make pwd independent.
- swap sections: Viewing before Controlling. control file as Catalog.
- focus on use by a system administrator
add an alias to make examples more readable
drop grep-101 lessons, admins know this.
- use init/main.c as 1st example, thread it thru doc where useful.
everybodys kernel boots, runs these.
- add *prdbg* api section
to the bottom of the file, its for developers more than admins.
move list of api functions there.
- simplify - drop extra words, phrases, sentences.
- add "decorator" flags line to unify "prefix", trim fmlt descriptions
CC: linux-doc@vger.kernel.org
Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
Link: https://lore.kernel.org/r/20220904214134.408619-20-jim.cromie@gmail.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'lib/dynamic_debug.c')
0 files changed, 0 insertions, 0 deletions