fedora-docs-l10n/packaging-guidelines/master/pages/Rust — English @ Fedora Weblate: In this case, the subpackage(s) that contain the Rust crate …

Source string Source string

English

In this case, the subpackage(s) that contain the Rust crate sources *MUST* be named `rust-$crate-devel` and `rust-$crate+$feature-devel` for all crate features and ensure that the virtual `Provides` for the Rust crate are correct.  The `rust-` prefix is not required for the name of the source package.

Needs editing

The string is read only.

Skip

	English	Actions
	unwanted / unnecessary files ("bloat"): Some projects include files that are not required for the crate to function properly (files for CI settings, development / helper scripts, etc.). Files like these SHOULD be prevented from being installed (by adding / modifying the `package.include` or `package.exclude` settings in the crate metadata). It is recommended to submit changes like this to the upstream project.
	incompatible compiler flags: Some crates include custom settings for the `release` profile that are incompatible with RPM packaging. These settings MUST be removed from the `release` profile by patching `Cargo.toml`.
	Crates that provide Rust bindings for C libraries usually require some additional changes (if possible):
	linking against system libraries: This often requires making some dependencies non-optional and / or modifying `build.rs` scripts to unconditionally link against system libraries instead of building and statically linking a bundled copy of the library.
	regenerating Rust bindings (and tests for them) at build-time: This too often requires making the `bindgen` dependency non-optional and / or modifying `build.rs` to cause regeneration of Rust bindings at build-time.
	Note that patching `Cargo.toml` files (especially changing the set of optional dependencies and features) MUST be done by running `rust2rpm -p`, since changes like these affect spec file generation (i.e. the list of generated subpackages), which is only correctly taken into account if the patch is created _before_ generation of the spec file.
	Rust crates
	A large part of the process of packaging Rust crates can (and _should_) be automated by using https://pagure.io/fedora-rust/rust2rpm[rust2rpm]. It is designed to generate spec files that are compliant with both the general and the Rust Packaging Guidelines.
	Additionally, due to some properties of packages for Rust crates (i.e. subpackages that correspond to crate features / optional dependencies), https://pagure.io/fedora-rust/rust2rpm[rust2rpm] MUST be re-run for every new version of a crate to ensure that generated feature subpackages stays in sync with crate metadata.
	Package naming
	The canonical source of Rust crates is https://crates.io[crates.io].
	Crates with Rust library interface
	Crates that are published on https://crates.io[crates.io] and that are intended to provide a Rust library interface MUST be packaged with `rust-$crate` as the name of the source package (where `$crate` is the name of the project on https://crates.io[crates.io]). This ensures that there are no name collisions between Rust crates published on https://crates.io[crates.io] and Rust crates packaged for Fedora.
	Projects from sources other than https://crates.io[crates.io] MUST NOT use the `rust-` prefix for source package names, and MUST follow the general Naming Guidelines instead. In this case, the guidelines for either link:#_rust_applications_non_crates_io_crates[single-crate Rust applications] or link:#_rust_applications_cargo_workspace_projects[cargo workspaces] apply.
	If a crate is also part of a larger project and it is not feasible to package the Rust crate separately, the Rust crate MAY be packaged from different sources (i.e. an upstream tarball) _if and only if_ the crate is also published on https://crates.io[crates.io] under the same name and with matching versions.
	In this case, the subpackage(s) that contain the Rust crate sources MUST be named `rust-$crate-devel` and `rust-$crate+$feature-devel` for all crate features and ensure that the virtual `Provides` for the Rust crate are correct. The `rust-` prefix is not required for the name of the source package.
	Crates without Rust library interface
	Crates that do not provide a Rust library interface (for example, crates that only contain executable targets) MAY drop the `rust-` prefix for the name of the source package or use the "project name" if it is different from the crate name _if and only if_ the project will not provide (or need to provide) a Rust library interface in the future, since this would require renaming the source package to `rust-$crate`. In this case, the guidelines for link:#_rust_applications_non_crates_io_crates[single-crate Rust applications] apply, and the package is not required to use the sources that are published on https://crates.io[crates.io].
	When building a crate with vendored dependencies the `rust-` prefix of the source package name MAY be dropped as well -- since packages cannot provide a Rust library interface in this case -- _if and only if_ the project will not need to provide a Rust library interface.
	When generating a package for a Rust crate that also (or exclusively) contains an application, the convention followed by https://pagure.io/fedora-rust/rust2rpm[rust2rpm] is to generate a subpackage with a name that matches the crate's name (i.e. the `rust-$crate` source package will have a `$crate` subpackage). If this name does not match expectations, it is recommended to either change the name of this subpackage, or to add virtual `Provides` for the expected name.
	Package versioning
	Projects that are built with cargo and / or published on https://crates.io[crates.io] follow Semantic Versioning (with small cargo-specific tweaks). Since SemVer strings can contain characters that are invalid in RPM version strings, they MUST be translated to be RPM-compatible.
	For example, pre-releases are denoted by a `-<pre>` suffix in SemVer, but the `-` character is invalid in RPM Versions. This can be solved by replacing `-` with the `~` character, which denotes pre-releases in RPM version strings. This translation happens automatically for the `Version` tag when generating a spec file with https://pagure.io/fedora-rust/rust2rpm[rust2rpm], and the "upstream" version is stored in a separate macro that can be used to refer to the "original" version string.
	Additionally, some Rust crates carry extra "build" metadata in their versions (a `+<build>` suffix). This format is primarily used to carry information about the version of a bundled C library. This `+<build>` suffix MUST be removed from crate metadata with a patch, since it can interfere with RPM dependency / version resolution. This happens automatically when using rust2rpm version 25 or newer.
	Package sources
	Projects from https://crates.io[crates.io] MUST be packaged from the sources that are published there (i.e. by using the `%{crates_source}` macro).
	If the sources published on https://crates.io[crates.io] do not contain all files that are necessary for creating the package (for example, missing `.desktop` file or man pages), the upstream sources can be used as an _additional_ source, but they MUST NOT be used for building the crate itself. It is recommended to file an issue with the upstream project about including these additional files in published crates.
	Crate license
	Most tooling support for determining licenses requires accurate metadata about licenses in crate metadata, including the `%cargo_license*` macros, and other third-party tools like `cargo-license` and `cargo-deny`.
	For this reason, the license metadata for all Rust crates packaged for Fedora MUST match the license tag of the Fedora package itself. Any crates that set `package.license-file` in their metadata (which is reserved for non-standard / non-SPDX licenses) MUST be patched to set `package.license` in their metadata instead in cases where this is _not_ appropriate and an accurate SPDX expression can be provided. Patches like this SHOULD be submitted upstream.
	RPM macros

Loading…

None

String added in the repository

English

English 302 characters edited Current translation Read only

2 days ago

Browse all string changes

Things to check

Unpluralised

The string is used as plural, but not using plural forms

Reset

Glossary

English	English
No related strings found in the glossary.

String information

Source string description

type: Plain text

Flags

read-only

Source string location

./pages/Rust.adoc:354

String age

2 days ago

Last updated

2 days ago

Source string age

2 days ago

Translation file

pot/master/pages/Rust.pot, string 75