[PATCH v5 19/33] doc-dyndbg: edit dynamic-debug-howto for brevity, audience

[Bagas Sanjaya]

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 at vger.kernel.org
> Signed-off-by: Jim Cromie <jim.cromie at gmail.com>
> 

The documentation LGTM (no new warnings).

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

-- 
An old man doll... just what I always wanted! - Clara
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 273 bytes
Desc: not available
URL: <http://lists.infradead.org/pipermail/linux-arm-kernel/attachments/20220806/34ac7d31/attachment.sig>