Skip to content

Add CLAUDE.md#155

Open
szalpal wants to merge 1 commit intoNVIDIA:mainfrom
szalpal:claude
Open

Add CLAUDE.md#155
szalpal wants to merge 1 commit intoNVIDIA:mainfrom
szalpal:claude

Conversation

@szalpal
Copy link
Copy Markdown
Member

@szalpal szalpal commented Mar 17, 2026

This PR adds CLAUDE.md to the repository

Signed-off-by: Michał Szołucha <mszolucha@nvidia.com>
@greptile-apps
Copy link
Copy Markdown

greptile-apps bot commented Mar 17, 2026

Greptile Summary

This PR adds a CLAUDE.md file to the nvidia/dali_deps repository, providing Claude Code with accurate, repo-specific guidance on what the repository is, how to clone it with shallow submodules, how to build all or individual dependencies, and how patches are managed.

  • Content is verified accurate against the actual build_scripts/build_deps.sh and the patches/ directory structure.
  • All documented environment variables (HOST_INSTALL_PREFIX, INSTALL_PREFIX, CC_COMP, CXX_COMP, CMAKE_TARGET_ARCH, WITH_FFMPEG, CLEANUP) match the defaults defined in build_deps.sh.
  • One minor imprecision: the CLEANUP=1 description says it "runs git clean -fdx on all submodules" but the script also cleans the root repo, re-initialises and re-checks-out submodules — the description could be made more complete.

Confidence Score: 5/5

  • Documentation-only PR that is safe to merge; no code changes are introduced.
  • The only changed file is a new CLAUDE.md documentation file. Its content has been verified against the actual build scripts and is accurate. The single minor inaccuracy in the CLEANUP=1 description is a documentation improvement, not a blocker. No executable code is modified.
  • No files require special attention.

Important Files Changed

Filename Overview
CLAUDE.md New documentation file guiding Claude Code in the dali_deps repository; content is accurate against the actual build scripts and directory structure, with one minor imprecision in the CLEANUP description.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Clone repo] --> B[git submodule init]
    B --> C[git submodule update --depth 1 --recursive]
    C --> D{Build target?}
    D -- All deps --> E[Set env vars\nHOST_INSTALL_PREFIX, CC_COMP, etc.]
    E --> F[bash -ex build_scripts/build_deps.sh]
    F --> G[Iterates PACKAGE_LIST\nzlib → protobuf → lmdb → ... → aws-sdk-cpp]
    G --> H[Each build_xxx.sh script\napplies patches/ if needed]
    D -- Single dep --> I[bash -ex build_scripts/build_opencv.sh\nor build_ffmpeg.sh, etc.]
    I --> H
    H --> J[Installed to INSTALL_PREFIX]

    K[CLEANUP=1] -.-> |git clean root + submodules\nreinit + force-checkout| C
Loading

Last reviewed commit: 50b8001

- `CC_COMP` / `CXX_COMP` — compiler selection (default `gcc`/`g++`)
- `CMAKE_TARGET_ARCH` — target architecture (default: host arch)
- `WITH_FFMPEG` — set to `0` to skip FFmpeg (default `1`)
- `CLEANUP=1` — runs `git clean -fdx` on all submodules before building
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 CLEANUP description slightly incomplete

CLEANUP=1 does more than clean submodule working trees. Looking at build_scripts/build_deps.sh, it actually:

  1. Runs git clean -fdx on the root repo itself
  2. Re-runs git submodule init and git submodule update --init --recursive
  3. Runs git submodule foreach 'git clean -fdx' on each submodule
  4. Runs git submodule foreach 'git checkout --force'

The current description implies only submodule cleaning, which could mislead a reader into thinking the root working tree is unaffected. Consider:

Suggested change
- `CLEANUP=1` — runs `git clean -fdx` on all submodules before building
- `CLEANUP=1` — runs `git clean -fdx` on the root repo and all submodules, re-initialises submodules, and force-checks them out before building

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.

3 participants