Skip to content

docs: add CLAUDE.md for the openipc-hisilicon tree - #12

Merged
widgetii merged 1 commit into
openipc-hisiliconfrom
docs/claude-md-hisilicon
Oct 17, 2026
Merged

widgetii merged 1 commit into
openipc-hisiliconfrom
docs/claude-md-hisilicon

Conversation

@widgetii

Copy link
Copy Markdown
Member

Adds CLAUDE.md, guidance for Claude Code sessions on this branch. It focuses on how the tree differs from mainline v2022.10:

  • The squashed vendor baseline (1ba97e9c9e4) and the OpenIPC commits on top.
  • Where each vendor subsystem lives.
  • The mainline files the tree patches.
  • The files the baseline replaced with the SDK's older copies (spi-nor-core, cmd/sf.c, xHCI). In a diff these show up as removed mainline features.

It also covers:

  • how build.sh assembles .config from the openipc/ fragments
  • u-boot-z.bin
  • the NOR/NAND size limits
  • the OpenIPC boot layer (openipc-common.h, common/openipc.c)
  • compatibility with environments saved by older OpenIPC bootloaders

It points to the openipc branch's CLAUDE.md, added in the companion PR.

Documentation only; no code change.

Guidance for Claude Code sessions on this branch, centred on how the
tree differs from mainline v2022.10: the squashed vendor baseline and
the OpenIPC commits on top, where each vendor subsystem lives, the
mainline files it patches, and the ones the baseline replaced with the
SDK's older copies (spi-nor-core, cmd/sf.c, xhci), which read as
removed mainline features in a diff.

It also covers how build.sh assembles each .config from the openipc/
fragments, the u-boot-z.bin image, the NOR/NAND size limits, the
OpenIPC boot layer in openipc-common.h and common/openipc.c, and the
requirement that environments saved by older OpenIPC bootloaders keep
booting. CI lives on the openipc branch, whose CLAUDE.md it points to.
@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can see how risky a PR is at a glance with blast radius labels

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document the openipc-hisilicon tree for Claude Code

📝 Documentation 🕐 10-20 Minutes

Grey Divider

AI Description

• Explain the vendor baseline, mainline changes, and locations of HiSilicon subsystems.
• Document build configuration, flashable images, size limits, and verification practices.
• Record boot-layer invariants and compatibility requirements for saved environments.
Diagram

graph TD
  Docs["CLAUDE.md"] --> Baseline["Vendor baseline"]
  Docs --> Build["build.sh"] --> Fragments["Config fragments"]
  Docs --> Defaults["Boot defaults"] --> Logic["Boot logic"]
  Docs --> CI["OpenIPC CI"]
Loading
High-Level Assessment

A single branch-specific guide is appropriate for cross-cutting Claude Code guidance. Splitting it among subsystem files would make the baseline, build, and boot compatibility constraints harder to find together.

Files changed (1) +229 / -0

Documentation (1) +229 / -0
CLAUDE.mdAdd branch-specific development and boot guidance +229/-0

Add branch-specific development and boot guidance

• Documents the relationship to mainline U-Boot, vendor subsystem locations, and mainline files replaced by older SDK copies. Explains per-SoC builds, image and size constraints, verification, OpenIPC boot behavior, saved-environment compatibility, and the companion branch's CI guidance.

CLAUDE.md

@widgetii
widgetii merged commit 655d32f into openipc-hisilicon Oct 17, 2026
40 checks passed
@widgetii
widgetii deleted the docs/claude-md-hisilicon branch October 17, 2026 06:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant