docs: daemon: add documentation to remaining missing parts#149
docs: daemon: add documentation to remaining missing parts#149artiepoole wants to merge 11 commits intomainfrom
Conversation
df20892 to
fea319a
Compare
21568cc to
7aedcec
Compare
9787c7f to
32f6f34
Compare
7aedcec to
ee50b5a
Compare
32f6f34 to
535387c
Compare
ee50b5a to
aa2a21e
Compare
34394d2 to
8ca928f
Compare
aa2a21e to
0ae0591
Compare
b9873c6 to
6b4f386
Compare
0ae0591 to
3d6e819
Compare
66a5bd1 to
e1aba62
Compare
3d6e819 to
11234fb
Compare
e1aba62 to
992ea42
Compare
There was a problem hiding this comment.
Pull request overview
This PR primarily improves project documentation (module-level rustdocs and READMEs) across the daemon and macros crates, and also adjusts Cargo/workspace metadata to support publishing and clearer crate identity.
Changes:
- Add/expand rustdoc module documentation and examples across
daemon/src/**andfpgad_macros/src/lib.rs. - Introduce new READMEs / included docs (e.g.,
daemon/src/softeners/README.md,fpgad_macros/README.md) and a rootPUBLISHING.md. - Centralize package metadata via
[workspace.package]and rename crates/packages (daemon→fpgad,cli→fpgad_cli).
Reviewed changes
Copilot reviewed 22 out of 23 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
fpgad_macros/src/lib.rs |
Adds crate/docs inclusion and rustdoc for the #[platform] proc-macro. |
fpgad_macros/README.md |
New README describing macros crate usage. |
fpgad_macros/Cargo.toml |
Moves metadata to workspace + adds publish-oriented metadata. |
daemon/src/system_io.rs |
Adds module/function rustdocs and examples for filesystem helpers. |
daemon/src/softeners/error.rs |
Adds module/enum rustdocs for softener error types. |
daemon/src/softeners/README.md |
Large new softeners guide, included via softeners.rs. |
daemon/src/softeners.rs |
Includes the softeners README into rustdoc output. |
daemon/src/platforms/universal_components/universal_overlay_handler.rs |
Adds module/type/method rustdocs for overlay handling. |
daemon/src/platforms/universal_components/universal_fpga.rs |
Adds module/type/method rustdocs for FPGA sysfs handling. |
daemon/src/platforms/universal_components.rs |
Removes README include (module now just exports submodules). |
daemon/src/platforms/universal.rs |
Adds module/type/method rustdocs for universal platform. |
daemon/src/platforms/platform.rs |
Adds module/trait/function rustdocs for platform registry/traits. |
daemon/src/platforms/README.md |
Updates platforms documentation text and references. |
daemon/src/platforms.rs |
Includes platforms README into rustdoc output. |
daemon/src/main.rs |
Adds crate-level rustdocs for daemon entrypoint and registration. |
daemon/src/error.rs |
Adds rustdocs describing FpgadError and DBus mapping. |
daemon/src/config.rs |
Adds module rustdocs for configuration constants. |
daemon/src/comm.rs |
Adds module rustdocs for comms/DBus structure. |
daemon/Cargo.toml |
Renames package to fpgad, moves metadata to workspace, updates dependency spec. |
cli/Cargo.toml |
Renames package/bin to fpgad_cli, moves metadata to workspace. |
PUBLISHING.md |
New publishing guide and process notes. |
Cargo.toml |
Adds [workspace.package] shared metadata. |
Cargo.lock |
Updates lockfile for crate/package renames. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
daemon/src/platforms/universal_components/universal_overlay_handler.rs
Outdated
Show resolved
Hide resolved
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
…ftener Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
a todo: - add an example of fetching the correct platform object Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
992ea42 to
efae452
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 22 out of 23 changed files in this pull request and generated 10 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
427db72 to
8b60723
Compare
includes - adding new softener error to enum - adding custom fpga and custom overlayhandler files Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
757e673 to
25e8196
Compare
|
I previously accidentally added some cargo.toml and project name changes into this PR, these have been pushed to #158 which prepares for publishing - the final PR in this chain before dfx-mgr changes. This was previously causing snap builds to fail with "bin/daemon doesn't exist". Should be fixed 🤞 |
No description provided.