From: Kees Cook <kees@kernel.org>
To: Sasha Levin <sashal@kernel.org>
Cc: corbet@lwn.net, josh@joshtriplett.org,
konstantin@linuxfoundation.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, rostedt@goodmis.org,
workflows@vger.kernel.org
Subject: Re: [PATCH v2 1/2] README: restructure with role-based documentation and guidelines
Date: Thu, 14 Aug 2025 23:19:53 -0700 [thread overview]
Message-ID: <202508142316.C82AAE47@keescook> (raw)
In-Reply-To: <20250809234008.1540324-2-sashal@kernel.org>
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
next prev parent reply other threads:[~2025-08-15 6:19 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-09 23:40 [PATCH v2 0/2] Add unified configuration for coding agents Sasha Levin
2025-08-09 23:40 ` [PATCH v2 1/2] README: restructure with role-based documentation and guidelines Sasha Levin
2025-08-10 15:44 ` Joe Perches
2025-08-10 16:46 ` Sasha Levin
2025-08-11 0:10 ` Joe Perches
2025-08-11 0:06 ` Randy Dunlap
2025-08-11 8:22 ` Geert Uytterhoeven
2025-08-11 15:48 ` Sasha Levin
2025-08-15 6:19 ` Kees Cook [this message]
2025-08-09 23:40 ` [PATCH v2 2/2] agents: add unified agent coding assistant configuration Sasha Levin
2025-08-10 7:01 ` Greg KH
2025-08-10 14:22 ` Sasha Levin
2025-08-14 0:36 ` Steven Rostedt
2025-08-15 6:23 ` Kees Cook
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=202508142316.C82AAE47@keescook \
--to=kees@kernel.org \
--cc=corbet@lwn.net \
--cc=josh@joshtriplett.org \
--cc=konstantin@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rostedt@goodmis.org \
--cc=sashal@kernel.org \
--cc=workflows@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox