lkml.org 
[lkml]   [2022]   [Aug]   [6]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v5 19/33] doc-dyndbg: edit dynamic-debug-howto for brevity, audience
On Fri, Aug 05, 2022 at 03:53:41PM -0600, Jim Cromie wrote:
> 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>
>

The documentation LGTM (no new warnings).

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

--
An old man doll... just what I always wanted! - Clara
[unhandled content-type:application/pgp-signature]
\
 
 \ /
  Last update: 2022-08-06 14:41    [W:0.121 / U:2.456 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site