Go to file
Wolfgang Bumiller 5eb7cbd250 cli: deal with commands without positional args
When reaching the final command we relied on the positional parameters
"ending" the global option parsing. This means we did not get global
options at the end, and failed with "unknown option" instead.
Fix this by simply retaining unknown options in that case and not
stopping at positional parameters.

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2024-07-22 09:03:56 +02:00
.cargo move .cargo/config to .cargo/config.toml 2024-06-20 12:29:30 +02:00
proxmox-access-control access-control: add init_user_config() method 2024-07-22 09:03:56 +02:00
proxmox-acme fix typos in rust api documentation 2024-07-22 08:49:42 +02:00
proxmox-acme-api acme-api: bump to 0.1.3-1 2024-07-11 15:25:25 +02:00
proxmox-api-macro fix typos in code documentation 2024-07-22 08:49:42 +02:00
proxmox-apt fix typos in rust api documentation 2024-07-22 08:49:42 +02:00
proxmox-apt-api-types fix typos in rust api documentation 2024-07-22 08:49:42 +02:00
proxmox-async tree-wide: enable doc_cfg and doc_auto_cfg for docs 2024-07-02 11:59:53 +02:00
proxmox-auth-api fix typos in strings 2024-07-22 08:49:42 +02:00
proxmox-borrow tree-wide: enable doc_cfg and doc_auto_cfg for docs 2024-07-02 11:59:53 +02:00
proxmox-client fix typos in strings 2024-07-22 08:49:42 +02:00
proxmox-compression compression: bump version to 0.2.3-1 2024-07-10 12:15:54 +02:00
proxmox-config-digest tree-wide: enable doc_cfg and doc_auto_cfg for docs 2024-07-02 11:59:53 +02:00
proxmox-dns-api dns-api: bump to 0.1.3-1 2024-07-11 15:27:13 +02:00
proxmox-http fix typos in rust api documentation 2024-07-22 08:49:42 +02:00
proxmox-http-error tree-wide: enable doc_cfg and doc_auto_cfg for docs 2024-07-02 11:59:53 +02:00
proxmox-human-byte tree-wide: enable doc_cfg and doc_auto_cfg for docs 2024-07-02 11:59:53 +02:00
proxmox-io fix typos in rust api documentation 2024-07-22 08:49:42 +02:00
proxmox-lang tree-wide: enable doc_cfg and doc_auto_cfg for docs 2024-07-02 11:59:53 +02:00
proxmox-ldap fix typos in rust api documentation 2024-07-22 08:49:42 +02:00
proxmox-log log: reorder filters as a small optimization 2024-07-18 12:11:43 +02:00
proxmox-login fix typos in rust api documentation 2024-07-22 08:49:42 +02:00
proxmox-metrics tree-wide: enable doc_cfg and doc_auto_cfg for docs 2024-07-02 11:59:53 +02:00
proxmox-network-api network-api: bump to 0.1.2-1 2024-07-11 15:28:39 +02:00
proxmox-notify fix typos in variable and function names 2024-07-22 08:49:42 +02:00
proxmox-openid openid: bump to 0.10.2-1 2024-07-11 15:24:52 +02:00
proxmox-product-config fix typos in code documentation 2024-07-22 08:49:42 +02:00
proxmox-rest-server fix typos in code documentation 2024-07-22 08:49:42 +02:00
proxmox-router cli: deal with commands without positional args 2024-07-22 09:03:56 +02:00
proxmox-rrd fix typos in code documentation 2024-07-22 08:49:42 +02:00
proxmox-schema fix typos in strings 2024-07-22 08:49:42 +02:00
proxmox-section-config fix typos in strings 2024-07-22 08:49:42 +02:00
proxmox-serde tree-wide: enable doc_cfg and doc_auto_cfg for docs 2024-07-02 11:59:53 +02:00
proxmox-shared-memory shared-memory: bump to 0.3.1-1 2024-07-11 15:24:52 +02:00
proxmox-simple-config tree-wide: enable doc_cfg and doc_auto_cfg for docs 2024-07-02 11:59:53 +02:00
proxmox-sortable-macro tree-wide: enable doc_cfg and doc_auto_cfg for docs 2024-07-02 11:59:53 +02:00
proxmox-subscription subscription: bump to 0.4.5-1 2024-07-11 15:24:52 +02:00
proxmox-sys fix typos in code documentation 2024-07-22 08:49:42 +02:00
proxmox-syslog-api syslog-api: bump to 0.1.1-1 2024-07-12 11:13:24 +02:00
proxmox-tfa fix typos in strings 2024-07-22 08:49:42 +02:00
proxmox-time fix typos in strings 2024-07-22 08:49:42 +02:00
proxmox-time-api time-api: bump to 0.1.3-1 2024-07-11 15:31:50 +02:00
proxmox-uuid fix typos in code documentation 2024-07-22 08:49:42 +02:00
proxmox-worker-task worker-task: bump to 0.1.0-1 2024-07-11 14:47:25 +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 schema: bump to 3.1.2-1 2024-07-17 14:18:04 +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