Go to file
Fabian Grünbichler 5f5a5194de schema: print item type-text instead of <array>
this is only used for CLI synopsis/usage strings, the API viewer already
prints the full type text in a correct format. the old variant was also
rather misleading, since on the CLI we don't pass in an array, but each
item as its own parameter.

noticed this while working on the pull/sync filtering series, but it
affects quite a lot of stuff, among other things the Updater and
Deleteable CLI, e.g. from `man proxmox-backup-manager`:

>       --delete <array>
>                     List of properties to delete.

vs.

>       --delete disable|validation-delay
>                     List of properties to delete.

But some of them might only have <string> as the item type text,
which is not much nicer but also not really worse.

The whole "List of .." is confusing anyway, but not easily solvable,
since the description is used for
- API dump/viewer (where it is a list/array of ..)
- usage message/man pages (where it's a parameter that gives a single
  element, but it might be passed in multiple times to construct an
  array)

Also, for some common occurrences, the item description is too
generic, and it's not possible to override the description for
external types with the current api macro.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
 [ Thomas: Added more context that was in the diffstat of the path ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-22 07:56:09 +02:00
.cargo cargo: switch to use packaged crates by default 2020-01-03 09:39:52 +01:00
proxmox schema: print item type-text instead of <array> 2021-09-22 07:56:09 +02:00
proxmox-api-macro bump proxmox-api-macro to 0.5.1-1 2021-08-30 10:46:05 +02:00
proxmox-http bump proxmox to 0.13.0-1 and proxmox-api-macro to 0.5.0 2021-08-25 09:41:17 +02:00
proxmox-sortable-macro update versions in generated control files 2021-07-20 15:45:45 +02:00
.gitignore ignore member crate target dirs as well 2021-02-03 11:18:34 +01:00
build.sh build: track d/control in git 2020-11-30 15:13:01 +01:00
Cargo.toml meta: add empty proxmox-http sub-crate 2021-05-17 09:42:16 +02:00
Makefile buildsys: drop buster from upload target 2021-07-20 08:59:59 +02:00
README.rst README: Remove 'Versioning', add 'Steps for Releases' 2020-01-15 14:26:06 +01:00
rustfmt.toml initial import, starting with vec & io helpers 2019-06-06 14:00:25 +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
==================

- Cargo.toml updates:
  - Bump all modified crate versions.
  - Update all the other crates' Cargo.toml to depend on the new versions if
    required, then bump their version as well if not already done.
- Update debian/changelog files in all the crates updated above.
- Build packages with `make deb`.