From 8b378c5b0ef700a7347fa7d8941eca98095f1f6e Mon Sep 17 00:00:00 2001 From: Fabio Valentini Date: Fri, 8 Mar 2024 15:56:24 +0100 Subject: [PATCH] docs: add package.{extra-patches,cargo-toml-patch-comments} settings --- docs/rust2rpm.toml.5.asciidoc | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/rust2rpm.toml.5.asciidoc b/docs/rust2rpm.toml.5.asciidoc index 328fcb2..21d6237 100644 --- a/docs/rust2rpm.toml.5.asciidoc +++ b/docs/rust2rpm.toml.5.asciidoc @@ -46,17 +46,20 @@ This table contains settings that affect RPM metadata. generated if there are any "bin" (or "cdylib") targets. The default is to fall back to the name of the current crate ("%{crate}"). +*cargo-install-bin*:: + This setting controls whether binary targets are installed by the + %cargo_install macro. Setting "false" for this key causes "bin" targets not + to be installed to %{_bindir} even if a "bin" target is auto-detected or the + crate defines any "bin" target explicitly. The default value is "true". + *cargo-install-lib*:: This setting controls whether library sources are installed by the %cargo_install macro. Setting "false" for this key causes crate sources not to be installed to %{crate_instdir} even if a library target is auto-detected or the crate defines a [lib] target explicitly. The default value is "true". -*cargo-install-bin*:: - This setting controls whether binary targets are installed by the - %cargo_install macro. Setting "false" for this key causes "bin" targets not - to be installed to %{_bindir} even if a "bin" target is auto-detected or the - crate defines any "bin" target explicitly. The default value is "true". +*cargo-toml-patch-comments*:: + This setting allows persisting comments that are associated with manually created patches for Cargo.toml (i.e. by running "rust2rpm -p"). The setting accepts a list of strings. Elements of the array are treated as individual comments, and individual comments are formatted and line-wrapped to 80 characters. *extra-sources*:: This setting can be used to specify additional Sources to be included in the @@ -64,8 +67,10 @@ This table contains settings that affect RPM metadata. with three properties - "number", "file", and "comments". The integer "number" is used to set a predictable number of the Source file in the spec, the "file" is expected to be a string that contains an URL or a plain file name, and - "comments" is an array of strings which are prepended to the Source line as - comment lines. + "comments" is an array of strings that are formatted in the same way as the "cargo-toml-patch-comments" setting. + +*extra-patches*:: + This setting is similar to "extra-sources" but allows specifying additional Patch files instead of Source files. *extra-files*:: This setting allows injecting additional files into the "%files" section of