linux-kernel - Re: [PATCH v2 1/2] README: restructure with role-based documentation and guidelines

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: <202508142316.C82AAE47@keescook>
Date: Thu, 14 Aug 2025 23:19:53 -0700
From: Kees Cook <kees@...nel.org>
To: Sasha Levin <sashal@...nel.org>
Cc: corbet@....net, josh@...htriplett.org, konstantin@...uxfoundation.org,
	linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
	rostedt@...dmis.org, workflows@...r.kernel.org
Subject: Re: [PATCH v2 1/2] README: restructure with role-based documentation
 and guidelines

On Sat, Aug 09, 2025 at 07:40:07PM -0400, Sasha Levin wrote:
> Reorganize README to provide targeted documentation paths for different
> user roles including developers, researchers, security experts,
> maintainers, and AI coding assistants. Add quick start section and
> essential docs links.

This looks really great; thank you for writing it all out!

> +* Attribution: Agents MUST add Assisted-by tag:
> +  Assisted-by: $AGENT_NAME-$AGENT_MODEL-$AGENT_VERSION $TOOL1 $TOOL2 ...
> +  Examples:
> +  - Assisted-by: Claude-claude-3-opus-20240229 checkpatch git-bisect
> +  - Assisted-by: GitHub-Copilot-GPT-4-v1.0.0 coccinelle sparse

I think "git" and "checkpatch" getting called out in Assisted-by is
overkill/redundant. Devs are going to use git constantly, and checkpatch
is already explicitly called out as a minimum standard linter for
submitting patches.

As for agent formatting, it's hard to parse "-" separators if they're
already used within the model/version. How about : or ; ?

--
Kees Cook