diff options
| author | Hartmut Goebel <h.goebel@crazy-compilers.com> | 2020-04-30 22:53:47 +0200 |
|---|---|---|
| committer | Hartmut Goebel <h.goebel@crazy-compilers.com> | 2021-01-29 22:51:23 +0100 |
| commit | 784048c27b90e32814f6d06363f94fb3f9bf0a6d (patch) | |
| tree | bde2abb7789a782b2c5b2e9a92b6840cbaf22658 /doc | |
| parent | 42008264d9fff544ee00c3c109093472b8a92bd2 (diff) | |
doc: Update guidance about Rust package naming.
* doc/contributing.texi (Rust Crates): Explain versions suffix based on
packages version and Crate "caret" versioning.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/contributing.texi | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi index d1619d3a65..f167df067c 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -802,10 +802,10 @@ To prevent namespace collisions we prefix all other Rust packages with the dashes should remain in place. In the rust ecosystem it is common for multiple incompatible versions of a -package to be used at any given time, so all packages should have a versioned -suffix. If a package has passed version 1.0.0 then just the major version -number is sufficient (e.g.@: @code{rust-clap-2}), otherwise the version suffix -should contain both the major and minor version (e.g.@: @code{rust-rand-0.6}). +package to be used at any given time, so all package definitions should have a +versioned suffix. The versioned suffix is the left-most non-zero digit (and +any leading zeros, of course). This follows the ``caret'' version scheme +intended by Cargo. Examples@: @code{rust-clap-2}, @code{rust-rand-0.6}. Because of the difficulty in reusing rust packages as pre-compiled inputs for other packages the Cargo build system (@pxref{Build Systems, |