Add Meson mentions

[mikusaq]

Summary by CodeRabbit

• Documentation
  • Architecture docs now reflect support for both CMake and Meson.
  • Clarified packaging flow: files are archived (not just zipped) and copied to the Package Repository.
  • Public API diagram documents a sysroot creation capability in the Packager.
  • Example usage updated to include Meson options alongside CMake.
  • Git revision guidance expanded to allow tag, branch, or commit.
  • Minor wording refinements and error guidance updates.

[coderabbitai]

Walkthrough

Documentation updates add Meson support alongside CMake, adjust packaging flow to mention archiving and repository copy, and introduce the Packager.createSysroot(context, imageName, repository, sysrootDir) method in the public API diagram.

Changes

Cohort / File(s)	Summary
Architecture docs docs/architecture.md	Updated build system support (CMake and Meson), refined packaging step to archiving + copy to Package Repository, and added Packager.createSysroot(context: Context, imageName: string, repository: PackageRepository, sysrootDir: string) to the public API diagram.
Example usage docs docs/example_usage.md	Prerequisites now allow CMake or Meson; config fields expanded (URI for CMake/Meson repos, Revision can be tag/branch/commit); added Meson options/defines alongside CMake; wording aligned across sections.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant BuildContext as Context
  participant Packager
  participant Repo as PackageRepository
  participant FS as SysrootDir

  User->>Packager: createSysroot(context, imageName, repository, sysrootDir)
  Packager->>BuildContext: Resolve build metadata (imageName)
  Packager->>Repo: Fetch required packages/artifacts
  Packager->>FS: Assemble files into sysroot directory
  Packager->>Repo: Archive and copy packaged sysroot
  Packager-->>User: Result (sysroot path / status)
  note over Packager,Repo: New/updated flow mentions archiving and repository copy

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• First documentation #1 — Also updates docs/architecture.md with Packager API changes and description, likely aligned with this Meson and createSysroot addition.

Suggested reviewers

• koudis

Poem

In burrows of docs, I hop and compose,
CMake meets Meson—two carrots in rows. 🥕🥕
A sysroot sprouts where packages grow,
Archive, then stash, to the repo we go.
Dear Packager, lead—I'll thump in delight,
For builds now bounce with rabbit-white light.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "Add Meson mentions" is concise and directly reflects the main change in this PR—documentation updates to mention Meson alongside CMake (notably in docs/architecture.md and docs/example_usage.md)—making it clear and relevant for reviewers.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch BAF-1175/add-meson

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

docs/architecture.md (1)

89-127: Add missing Sysroot class to the diagram

The diagram references Sysroot in relationships, but the class isn’t declared. Add it to avoid Mermaid rendering warnings and to keep the model consistent.

 classDiagram
     class Packager {
       -context: Context
       -readDockerfiles(context: Context)
       -readAppConfigs(context: Context)
       -readPackageConfigs(context: Context)
       -readAppConfigs(context: Context)
       +buildImage(context: Context, imageName: string)
       +buildPackage(context: Context, packageName: string, options: BuildOptions)
       +buildApp(context: Context, appName: string, options: BuildOptions)
       +createSysroot(context: Context, imageName: string, repository: PackageRepository, sysrootDir: string)
     }
     class PackageContext
+    class Sysroot
 
     namespace Docker {
         class DockerImage
         class DockerContainer
     }
 
     class PackageRepository

docs/example_usage.md (2)

101-104: Fix list indentation (markdownlint MD007)

Top-level bullets should start at column 0. Also, good call-out that either CMake or Meson can be installed.

- - CMake or Meson must be installed,
- - SSH must be configured with root login and password `1234`,
- - and `uname` must be installed.
+- CMake or Meson must be installed,
+- SSH must be configured with root login and password `1234`,
+- and `uname` must be installed.

---

162-168: Clarify Meson fields and fix list indentation (markdownlint MD007)

Great update to include Meson. Also clarify exclusivity and align bullets to column 0.

- - `DependsOn` - list of dependency Packages, all Packages in the list must be defined in the same Package Context
- - `Git/URI` - URI to a CMake or Meson based git repository with source code of the Package
- - `Git/Revision` - tag, branch or commit to use for build
- - `Build/CMake/Defines` - CMake options (or `Build/Meson/Options` and `Build/Meson/Defines` for Meson)
- - `Package/Name` - name of the Package
- - `DockerMatrix/ImageNames` - list of Docker images to build the Package for
+- `DependsOn` - list of dependency Packages, all Packages in the list must be defined in the same Package Context
+- `Git/URI` - URI to a CMake or Meson based git repository with source code of the Package
+- `Git/Revision` - tag, branch or commit to use for build
+- `Build/CMake/Defines` - CMake options (or `Build/Meson/Options` and `Build/Meson/Defines` for Meson)
+- `Package/Name` - name of the Package
+- `DockerMatrix/ImageNames` - list of Docker images to build the Package for
+
+Note: Use either Build/CMake or Build/Meson in a single Config, not both.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b7e7d7e and 6214d5e.

📒 Files selected for processing (2)

• docs/architecture.md (1 hunks)
• docs/example_usage.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

docs/example_usage.md

101-101: Unordered list indentation
Expected: 0; Actual: 1

(MD007, ul-indent)

---

163-163: Unordered list indentation
Expected: 0; Actual: 1

(MD007, ul-indent)

---

164-164: Unordered list indentation
Expected: 0; Actual: 1

(MD007, ul-indent)

---

165-165: Unordered list indentation
Expected: 0; Actual: 1

(MD007, ul-indent)

🔇 Additional comments (1)

docs/architecture.md (1)

73-74: Meson support mention looks good

Clear and concise addition acknowledging both CMake and Meson.