Skip to content

Commit

Permalink
rust: Add mandatory description field, other misc changes
Browse files Browse the repository at this point in the history
I want to publish `composefs-sys` but a `description` field
is required, which is annoyingly not found by `cargo publish --dry-run`.

Do a few other tweaks while we're here, including talking
about language bindings in `README.md`.
  • Loading branch information
cgwalters committed Jun 3, 2024
1 parent 28dc491 commit 2fe6025
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,3 +153,17 @@ Mount options:
- `upperdir`: Specify an upperdir for the overlayfs filesystem.
- `workdir`: Specify an upperdir for the overlayfs filesystem.
- `idmap`: Specify a path to a user namespace that is used as an idmap.

## Language bindings

### Rust

There are two Rust crates whose source code is included in this repository:

- `composefs-sys`: Low level unsafe `-sys` style wrapper library for linking to the `libcomposefs` C library
- `composefs-core`: Safe library that depends on `composefs-sys`, and also adds wrappers for invoking the external `mkfs.composefs` and `composefs-info dump` binaries.

### Go

The containers/storage Go library has [code wrapping mkcomposefs](https://github.com/containers/storage/blob/5fe400b7aedc7385e07a938d393d50600ca06299/drivers/overlay/composefs.go#L41)
that could in theory be extracted to a helper package.
4 changes: 2 additions & 2 deletions rust/composefs-core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
name = "composefs"
version = "0.1.0"
edition = "2021"
description = "Rust composefs"
keywords = ["composefs", "oci", "opencontainers", "docker", "podman"]
description = "Rust library for the composefs filesystem"
keywords = ["composefs"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/containers/composefs"
rust-version = "1.70.0"
Expand Down
4 changes: 2 additions & 2 deletions rust/composefs-sys/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
[package]
name = "composefs-sys"
description = "Rust library wrapping the libcomposefs C library"
keywords = ["composefs"]
version = "0.1.0"
edition = "2021"
links = "composefs"
Expand All @@ -10,8 +12,6 @@ license = "MIT OR Apache-2.0"
name = "composefs"
version = "1"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[features]
# Depend on 1.0.4 APIs
v1_0_4 = []
Expand Down

0 comments on commit 2fe6025

Please sign in to comment.