From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [RFC] add hints to CLAUDE
Date: Tue, 8 Jul 2025 12:09:41 -0700 [thread overview]
Message-ID: <20250708190957.10108-1-stephen@networkplumber.org> (raw)
Soon users are going to want to use AI code generation like Claude
with DPDK. There is a convention for giving hints to AI tool.
Rough first draft
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
CLAUDE.md | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
create mode 100644 CLAUDE.md
diff --git a/CLAUDE.md b/CLAUDE.md
new file mode 100644
index 0000000000..42dd2e2ade
--- /dev/null
+++ b/CLAUDE.md
@@ -0,0 +1,33 @@
+# Project: DPDK
+
+## Project Description
+DPDK is a set of libraries and drivers for fast packet processing.
+It supports many processor architectures and both Linux, FreeBSD and Windows.
+
+## Licensing
+Overall project use BSD-3-Clause license with some approved exceptions.
+
+## Build Commands
+This is a C library project that uses the meson build system:
+- Build: meson setup build && ninja -C build
+- Run tests: meson test -C build --suite fast-tests
+
+## Code Conventions
+- license is per file via SPDX-License-Identifier
+- use Tabs for indentation
+- closing and opening braces on same line as the keyword
+- braces that are not necessary should be left out
+- avoid using camelCase and PascalCase
+
+
+## Project Structure
+- /lib/ - libraries
+- /license - reference copy of licenses
+- /drivers - device drivers
+- /examples - sample applications
+- /doc - documentation
+- /devtools - developer tools
+- /usertools - user tools
+- /kernel/
+ - /linux/uapi - exported kernel headers
+ - /freebsd - drivers for FreeBSD
--
2.47.2
reply other threads:[~2025-07-08 19:10 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20250708190957.10108-1-stephen@networkplumber.org \
--to=stephen@networkplumber.org \
--cc=dev@dpdk.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;
as well as URLs for NNTP newsgroup(s).