Go to file
Maximiliano Sandoval d965713565 shared-memory: remove unneeded generic parameter
Fixes the clippy warning:

warning: type parameter `T` goes unused in function definition
  --> proxmox-shared-memory/tests/raw_shared_mutex.rs:80:19
   |
80 | fn create_test_dir<T: Init>(filename: &str) -> Option<PathBuf> {
   |                   ^^^^^^^^^ help: consider removing the parameter
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#extra_unused_type_parameters
   = note: `#[warn(clippy::extra_unused_type_parameters)]` on by default

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
2024-06-28 10:22:58 +02:00
.cargo move .cargo/config to .cargo/config.toml 2024-06-20 12:29:30 +02:00
proxmox-access-control use contains_key instead of .get().is_{some, none}() 2024-06-28 10:22:58 +02:00
proxmox-acme acme: remove duplicated attribute 2024-06-28 10:22:58 +02:00
proxmox-acme-api remove needless borrows 2024-06-28 10:22:58 +02:00
proxmox-api-macro use const blocks in thread_local! calls 2024-06-28 10:22:58 +02:00
proxmox-apt apt: update d/control 2024-06-06 11:40:49 +02:00
proxmox-async async: bump to 0.4.2 2024-06-20 14:30:10 +02:00
proxmox-auth-api remove unnecesary pub(self) 2024-06-28 10:22:58 +02:00
proxmox-borrow update d/copyright files to debian copyright-format 1.0 2023-05-23 13:02:39 +02:00
proxmox-client remove needless borrows 2024-06-28 10:22:58 +02:00
proxmox-compression compression: bump to 0.2.2-1 2024-06-20 13:59:46 +02:00
proxmox-config-digest config-digest: bump to 0.1.0-1 2024-06-05 11:24:38 +02:00
proxmox-dns-api dns-api: bump to 0.1.2-1 2024-06-20 14:00:49 +02:00
proxmox-http bump proxmox-http to 0.9.1-1 2024-03-28 13:18:21 +01:00
proxmox-http-error more import cleanups 2023-07-28 11:47:39 +02:00
proxmox-human-byte bump proxmox-human-byte to 0.1.3-1 2024-02-02 13:56:01 +01:00
proxmox-io io: bump to 1.1.0-1 2024-06-19 12:21:43 +02:00
proxmox-lang lang: bump to 1.3.0-1 2024-06-20 10:56:05 +02:00
proxmox-ldap ldap: fix Cargo.toml syntax 2024-06-25 13:54:26 +02:00
proxmox-login tree-wide: run cargo fmt 2024-03-25 17:04:17 +01:00
proxmox-metrics metrics: influxdb test uri creation 2024-05-24 10:10:38 +02:00
proxmox-network-api remove needless borrows 2024-06-28 10:22:58 +02:00
proxmox-notify remove unneeded returns 2024-06-28 10:22:58 +02:00
proxmox-openid openid: bump to 0.10.1-1 2024-06-20 14:04:41 +02:00
proxmox-product-config product-config: bump to 0.2.0 2024-06-19 12:07:37 +02:00
proxmox-rest-server rest-server: bump to 0.5.3-1 2024-06-20 14:06:12 +02:00
proxmox-router use const blocks in thread_local! calls 2024-06-28 10:22:58 +02:00
proxmox-rrd rrd: bump to 0.2.0-1 2024-06-20 13:56:06 +02:00
proxmox-schema use const blocks in thread_local! calls 2024-06-28 10:22:58 +02:00
proxmox-section-config use contains_key instead of .get().is_{some, none}() 2024-06-28 10:22:58 +02:00
proxmox-serde serde: bump to 0.1.2 2024-06-20 13:55:39 +02:00
proxmox-shared-memory shared-memory: remove unneeded generic parameter 2024-06-28 10:22:58 +02:00
proxmox-simple-config simple-config: bump to 0.1.0-1 2024-06-07 11:06:08 +02:00
proxmox-sortable-macro bump proxmox-sortable-macro to 0.1.3-1 2023-10-03 09:37:01 +02:00
proxmox-subscription trivial clippy fix 2024-06-24 10:01:13 +02:00
proxmox-sys acl: remove null pointer cast 2024-06-28 10:22:58 +02:00
proxmox-syslog-api run cargo fmt 2024-06-05 13:31:06 +02:00
proxmox-tfa remove unneeded returns 2024-06-28 10:22:58 +02:00
proxmox-time time: bump to 2.0.0-1 2024-06-20 13:49:56 +02:00
proxmox-time-api time-api: remove redundant field names 2024-06-28 10:22:58 +02:00
proxmox-uuid update d/copyright files to debian copyright-format 1.0 2023-05-23 13:02:39 +02:00
.gitignore git: ignore top level *-deb make target files 2022-08-26 12:18:44 +02:00
build.sh build.sh: split overly long line 2023-06-03 16:48:10 +02:00
bump.sh add bump.sh 2022-12-07 10:36:27 +01:00
Cargo.toml time: bump to 2.0.0-1 2024-06-20 13:49:56 +02:00
Makefile build: adapt workspace member command 2024-06-19 16:04:35 +02:00
README.rst update README 2023-08-01 15:48:19 +02:00
rustfmt.toml bump edition in rustfmt.toml 2022-10-13 15:00:28 +02:00

Local cargo config
==================

This repository ships with a ``.cargo/config`` that replaces the crates.io
registry with packaged crates located in ``/usr/share/cargo/registry``.

A similar config is also applied building with dh_cargo. Cargo.lock needs to be
deleted when switching between packaged crates and crates.io, since the
checksums are not compatible.

To reference new dependencies (or updated versions) that are not yet packaged,
the dependency needs to point directly to a path or git source.

Steps for Releases
==================

- Run ./bump.sh <CRATE> [patch|minor|major|<VERSION>]
-- Fill out changelog
-- Confirm bump commit
- Build packages with `make deb`.
-- Don't forget to commit updated d/control!

Adding Crates
=============

1) At the top level:
  - Generate the crate: ``cargo new --lib the-name``
  - Sort the crate into ``Cargo.toml``'s ``workspace.members``

2) In the new crate's ``Cargo.toml``:
  - In ``[package]`` set:
      authors.workspace = true
      license.workspace = true
      edition.workspace = true
      exclude.workspace = true
      repository.workspace = true
  - Add a meaningful ``description``
  - Copy ``debian/copyright`` and ``debian/debcargo.toml`` from another subcrate.

Adding a new Dependency
=======================

1) At the top level:
  - Add it to ``[workspace.dependencies]`` specifying the version and any
    features that should be enabled throughout the workspace

2) In each member's ``Cargo.toml``:
  - Add it to the desired dependencies section with ``workspace = true`` and no
    version specified.
  - If this member requires additional features, add only the extra features to
    the member dependency.

Updating a Dependency's Version
===============================

1) At the top level:
  - Bump the version in ``[workspace.dependencies]`` as desired.
  - Check for deprecations or breakage throughout the workspace.

Notes on Workspace Inheritance
==============================

Common metadata (like authors, license, ..) are inherited throughout the
workspace. If new fields are added that are identical for all crates, they
should be defined in the top-level ``Cargo.toml`` file's
``[workspace.package]`` section, and inherited in all members explicitly by
setting ``FIELD.workspace = true`` in the member's ``[package]`` section.

Dependency information is also inherited throughout the workspace, allowing a
single dependency specification in the top-level Cargo.toml file to be used by
all members.

Some restrictions apply:
- features can only be added in members, never removed (this includes
  ``default_features = false``!)
 - the base feature set at the workspace level should be the minimum (possibly
   empty!) set required by all members
- workspace dependency specifications cannot include ``optional``
 - if needed, the ``optional`` flag needs to be set at the member level when
   using a workspace dependency