Skip to content

docs: clone dmod with its submodules - #342

Merged
JohnAmadis merged 1 commit into
developfrom
docs/clone-with-submodules
Oct 28, 2026
Merged

JohnAmadis merged 1 commit into
developfrom
docs/clone-with-submodules

Conversation

@JaxCalder

Copy link
Copy Markdown
Contributor

What

Documentation only. Since #341 dmod keeps its compression library (dmcomp) in a git submodule, and a clone without it cannot be configured ("run git submodule update --init --recursive"):

  • docs/tools-installation.md, Option B: git clone --recursive;
  • the READMEs of the library and application templates (.github/templates/*/README.md.template), which suggest a local dmod checkout with -DDMOD_DIR, say that it needs its submodules.

(The CI workflows of the modules that cloned dmod without the submodules are fixed in dmfatfs#4, dmfsi#22, dmblock#7 and dmlittlefs#3.)

🤖 Generated with Claude Code

Since dmod#341 the compression library (dmcomp) is a git submodule, and a clone without it cannot
be configured. The installation guide (Option B) clones with --recursive, and the READMEs of the
library and application templates, which suggest a local checkout with -DDMOD_DIR, say that the
checkout needs its submodules.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@JohnAmadis
JohnAmadis merged commit 24ef35b into develop Oct 28, 2026
6 checks passed
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.

2 participants