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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <Yu5hTr6qcLwiPRNp@debian.me>
Date:   Sat, 6 Aug 2022 19:40:46 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     Jim Cromie <jim.cromie@...il.com>
Cc:     linux-kernel@...r.kernel.org, jbaron@...mai.com,
        gregkh@...uxfoundation.org, dri-devel@...ts.freedesktop.org,
        amd-gfx@...ts.freedesktop.org, intel-gvt-dev@...ts.freedesktop.org,
        intel-gfx@...ts.freedesktop.org,
        linux-arm-kernel@...ts.infradead.org,
        linux-arm-msm@...r.kernel.org, daniel.vetter@...ll.ch,
        seanpaul@...omium.org, robdclark@...il.com,
        linux-doc@...r.kernel.org
Subject: Re: [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@...r.kernel.org
> Signed-off-by: Jim Cromie <jim.cromie@...il.com>
> 

The documentation LGTM (no new warnings).

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

-- 
An old man doll... just what I always wanted! - Clara

Download attachment "signature.asc" of type "application/pgp-signature" (274 bytes)