From 6a1c415a4c731f06e5ebf6932bd53168d89152c9 Mon Sep 17 00:00:00 2001 From: Dario Nieuwenhuis Date: Fri, 12 Jan 2024 00:32:47 +0100 Subject: [PATCH] Complete cargo.tomls more. --- .github/ci/doc.sh | 17 +++++++++++------ cyw43-pio/Cargo.toml | 6 ++++++ cyw43/Cargo.toml | 6 ++++++ embassy-boot-nrf/Cargo.toml | 1 + embassy-boot-rp/Cargo.toml | 1 + embassy-boot-stm32/Cargo.toml | 1 + embassy-boot/Cargo.toml | 1 + embassy-embedded-hal/Cargo.toml | 9 ++++++++- embassy-executor-macros/Cargo.toml | 3 ++- embassy-executor/Cargo.toml | 1 + embassy-futures/Cargo.toml | 1 + embassy-net-adin1110/Cargo.toml | 3 ++- embassy-net-driver-channel/Cargo.toml | 1 + embassy-net-driver/Cargo.toml | 1 + embassy-net-enc28j60/Cargo.toml | 4 +++- embassy-net-esp-hosted/Cargo.toml | 4 +++- embassy-net-tuntap/Cargo.toml | 1 + embassy-net-wiznet/Cargo.toml | 1 + embassy-net/Cargo.toml | 1 + embassy-nrf/Cargo.toml | 5 +++++ embassy-rp/Cargo.toml | 5 +++++ embassy-stm32/Cargo.toml | 5 +++++ embassy-sync/Cargo.toml | 1 + embassy-time-driver/Cargo.toml | 1 + embassy-time-queue-driver/Cargo.toml | 1 + embassy-time/Cargo.toml | 1 + embassy-usb-dfu/Cargo.toml | 1 + embassy-usb-driver/Cargo.toml | 5 +++++ embassy-usb/Cargo.toml | 5 +++++ 29 files changed, 82 insertions(+), 11 deletions(-) diff --git a/.github/ci/doc.sh b/.github/ci/doc.sh index d65bd484f..70833f934 100755 --- a/.github/ci/doc.sh +++ b/.github/ci/doc.sh @@ -23,24 +23,29 @@ docserver-builder -i ./embassy-boot-stm32 -o webroot/crates/embassy-boot-stm32/g docserver-builder -i ./embassy-embedded-hal -o webroot/crates/embassy-embedded-hal/git.zup docserver-builder -i ./embassy-executor -o webroot/crates/embassy-executor/git.zup docserver-builder -i ./embassy-futures -o webroot/crates/embassy-futures/git.zup -docserver-builder -i ./embassy-net -o webroot/crates/embassy-net/git.zup -docserver-builder -i ./embassy-net-driver -o webroot/crates/embassy-net-driver/git.zup -docserver-builder -i ./embassy-net-driver-channel -o webroot/crates/embassy-net-driver-channel/git.zup docserver-builder -i ./embassy-nrf -o webroot/crates/embassy-nrf/git.zup docserver-builder -i ./embassy-rp -o webroot/crates/embassy-rp/git.zup docserver-builder -i ./embassy-sync -o webroot/crates/embassy-sync/git.zup +docserver-builder -i ./cyw43 -o webroot/crates/cyw43/git.zup +docserver-builder -i ./cyw43-pio -o webroot/crates/cyw43-pio/git.zup +docserver-builder -i ./embassy-stm32-wpan -o webroot/crates/embassy-stm32-wpan/git.zup --output-static webroot/static + docserver-builder -i ./embassy-time -o webroot/crates/embassy-time/git.zup docserver-builder -i ./embassy-time-driver -o webroot/crates/embassy-time-driver/git.zup +docserver-builder -i ./embassy-time-queue-driver -o webroot/crates/embassy-time-queue-driver/git.zup + docserver-builder -i ./embassy-usb -o webroot/crates/embassy-usb/git.zup docserver-builder -i ./embassy-usb-driver -o webroot/crates/embassy-usb-driver/git.zup docserver-builder -i ./embassy-usb-logger -o webroot/crates/embassy-usb-logger/git.zup -docserver-builder -i ./cyw43 -o webroot/crates/cyw43/git.zup -docserver-builder -i ./cyw43-pio -o webroot/crates/cyw43-pio/git.zup + +docserver-builder -i ./embassy-net -o webroot/crates/embassy-net/git.zup +docserver-builder -i ./embassy-net-driver -o webroot/crates/embassy-net-driver/git.zup +docserver-builder -i ./embassy-net-driver-channel -o webroot/crates/embassy-net-driver-channel/git.zup docserver-builder -i ./embassy-net-wiznet -o webroot/crates/embassy-net-wiznet/git.zup docserver-builder -i ./embassy-net-ppp -o webroot/crates/embassy-net-ppp/git.zup +docserver-builder -i ./embassy-net-tuntap -o webroot/crates/embassy-net-tuntap/git.zup docserver-builder -i ./embassy-net-enc28j60 -o webroot/crates/embassy-net-enc28j60/git.zup docserver-builder -i ./embassy-net-esp-hosted -o webroot/crates/embassy-net-esp-hosted/git.zup -docserver-builder -i ./embassy-stm32-wpan -o webroot/crates/embassy-stm32-wpan/git.zup --output-static webroot/static docserver-builder -i ./embassy-net-adin1110 -o webroot/crates/embassy-net-adin1110/git.zup export KUBECONFIG=/ci/secrets/kubeconfig.yml diff --git a/cyw43-pio/Cargo.toml b/cyw43-pio/Cargo.toml index 14c07178f..b14ad7349 100644 --- a/cyw43-pio/Cargo.toml +++ b/cyw43-pio/Cargo.toml @@ -2,6 +2,12 @@ name = "cyw43-pio" version = "0.1.0" edition = "2021" +description = "RP2040 PIO SPI implementation for cyw43" +keywords = ["embedded", "cyw43", "embassy-net", "embedded-hal-async", "wifi"] +categories = ["embedded", "hardware-support", "no-std", "network-programming", "async"] +license = "MIT OR Apache-2.0" +repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/cyw43-pio" [features] # If disabled, SPI runs at 31.25MHz diff --git a/cyw43/Cargo.toml b/cyw43/Cargo.toml index 20bb039a9..3b4aada00 100644 --- a/cyw43/Cargo.toml +++ b/cyw43/Cargo.toml @@ -2,6 +2,12 @@ name = "cyw43" version = "0.1.0" edition = "2021" +description = "Rust driver for the CYW43439 WiFi chip, used in the Raspberry Pi Pico W." +keywords = ["embedded", "cyw43", "embassy-net", "embedded-hal-async", "wifi"] +categories = ["embedded", "hardware-support", "no-std", "network-programming", "async"] +license = "MIT OR Apache-2.0" +repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/cyw43" [features] defmt = ["dep:defmt"] diff --git a/embassy-boot-nrf/Cargo.toml b/embassy-boot-nrf/Cargo.toml index 7fc53648a..9e3385066 100644 --- a/embassy-boot-nrf/Cargo.toml +++ b/embassy-boot-nrf/Cargo.toml @@ -5,6 +5,7 @@ version = "0.1.0" description = "Bootloader lib for nRF chips" license = "MIT OR Apache-2.0" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-boot-nrf" categories = [ "embedded", "no-std", diff --git a/embassy-boot-rp/Cargo.toml b/embassy-boot-rp/Cargo.toml index ceb14445c..080a50777 100644 --- a/embassy-boot-rp/Cargo.toml +++ b/embassy-boot-rp/Cargo.toml @@ -5,6 +5,7 @@ version = "0.1.0" description = "Bootloader lib for RP2040 chips" license = "MIT OR Apache-2.0" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-boot-rp" categories = [ "embedded", "no-std", diff --git a/embassy-boot-stm32/Cargo.toml b/embassy-boot-stm32/Cargo.toml index f4e31bae8..4849fa02c 100644 --- a/embassy-boot-stm32/Cargo.toml +++ b/embassy-boot-stm32/Cargo.toml @@ -5,6 +5,7 @@ version = "0.1.0" description = "Bootloader lib for STM32 chips" license = "MIT OR Apache-2.0" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-boot-stm32" categories = [ "embedded", "no-std", diff --git a/embassy-boot/Cargo.toml b/embassy-boot/Cargo.toml index a70849018..801d3daa6 100644 --- a/embassy-boot/Cargo.toml +++ b/embassy-boot/Cargo.toml @@ -5,6 +5,7 @@ version = "0.1.1" description = "A lightweight bootloader supporting firmware updates in a power-fail-safe way, with trial boots and rollbacks." license = "MIT OR Apache-2.0" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-boot" categories = [ "embedded", "no-std", diff --git a/embassy-embedded-hal/Cargo.toml b/embassy-embedded-hal/Cargo.toml index c525f13fc..e89179740 100644 --- a/embassy-embedded-hal/Cargo.toml +++ b/embassy-embedded-hal/Cargo.toml @@ -3,7 +3,14 @@ name = "embassy-embedded-hal" version = "0.1.0" edition = "2021" license = "MIT OR Apache-2.0" - +description = "Collection of utilities to use `embedded-hal` and `embedded-storage` traits with Embassy." +repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-embedded-hal" +categories = [ + "embedded", + "no-std", + "asynchronous", +] [package.metadata.embassy_docs] src_base = "https://github.com/embassy-rs/embassy/blob/embassy-embedded-hal-v$VERSION/embassy-embedded-hal/src/" diff --git a/embassy-executor-macros/Cargo.toml b/embassy-executor-macros/Cargo.toml index 6ea7ddb71..57335e1e1 100644 --- a/embassy-executor-macros/Cargo.toml +++ b/embassy-executor-macros/Cargo.toml @@ -5,6 +5,7 @@ edition = "2021" license = "MIT OR Apache-2.0" description = "macros for creating the entry point and tasks for embassy-executor" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-executor-macros" categories = [ "embedded", "no-std", @@ -21,4 +22,4 @@ proc-macro2 = "1.0.29" proc-macro = true [features] -nightly = [] \ No newline at end of file +nightly = [] diff --git a/embassy-executor/Cargo.toml b/embassy-executor/Cargo.toml index 2ef3f5294..b6b156c9f 100644 --- a/embassy-executor/Cargo.toml +++ b/embassy-executor/Cargo.toml @@ -5,6 +5,7 @@ edition = "2021" license = "MIT OR Apache-2.0" description = "async/await executor designed for embedded usage" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-executor" categories = [ "embedded", "no-std", diff --git a/embassy-futures/Cargo.toml b/embassy-futures/Cargo.toml index ee1f4c9af..47cefa56f 100644 --- a/embassy-futures/Cargo.toml +++ b/embassy-futures/Cargo.toml @@ -4,6 +4,7 @@ version = "0.1.1" edition = "2021" description = "no-std, no-alloc utilities for working with futures" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-futures" readme = "README.md" license = "MIT OR Apache-2.0" categories = [ diff --git a/embassy-net-adin1110/Cargo.toml b/embassy-net-adin1110/Cargo.toml index e007e48cd..5cc399cdc 100644 --- a/embassy-net-adin1110/Cargo.toml +++ b/embassy-net-adin1110/Cargo.toml @@ -2,11 +2,12 @@ name = "embassy-net-adin1110" version = "0.2.0" description = "embassy-net driver for the ADIN1110 ethernet chip" -keywords = ["embedded", "ADIN1110", "embassy-net", "embedded-hal-async", "ethernet", "async"] +keywords = ["embedded", "ADIN1110", "embassy-net", "embedded-hal-async", "ethernet"] categories = ["embedded", "hardware-support", "no-std", "network-programming", "async"] license = "MIT OR Apache-2.0" edition = "2021" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-net-adin1110" [dependencies] heapless = "0.8" diff --git a/embassy-net-driver-channel/Cargo.toml b/embassy-net-driver-channel/Cargo.toml index 58d3d2316..c1ad11482 100644 --- a/embassy-net-driver-channel/Cargo.toml +++ b/embassy-net-driver-channel/Cargo.toml @@ -5,6 +5,7 @@ edition = "2021" license = "MIT OR Apache-2.0" description = "High-level channel-based driver for the `embassy-net` async TCP/IP network stack." repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-net-driver-channel" categories = [ "embedded", "no-std", diff --git a/embassy-net-driver/Cargo.toml b/embassy-net-driver/Cargo.toml index 9cd6a2eaa..97e8a0db3 100644 --- a/embassy-net-driver/Cargo.toml +++ b/embassy-net-driver/Cargo.toml @@ -5,6 +5,7 @@ edition = "2021" license = "MIT OR Apache-2.0" description = "Driver trait for the `embassy-net` async TCP/IP network stack." repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-net-driver" categories = [ "embedded", "no-std", diff --git a/embassy-net-enc28j60/Cargo.toml b/embassy-net-enc28j60/Cargo.toml index 92d18e38f..ab594a2f4 100644 --- a/embassy-net-enc28j60/Cargo.toml +++ b/embassy-net-enc28j60/Cargo.toml @@ -2,10 +2,12 @@ name = "embassy-net-enc28j60" version = "0.1.0" description = "embassy-net driver for the ENC28J60 ethernet chip" -keywords = ["embedded", "enc28j60", "embassy-net", "embedded-hal-async", "ethernet", "async"] +keywords = ["embedded", "enc28j60", "embassy-net", "embedded-hal-async", "ethernet"] categories = ["embedded", "hardware-support", "no-std", "network-programming", "async"] license = "MIT OR Apache-2.0" edition = "2021" +repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-net-enc28j60" [dependencies] embedded-hal = { version = "1.0" } diff --git a/embassy-net-esp-hosted/Cargo.toml b/embassy-net-esp-hosted/Cargo.toml index 7d268a8bb..dfca8bec6 100644 --- a/embassy-net-esp-hosted/Cargo.toml +++ b/embassy-net-esp-hosted/Cargo.toml @@ -3,9 +3,11 @@ name = "embassy-net-esp-hosted" version = "0.1.0" edition = "2021" description = "embassy-net driver for ESP-Hosted" -keywords = ["embedded", "esp-hosted", "embassy-net", "embedded-hal-async", "wifi", "async"] +keywords = ["embedded", "esp-hosted", "embassy-net", "embedded-hal-async", "wifi"] categories = ["embedded", "hardware-support", "no-std", "network-programming", "async"] license = "MIT OR Apache-2.0" +repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-net-esp-hosted" [dependencies] defmt = { version = "0.3", optional = true } diff --git a/embassy-net-tuntap/Cargo.toml b/embassy-net-tuntap/Cargo.toml index d58680481..1044151ae 100644 --- a/embassy-net-tuntap/Cargo.toml +++ b/embassy-net-tuntap/Cargo.toml @@ -7,6 +7,7 @@ categories = ["embedded", "hardware-support", "network-programming", "async"] license = "MIT OR Apache-2.0" edition = "2021" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-net-tuntap" [dependencies] embassy-net-driver = { version = "0.2.0", path = "../embassy-net-driver" } diff --git a/embassy-net-wiznet/Cargo.toml b/embassy-net-wiznet/Cargo.toml index c703d8bc6..b52aecc70 100644 --- a/embassy-net-wiznet/Cargo.toml +++ b/embassy-net-wiznet/Cargo.toml @@ -7,6 +7,7 @@ categories = ["embedded", "hardware-support", "no-std", "network-programming", " license = "MIT OR Apache-2.0" edition = "2021" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-net-wiznet" [dependencies] embedded-hal = { version = "1.0" } diff --git a/embassy-net/Cargo.toml b/embassy-net/Cargo.toml index ffa4a64b6..44bd2e8f3 100644 --- a/embassy-net/Cargo.toml +++ b/embassy-net/Cargo.toml @@ -5,6 +5,7 @@ edition = "2021" license = "MIT OR Apache-2.0" description = "Async TCP/IP network stack for embedded systems" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-net" categories = [ "embedded", "no-std", diff --git a/embassy-nrf/Cargo.toml b/embassy-nrf/Cargo.toml index 39b4cc598..f79da9d77 100644 --- a/embassy-nrf/Cargo.toml +++ b/embassy-nrf/Cargo.toml @@ -3,6 +3,11 @@ name = "embassy-nrf" version = "0.1.0" edition = "2021" license = "MIT OR Apache-2.0" +description = "Embassy Hardware Abstraction Layer (HAL) for nRF series microcontrollers" +keywords = ["embedded", "async", "nordic", "nrf", "embedded-hal"] +categories = ["embedded", "hardware-support", "no-std", "async"] +repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-nrf" [package.metadata.embassy_docs] src_base = "https://github.com/embassy-rs/embassy/blob/embassy-nrf-v$VERSION/embassy-nrf/src/" diff --git a/embassy-rp/Cargo.toml b/embassy-rp/Cargo.toml index 16d55182a..503d4bddc 100644 --- a/embassy-rp/Cargo.toml +++ b/embassy-rp/Cargo.toml @@ -3,6 +3,11 @@ name = "embassy-rp" version = "0.1.0" edition = "2021" license = "MIT OR Apache-2.0" +description = "Embassy Hardware Abstraction Layer (HAL) for the Raspberry Pi RP2040 microcontroller" +keywords = ["embedded", "async", "raspberry-pi", "rp2040", "embedded-hal"] +categories = ["embedded", "hardware-support", "no-std", "async"] +repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-rp" [package.metadata.embassy_docs] src_base = "https://github.com/embassy-rs/embassy/blob/embassy-rp-v$VERSION/embassy-rp/src/" diff --git a/embassy-stm32/Cargo.toml b/embassy-stm32/Cargo.toml index 3b9f07e49..ac672788f 100644 --- a/embassy-stm32/Cargo.toml +++ b/embassy-stm32/Cargo.toml @@ -3,6 +3,11 @@ name = "embassy-stm32" version = "0.1.0" edition = "2021" license = "MIT OR Apache-2.0" +description = "Embassy Hardware Abstraction Layer (HAL) for ST STM32 series microcontrollers" +keywords = ["embedded", "async", "stm32", "hal", "embedded-hal"] +categories = ["embedded", "hardware-support", "no-std", "async"] +repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-stm32" [package.metadata.embassy_docs] src_base = "https://github.com/embassy-rs/embassy/blob/embassy-stm32-v$VERSION/embassy-stm32/src/" diff --git a/embassy-sync/Cargo.toml b/embassy-sync/Cargo.toml index 38b0e5d30..85673026c 100644 --- a/embassy-sync/Cargo.toml +++ b/embassy-sync/Cargo.toml @@ -4,6 +4,7 @@ version = "0.5.0" edition = "2021" description = "no-std, no-alloc synchronization primitives with async support" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-sync" readme = "README.md" license = "MIT OR Apache-2.0" categories = [ diff --git a/embassy-time-driver/Cargo.toml b/embassy-time-driver/Cargo.toml index e252c354a..d9f2e97df 100644 --- a/embassy-time-driver/Cargo.toml +++ b/embassy-time-driver/Cargo.toml @@ -4,6 +4,7 @@ version = "0.1.0" edition = "2021" description = "Driver trait for embassy-time" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-time-driver" readme = "README.md" license = "MIT OR Apache-2.0" categories = [ diff --git a/embassy-time-queue-driver/Cargo.toml b/embassy-time-queue-driver/Cargo.toml index 85ee1da1b..9ce9d79bb 100644 --- a/embassy-time-queue-driver/Cargo.toml +++ b/embassy-time-queue-driver/Cargo.toml @@ -4,6 +4,7 @@ version = "0.1.0" edition = "2021" description = "Timer queue driver trait for embassy-time" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-time-queue-driver" readme = "README.md" license = "MIT OR Apache-2.0" categories = [ diff --git a/embassy-time/Cargo.toml b/embassy-time/Cargo.toml index 6b1c7cc58..6b0a0f22d 100644 --- a/embassy-time/Cargo.toml +++ b/embassy-time/Cargo.toml @@ -4,6 +4,7 @@ version = "0.3.0" edition = "2021" description = "Instant and Duration for embedded no-std systems, with async timer support" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-time" readme = "README.md" license = "MIT OR Apache-2.0" categories = [ diff --git a/embassy-usb-dfu/Cargo.toml b/embassy-usb-dfu/Cargo.toml index 6087bcd7d..b0eb917e6 100644 --- a/embassy-usb-dfu/Cargo.toml +++ b/embassy-usb-dfu/Cargo.toml @@ -5,6 +5,7 @@ version = "0.1.0" description = "An implementation of the USB DFU 1.1 protocol, using embassy-boot" license = "MIT OR Apache-2.0" repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-usb-dfu" categories = [ "embedded", "no-std", diff --git a/embassy-usb-driver/Cargo.toml b/embassy-usb-driver/Cargo.toml index 460cb306a..6d36106cd 100644 --- a/embassy-usb-driver/Cargo.toml +++ b/embassy-usb-driver/Cargo.toml @@ -3,6 +3,11 @@ name = "embassy-usb-driver" version = "0.1.0" edition = "2021" license = "MIT OR Apache-2.0" +description = "Driver trait for `embassy-usb`, an async USB device stack for embedded devices." +keywords = ["embedded", "async", "usb", "hal", "embedded-hal"] +categories = ["embedded", "hardware-support", "no-std", "async"] +repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-usb-driver" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/embassy-usb/Cargo.toml b/embassy-usb/Cargo.toml index 029754e73..be810b510 100644 --- a/embassy-usb/Cargo.toml +++ b/embassy-usb/Cargo.toml @@ -3,6 +3,11 @@ name = "embassy-usb" version = "0.1.0" edition = "2021" license = "MIT OR Apache-2.0" +description = "Async USB device stack for embedded devices in Rust." +keywords = ["embedded", "async", "usb", "hal", "embedded-hal"] +categories = ["embedded", "hardware-support", "no-std", "async"] +repository = "https://github.com/embassy-rs/embassy" +documentation = "https://docs.embassy.dev/embassy-usb" [package.metadata.embassy_docs] src_base = "https://github.com/embassy-rs/embassy/blob/embassy-usb-v$VERSION/embassy-usb/src/"