diff --git a/content/docs/rpm/macros.mdx b/content/docs/rpm/macros.mdx index a771e747..30f30969 100644 --- a/content/docs/rpm/macros.mdx +++ b/content/docs/rpm/macros.mdx @@ -6,7 +6,7 @@ description: "Documentations for different RPM macros." import * as Split from "../../../components/split"; -# RPM Macros +## RPM Macros Technically, there are 3 types of "macros": @@ -28,7 +28,7 @@ This document only covers the first type. Conversely, if there *is* a space you SHOULD assume the flag needs a space between them. - + For macros which use regex ([`%__requires_exclude`](#__requires_exclude), [`%__requires_exclude_from`](#__requires_exclude_from), [`%__provides_exclude`](#__provides_exclude), [`%__provides_exclude_from`](#__provides_exclude_from), [`%__brp_mangle_shebangs_exclude_from`](#__brp_mangle_shebangs_exclude_from)) you SHOULD also note the [quirks with regex](/rpm/macro#escaping-regex-in-rpm-macros) in RPM. @@ -47,9 +47,9 @@ If you would like to learn more about the RPM macro syntax, check out [Macro syn - 🔩 : Usually used with `rpm -E` but not in spec files. - 🏷️ : Usually defined but not used directly. -## RPM Built-in Macros +### RPM Built-in Macros -### Macro Manipulation +#### Macro Manipulation This list is obtained from @@ -58,7 +58,7 @@ If you would like to learn more about the RPM macro syntax, check out [Macro syn docs](https://github.com/rpm-software-management/rpm/blob/b043604b9eb684dc761aeacf55a784632ca0ebcd/docs/manual/macros.md#builtin-macros). -#### `%define` 🔰 [#define] +##### `%define` 🔰 [#define] Defines a macro locally. @@ -91,7 +91,7 @@ To make sure a macro lasts for the entire spec file, use `%global` instead. -#### `%global` 🔰 [#global] +##### `%global` 🔰 [#global] Defines a macro globally. @@ -122,7 +122,7 @@ As opposed to [`%define`](#define), macros defined with `%global` will last for -#### `%undefine` 🔦 [#undefine] +##### `%undefine` 🔦 [#undefine] Undefine a macro. @@ -163,7 +163,7 @@ Instead, this pops the latest definition from the macro stack. -#### `%dnl` 🔰 [#dnl] +##### `%dnl` 🔰 [#dnl] Comments. @@ -186,11 +186,11 @@ while macros in `# …` are actually expanded. -#### `%{load:…}` 🔦🚸 [#load] +##### `%{load:…}` 🔦🚸 [#load] Load a macro file. -#### `%{expr:…}` 🔦 [#expr] +##### `%{expr:…}` 🔦 [#expr] Expand all macros in the body, then evaluate the body as an [expression]. @@ -204,7 +204,7 @@ $ rpm -D 'foo 1 + 2' -E '%{expr:%foo}' 3 ``` -#### `%{expand:…}` 🛠️ [#expand] +##### `%{expand:…}` 🛠️ [#expand] Double-expand the macro. @@ -224,7 +224,7 @@ Double-expand the macro. -#### `%{lua:…}` 🛠️ [#lua] +##### `%{lua:…}` 🛠️ [#lua] Embed lua code. @@ -270,7 +270,7 @@ In `rpmspec-rs`, a space must be present after `--`. -#### `%{macrobody:…}` 🔩 [#macrobody] +##### `%{macrobody:…}` 🔩 [#macrobody] Expand to the definition of the given macro. @@ -282,7 +282,7 @@ $ rpm -E '%macrobody dist' %{?distprefix}.um41%{?with_bootstrap:~bootstrap} ``` -#### `%{quote:…}` 🔦🛠️ [#quote] +##### `%{quote:…}` 🔦🛠️ [#quote] Does nothing. You heard me, this macro literally does nothing. @@ -302,9 +302,9 @@ This can be used to pass arguments with spaces to parameterized macros: -### String Operations +#### String Operations -#### `%gsub …` 🔢🔦🛠️ [#gsub] +##### `%gsub …` 🔢🔦🛠️ [#gsub] Equivalent to `%{lua: string.gsub("%1", "%2", %3, %?4)}`, where `%n` represents the n-th argument to `%gsub`. @@ -345,11 +345,11 @@ Obtains the length of the given text. -#### `%{lower:…}` [#lower] +##### `%{lower:…}` [#lower] Turn the input into ASCII-lowercase. -#### `%{upper:…}` [#upper] +##### `%{upper:…}` [#upper] ASCII-uppercase. @@ -368,7 +368,7 @@ $ rpm -E '%sub abc 2 3' bc ``` -#### `%{shescape:…}` [#shescape] +##### `%{shescape:…}` [#shescape] Wrap the input with single quotes and also escape preexisting single-quotes correctly, so that the input can be safely passed as arguments to shell commands. @@ -381,41 +381,41 @@ $ rpm -E "%(echo %{shescape:this is some 'text'})" this is some 'text' ``` -#### `%{shrink:…}` [#shrink] +##### `%{shrink:…}` [#shrink] Trim leading and trailing ASCII-whitespace, and reduce intermediate whitespace to a single space. -### File and Path Operations +#### File and Path Operations -#### `%{basename:…}` 🔦 [#basename] +##### `%{basename:…}` 🔦 [#basename] > basename(1) macro analogue -#### `%{dirname:…}` 🔦 [#dirname] +##### `%{dirname:…}` 🔦 [#dirname] > dirname(1) macro analogue -#### `%{exists:…}` 🔦 [#exists] +##### `%{exists:…}` 🔦 [#exists] > test file existence, expands to 1/0 -#### `%{suffix:…}` 🔦 [#suffi] +##### `%{suffix:…}` 🔦 [#suffi] > expand to suffix part of a file name -#### `%{url2path:…}` 🔦 [#url2path] +##### `%{url2path:…}` 🔦 [#url2path] > convert url to a local path -#### `%{uncompress:…}` [#uncompress] +##### `%{uncompress:…}` [#uncompress] > expand to a command for outputting argument file to stdout, uncompressing as needed This macro is used in [`%setup …`](#setup) for uncompressing source files. -### Environment info +#### Environment info -#### `%{getncpus:…}` [#getncpus] +##### `%{getncpus:…}` [#getncpus] When used as `%{getncpus}` with no arguments, expand to the number of available CPU cores. @@ -426,21 +426,21 @@ Also accept extra arguments: However, `%getncpus total`, `%getncpus proc` and `%getncpus thread` produce the same results as far as concerned. It is suspected that the arguments in most cases have no effect to the output. -#### `%getconfdir` 🔦 [#getconfdir] +##### `%getconfdir` 🔦 [#getconfdir] > expand to rpm "home" directory (typically /usr/lib/rpm) -#### `%{getenv:...}` 🔦 [#getenv] +##### `%{getenv:...}` 🔦 [#getenv] > getenv(3) macro analogue -#### `%rpmversion` 🔦 [#rpmversion] +##### `%rpmversion` 🔦 [#rpmversion] > expand to running rpm version -### Output +#### Output -#### `%{echo:…}` 🔦 [#echo] +##### `%{echo:…}` 🔦 [#echo] > print ... to stdout @@ -449,7 +449,7 @@ concerned. It is suspected that the arguments in most cases have no effect to th section/position it is written. -#### `%{warn:…}` 🔦 [#warn] +##### `%{warn:…}` 🔦 [#warn] > print warning: ... to stderr @@ -461,7 +461,7 @@ and displayed again at the end of the `rpmbuild` execution (after `Executing(rmb section/position it is written. -#### `%{error:…}` 🔦 [#error] +##### `%{error:…}` 🔦 [#error] > print error: ... to stderr and return an error @@ -473,15 +473,15 @@ perform `Executing(rmbuild)` and exit with a summary of all warnings and errors. section/position it is written. -#### `%{verbose:…}` 🔦 [#verbose] +##### `%{verbose:…}` 🔦 [#verbose] > `%verbose`: expand to 1 if rpm is in verbose mode, 0 if not > > `%{verbose:...}`: expand to ... if rpm is in verbose mode, the empty string if not -### Spec-specific Macros +#### Spec-specific Macros -#### `%{S:#}` [#S] +##### `%{S:#}` [#S] > expand ... to <source> file name @@ -508,19 +508,19 @@ Expand to the path to the source file. This is just a fancy macro that transform -#### `%{P:#}` [#P] +##### `%{P:#}` [#P] > expand ... to <patch> file name As you may have guessed, this is basically the `Patch:` version of [`%{S:…}`](#S). -### Diagnostics +#### Diagnostics -#### `%trace` 🔦🛠️ [#trace] +##### `%trace` 🔦🛠️ [#trace] > toggle print of debugging information before/after expansion -#### `%dump` 🔩 [#dump] +##### `%dump` 🔩 [#dump] > print the active (i.e. non-covered) macro table @@ -532,27 +532,27 @@ rpm -E '%dump' 2>&1 | grep x86_64_v3 Or you can just use `less` instead of `grep`. -#### `%__file_name` 🔦 [#__file_name] +##### `%__file_name` 🔦 [#__file_name] > current file (if parsing a file) -#### `%__file_lineno` 🔦 [#__file_lineno] +##### `%__file_lineno` 🔦 [#__file_lineno] > line number in current file (if parsing a file) -## Common Macros +### Common Macros -### Miscellaneous +#### Miscellaneous -#### `%nil` 🔰 [#nil] +##### `%nil` 🔰 [#nil] Expand to nothing. Defined as `%{!?nil}`. -### In Preamble +#### In Preamble -#### `%forgemeta …` 🔢🔰 [#forgemeta] +##### `%forgemeta …` 🔢🔰 [#forgemeta] See https://docs.fedoraproject.org/en-US/packaging-guidelines/SourceURL/#_using_forges_hosted_revision_control. @@ -563,21 +563,21 @@ Parameterized as `%forgemeta(z:isva)`: - `-a`: process all source archives (when you have `%forgeurl0`, `%forgeurl1`, …) - `-z <#>`: process only `%{S:#}` (see [`%{S:}`](#S)) -#### `%forgeautosetup …` 🔢 [#forgeautosetup] +##### `%forgeautosetup …` 🔢 [#forgeautosetup] Somehow pretty rare. Parameterized as `%forgeautosetup(z:vNS:p:q)`. -#### `%forgesetup …` 🔢🔰 [#forgesetup] +##### `%forgesetup …` 🔢🔰 [#forgesetup] Parameterized as `%forgesetup(z:va)`. -#### `%forgeversion …` 🔢🔦 [#forgeversion] +##### `%forgeversion …` 🔢🔦 [#forgeversion] Parameterized as `%forgeversion(pz:ab:)`. -#### `%debug_package` 🔰🏷️ [#debug_package] +##### `%debug_package` 🔰🏷️ [#debug_package] When you see: @@ -594,7 +594,7 @@ You can disable this automatic behavior by setting: Then RPM will not strip debug symbols. -#### `%_build_id_links` 🏷️ [#_build_id_links] +##### `%_build_id_links` 🏷️ [#_build_id_links] When you see problems with `/usr/lib/.build-id`, try setting this to `none`. @@ -629,7 +629,7 @@ In `/usr/lib/rpm/macros`: %_build_id_links compat ``` -#### `%_missing_build_ids_terminate_build` 🏷️ [#_missing_build_ids_terminate_build] +##### `%_missing_build_ids_terminate_build` 🏷️ [#_missing_build_ids_terminate_build] Still having problems with `/usr/lib/.build-id`? Try setting this to `0`. @@ -643,7 +643,7 @@ In `/usr/lib/rpm/macros`: %_missing_build_ids_terminate_build 1 ``` -#### `%__strip` 🏷️ [#__strip] +##### `%__strip` 🏷️ [#__strip] In some cases (e.g. JavaScript binaries) stripping the binaries may break the executable. To disable stripping, override the strip call: @@ -651,7 +651,7 @@ executable. To disable stripping, override the strip call: %global __strip /bin/true ``` -#### `%__requires_exclude` 🏷️ [#__requires_exclude] +##### `%__requires_exclude` 🏷️ [#__requires_exclude] Since `rpmbuild` automatically generates `Requires:` by looking at what things the binaries are linked to, you may disable that by adding a regex to this macro: @@ -666,14 +666,14 @@ what things the binaries are linked to, you may disable that by adding a regex t If you want to disable all automatic `Requires:`, set `AutoReq: 0`. -#### `%__requires_exclude_from` 🏷️ [#__requires_exclude_from] +##### `%__requires_exclude_from` 🏷️ [#__requires_exclude_from] ```rpmspec filename="example.spec" # https://github.com/terrapkg/packages/blob/7f0fd6b6a8993d17832403960d4343899cfb0474/anda/system/opentabletdriver/opentabletdriver.spec#L6 %global __requires_exclude_from ^/usr/lib/opentabletdriver/.*$ ``` -#### `%__provides_exclude` 🏷️ [#__provides_exclude] +##### `%__provides_exclude` 🏷️ [#__provides_exclude] Similarly, since `rpmbuild` automatically generates `Provides:`, you may disable that: ```rpmspec filename="example.spec" {5} @@ -687,7 +687,7 @@ Similarly, since `rpmbuild` automatically generates `Provides:`, you may disable If you want to disable all automatic `Provides:`, set `AutoProv: 0`. -#### `%__provides_exclude_from` 🏷️ [#__provides_exclude_from] +##### `%__provides_exclude_from` 🏷️ [#__provides_exclude_from] ```rpmspec filename="example.spec" {8} # https://github.com/terrapkg/packages/blob/7f0fd6b6a8993d17832403960d4343899cfb0474/anda/devs/asar/asar.spec#L7 @@ -700,7 +700,7 @@ Similarly, since `rpmbuild` automatically generates `Provides:`, you may disable %global __provides_exclude_from %{_datadir}/%{name}/.*\\.so ``` -#### `%__brp_mangle_shebangs_exclude_from` 🔰🏷️ [#__brp_mangle_shebangs_exclude_from] +##### `%__brp_mangle_shebangs_exclude_from` 🔰🏷️ [#__brp_mangle_shebangs_exclude_from] RPM tries to mangle shebangs (`#!`) by default (see [`%__brp_mangle_shebangs`](#__brp_mangle_shebangs)). @@ -720,23 +720,23 @@ If this breaks, you can ask it to exclude the files that matches a given regex. %global rustflags_debuginfo 0 ``` -#### `%__brp_mangle_shebangs_exclude` 🏷️ [#__brp_mangle_shebangs_exclude] +##### `%__brp_mangle_shebangs_exclude` 🏷️ [#__brp_mangle_shebangs_exclude] Similar to above, but takes in regex for shebangs to exclude instead. -#### `%__brp_mangle_shebangs_exclude_file` 🏷️ [#__brp_mangle_shebangs_exclude_file] +##### `%__brp_mangle_shebangs_exclude_file` 🏷️ [#__brp_mangle_shebangs_exclude_file] Similar to above, but takes in path to file that contains the regexes. -#### `%__brp_mangle_shebangs_exclude_from_file` 🏷️ [#__brp_mangle_shebangs_exclude_from_file] +##### `%__brp_mangle_shebangs_exclude_from_file` 🏷️ [#__brp_mangle_shebangs_exclude_from_file] -#### `%__brp_mangle_shebangs` 🏷️ +##### `%__brp_mangle_shebangs` 🏷️ As a last resort to fixing bugs related to shebangs mangling shenanigans, undefine this macro. You really should try using [`%__brp_mangle_shebangs_exclude_from`](#__brp_mangle_shebangs_exclude_from) first though. -#### `%bcond_with …` 🔢🔰 [#bcond_with] +##### `%bcond_with …` 🔢🔰 [#bcond_with] **DISABLE** a "conditional". @@ -745,7 +745,7 @@ Takes in 1 argument: the name of the "conditional". For more information: https://rpm-software-management.github.io/rpm/manual/conditionalbuilds.html -#### `%bcond_without …` 🔢🔰 [#bcond_without] +##### `%bcond_without …` 🔢🔰 [#bcond_without] **ENABLE** a "conditional". @@ -754,9 +754,9 @@ Takes in 1 argument: the name of the "conditional". For more information: https://rpm-software-management.github.io/rpm/manual/conditionalbuilds.html -### In `%prep` +#### In `%prep` -#### `%autosetup …` 🔢🔰 [#autosetup] +##### `%autosetup …` 🔢🔰 [#autosetup] Uncompress the specified sources. By default, uncompress `%{SOURCE0}` (i.e. [`%{S:0}`](#s)). @@ -777,7 +777,7 @@ This is actually a wrapper around [`%setup`](#setup) and [`%autopatch …`](#aut If you need to unpack multiple sources, see: http://ftp.rpm.org/max-rpm/s1-rpm-inside-macros.html -#### `%setup …` 🔢🚸 [#setup] +##### `%setup …` 🔢🚸 [#setup] Uncompress the specified sources. By default, uncompress `%{SOURCE0}` (i.e. [`%{S:0}`](#s)). @@ -811,7 +811,7 @@ The `%setup …` macro does 3 things: - internally uses [`%{uncompress:…}`](#uncompress) - `cd %{?buildsubdir}` -#### `%autopatch …` 🔢 [#autopatch] +##### `%autopatch …` 🔢 [#autopatch] Apply patches. @@ -835,7 +835,7 @@ Examples: Reference: https://rpm-software-management.github.io/rpm/manual/autosetup.html#autopatch -#### `%patch …` 🔢🚸 [#patch] +##### `%patch …` 🔢🚸 [#patch] Apply a patch. @@ -991,7 +991,7 @@ Macros with the '(Terra only)' warning are part of the `anda-srpm-macros` packag ┗╸SRPMS ⇒ %{_srcrpmdir} ``` -#### Common Paths 🔰 [#common-paths] +##### Common Paths 🔰 [#common-paths] ``` /etc ⇒ %{_sysconfdir} @@ -1026,9 +1026,9 @@ Macros with the '(Terra only)' warning are part of the `anda-srpm-macros` packag /usr/share/zsh/site-functions ⇒ %{zsh_completions_dir} ``` -### In `%install` +#### In `%install` -#### `%buildroot` 🔰 [#buildroot] +##### `%buildroot` 🔰 [#buildroot] Only available in a spec file. @@ -1037,7 +1037,7 @@ Macros with the '(Terra only)' warning are part of the `anda-srpm-macros` packag Path to a specific directory where files, that get packaged into the final RPM, should live. This is the same as `$pkgdir` in Arch Linux PKGBUILDs. -#### `%find_lang` 🔰 [#find_lang] +##### `%find_lang` 🔰 [#find_lang] From `/usr/lib/rpm/find-lang.sh`: > ``` @@ -1118,22 +1118,22 @@ mkdir -p %{buildroot}%{_datadir}/themes %{_datadir}/themes/Fluent*/ ``` - + Use [`%{quote:…}{:rpmspec}`](#quote) to feed in multiple paths: ```rpmspec %fdupes %{quote:%buildroot%_datadir %buildroot%_sysconfdir} ``` -## Per Language +### Per Language If your language / buildsystem is not listed here, go to https://docs.fedoraproject.org/en-US/packaging-guidelines/ and find them on the navigation rail on the left. -### C and C++ +#### C and C++ -#### `%configure` [#configure] +##### `%configure` [#configure] Expand to `./configure` with the correct flags and arguments. If you need to execute `./configure`, in most cases you should use this macro instead. @@ -1141,128 +1141,128 @@ If you need to execute `./configure`, in most cases you should use this macro in In some cases where `./configure` is not directly available, you may need to run `autoreconf -fi` or `-fiv`. -#### `%make_build` 🔰 [#make_build] +##### `%make_build` 🔰 [#make_build] ⇒ `%__make -O -j${RPM_BUILD_NCPUS} V=1 VERBOSE=1{:sh}`, where `%{__make}` ⇒ `/usr/bin/make`. Further arguments to `make` can be attached. -#### `%make_install` 🔰 [#make_install] +##### `%make_install` 🔰 [#make_install] ⇒ `%__make install DESTDIR=%?buildroot INSTALL="%__install -p"{:sh}`. -#### `%makeinstall` 🚸 [#makeinstall] +##### `%makeinstall` 🚸 [#makeinstall] Deprecated. Use [`%make_install`](#make_install) instead. -#### `%cmake` 🔰 [#cmake] +##### `%cmake` 🔰 [#cmake] Expand to `%{__cmake}` (⇒ `/usr/bin/cmake`) with the correct flags, such as `-B "%__cmake_builddir"{:sh}` (⇒ `-B "redhat-linux-build"{:sh}`). -#### `%cmake_build` 🔰 [#cmake_build] +##### `%cmake_build` 🔰 [#cmake_build] ⇒ `%__cmake --build "%__cmake_builddir" %?_smp_mflags --verbose{:sh}`. -#### `%cmake_install` 🔰 [#cmake_install] +##### `%cmake_install` 🔰 [#cmake_install] ⇒ `DESTDIR="%buildroot" %__cmake --install "%__cmake_builddir"{:sh}`. -#### `%meson` 🔰 [#meson] +##### `%meson` 🔰 [#meson] ≈ `%__meson setup{:sh}` with correct flags. -#### `%meson_build` 🔰 [#meson_build] +##### `%meson_build` 🔰 [#meson_build] ⇒ `%__meson compile -C "%_vpath_builddir" -j %_smp_build_ncpus %{?__meson_verbose:--verbose}{:sh}` ⇒ `/usr/bin/meson compile -C redhat-linux-build -j 20 --verbose{:sh}` (on my machine). -#### `%meson_install` 🔰 [#meson_install] +##### `%meson_install` 🔰 [#meson_install] ⇒ `DESTDIR=%buildroot %__meson install -C %_vpath_builddir --no-rebuild{:sh}`. Used in `%install{:rpmspec}`. -#### `%meson_test` 🔰 [#meson_test] +##### `%meson_test` 🔰 [#meson_test] ⇒ `%__meson test -C %_vpath_builddir --no-rebuild %{!?__meson_verbose:--quiet}{:sh}`. Used in `%check{:rpmspec}`. -#### `%ninja_build` [#ninja_build] +##### `%ninja_build` [#ninja_build] ⇒ `%__ninja %__ninja_common_opts{:sh}` ⇒ `%__ninja -v -j${RPM_BUILD_NCPUS}{:sh}`. -#### `%ninja_install` [#ninja_install] +##### `%ninja_install` [#ninja_install] ⇒ `DESTDIR=%buildroot %__ninja install %__ninja_common_opts{:sh}`. -#### `%ninja_test` [#ninja_test] +##### `%ninja_test` [#ninja_test] ⇒ `%__ninja test %__ninja_common_opts{:sh}`. -#### `%build_cflags` 🏷️ [#build_cflags] +##### `%build_cflags` 🏷️ [#build_cflags] Flags to be passed to the C compiler. ⇒ `%{__build_flags_lang_c} %{?_distro_extra_cflags}` -#### `%_distro_extra_cflags` 🏷️ [#_distro_extra_cflags] +##### `%_distro_extra_cflags` 🏷️ [#_distro_extra_cflags] For example, if the compiler is emitting errors that could be disabled with some `-Wno-…` flags, you can define this macro with extra flags. This macro is not defined by default on Fedora. -#### `%build_cxxflags` 🏷️ [#build_cxxflags] +##### `%build_cxxflags` 🏷️ [#build_cxxflags] Flags to be passed to the C++ compiler. ⇒ `%{__build_flags_lang_cxx} %{?_distro_extra_cxxflags}` -#### `%_distro_extra_cxxflags` 🏷️ [#_distro_extra_cxxflags] +##### `%_distro_extra_cxxflags` 🏷️ [#_distro_extra_cxxflags] For example, if the compiler is emitting errors that could be disabled with some `-Wno-…` flags, you can define this macro with extra flags. This macro is not defined by default on Fedora. -### D +#### D -#### `%ldc_arches` [#ldc_arches] +##### `%ldc_arches` [#ldc_arches] -#### `%_d_optflags` [#_d_optflags] +##### `%_d_optflags` [#_d_optflags] -### Java +#### Java https://docs.fedoraproject.org/en-US/java-packaging-howto/ -### Nim +#### Nim This section is only applicable to Terra (because Fedora does not ship Nim). -#### `%nim_prep` [#nim_prep] +##### `%nim_prep` [#nim_prep] Set `mold` as the linker and run `nimble setup -y`. -#### `%nim_build` [#nim_build] +##### `%nim_build` [#nim_build] Same as [`%nim_c`](#nim_c). -#### `%nim_c` [#nim_c] +##### `%nim_c` [#nim_c] ⇒ `nim c -d:release -t:"%nim_tflags" -l:"%nim_lflags"{:sh}`. -### Python +#### Python https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/ -### Rust +#### Rust https://docs.fedoraproject.org/en-US/packaging-guidelines/Rust/ -#### `%rustflags_debuginfo` 🏷️ [#rustflags_debuginfo] +##### `%rustflags_debuginfo` 🏷️ [#rustflags_debuginfo] If `gdb` crashes in `find-debuginfo`, you might want to lower the value to `1` or even `0`. diff --git a/content/docs/rpm/sections.mdx b/content/docs/rpm/sections.mdx index cca3dc09..ac046a30 100644 --- a/content/docs/rpm/sections.mdx +++ b/content/docs/rpm/sections.mdx @@ -105,7 +105,7 @@ Requires(meta): the latter ones refer to packages required during `%pre{:rpmspec}`, `%post{:rpmspec}`, … - + The spec file (include sections and preambles) is parsed only after all macros are expanded. This means you may expand preambles from macros too. diff --git a/content/docs/terra/appstream.mdx b/content/docs/terra/appstream.mdx index 2d0a83a0..c4c56a68 100644 --- a/content/docs/terra/appstream.mdx +++ b/content/docs/terra/appstream.mdx @@ -183,8 +183,6 @@ Source1: %appid.metainfo.xml # This specifies your metainfo.xml file as a sour --- -# Footnotes - [^1]: libraries are also supported, see Freedesktop docs for tag provides: https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-provides [^2]: https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-keywords diff --git a/content/docs/terra/guidelines.mdx b/content/docs/terra/guidelines.mdx index a1cf4005..ce2ca87e 100644 --- a/content/docs/terra/guidelines.mdx +++ b/content/docs/terra/guidelines.mdx @@ -331,7 +331,7 @@ The general guidelines for building webapps are: #### Electron These are guidelines for packaging [Electron](https://www.electronjs.org) apps. - + Many Electron projects will default to building distro binary packages (such as RPMs and Debs) and this rarely works well in RPM builds. Packagers should be prepared to patch or otherwise modify the Electron Builder config to rectify this. @@ -354,7 +354,7 @@ These are guidelines for packaging [Electron](https://www.electronjs.org) apps. These are guidelines for packaging [Tauri](https://v2.tauri.app) apps. Tauri builds webapps using Cargo and the system WebKit. For these reasons some of the [Rust](#rust) guidelines also apply to Tauri. Most relevant Cargo macros have been ported into Tauri compatible ones, however it will likely still be helpful to make yourself familiar with the original macros. - + It is important to note that unlike the original Cargo macros, Tauri macros only support passing features with the `-f` flag due to how Tauri works. @@ -544,8 +544,6 @@ Correct: --- -# Footnotes - [^1]: https://github.com/terrapkg/packages/blob/e65a762352246f918d12e7c5a0e032ba0b1be73b/anda/langs/nim/dive/umdive.spec [^2]: https://github.com/terrapkg/packages/blob/e65a762352246f918d12e7c5a0e032ba0b1be73b/anda/langs/nim/netto/netto.spec diff --git a/content/docs/terra/index.mdx b/content/docs/terra/index.mdx index 5e73b83a..b7201fc3 100644 --- a/content/docs/terra/index.mdx +++ b/content/docs/terra/index.mdx @@ -9,7 +9,7 @@ Terra is a rolling repository RPM repository for Fedora Linux and its derivative With Terra, you can install the latest packages knowing that quality and security are assured. Terra is also a great way to distribute your software on Fedora and its derivatives. - + Installation instructions are available [here](/terra/installing). diff --git a/content/docs/terra/policies.mdx b/content/docs/terra/policies.mdx index bb7b46d4..df44f4f4 100644 --- a/content/docs/terra/policies.mdx +++ b/content/docs/terra/policies.mdx @@ -169,7 +169,7 @@ For example, `terra-mesa` should be in extra as the dependency solver will resol ## AppStream MetaInfo & Desktop Files -Our AppStream guidelines are documented [here](/terra/appstream). +Our AppStream guidelines are documented [here](/terra/appstream). All graphical applications that can be started by the user MUST provide a [desktop entry](/terra/guidelines#providing-your-own-desktop-file) and [AppStream MetaInfo](https://www.freedesktop.org/software/appstream/docs/chap-Quickstart.html#qsr-app-example) file. Other applications are also RECOMMENDED to do so. diff --git a/content/docs/terra/srpm.mdx b/content/docs/terra/srpm.mdx index b6a017fd..ef75c74a 100644 --- a/content/docs/terra/srpm.mdx +++ b/content/docs/terra/srpm.mdx @@ -89,7 +89,7 @@ Used in [`%pkg_completions`](#pkg_completion), or manually when `%pkg_completion ### %_gnomeextensionsdir Expands to: `%{_datadir}/gnome-shell/extensions%{?uuid:/%{uuid}}{:rpmspec}` - + `%{uuid}` is usually defined in gnome-shell-extension packages. if the macro is defined in your spec file (`%global uuid PKG-UUID`), it will be appended to the path upon expansion as: `%{_datadir}/gnome-shell/extensions/%{uuid}`.
Otherwise, it will expand without `%{uuid}`, as: `%{_datadir}/gnome-shell/extensions`.
Note that you SHOULD then need to add the extension's UUID after this macro. @@ -293,7 +293,7 @@ What `%vendor_nodejs{:rpmspec}` does: Vendored versions of NPM and NPX are subject to limitations in commands as they must be run through `exec`. - + You MUST add `nvm` as a build as a `BuildRequires:{:rpmspec}` if using this macro. @@ -324,7 +324,7 @@ Example usage: #### %npm_install Install a Node module to `%{npm_sitelib}{:rpmspec}` and symlink its executable. - + This macro sets the environment variable `$_js`. This environment variable has a very simple purpose: It is defined as `.js` if a Node module's executable ends in a `.js` extension.
How this is used: If for any reason you need to execute a Node module itself as part of the build, you SHOULD do `/path/to/%{npm_name}$_js` after using `%npm_install`. `$_js` will expand to nothing if not defined and will expand to the `.js` extension if defined. @@ -505,7 +505,7 @@ SHOULD be used in place of calling `bunx` or `bun x` itself. ##### %bun_audit Audit with Bun if package uses bundled JavaScript module dependencies. For use in the `%check{:rpmspec}` section. - + `bun audit` is currently just a wrapper for NPM audit but lacks the `fix` option; use `%npm_audit_fix` to fix vulnerabilities if they are found in Node modules. @@ -549,7 +549,7 @@ Audit with Deno if package uses bundled JavaScript module dependencies. For use Expands to: `NPM_CONFIG_AUDIT_LEVEL=low %{__deno} audit --level=low --ignore-unfixable --socket{:rpmspec}` - + `deno audit` currently lacks a way to fix vulnerabilities; use you MAY try using `%npm_audit_fix` to fix vulnerabilities. @@ -652,7 +652,7 @@ Expands to: `/usr/bin/env %{yarn_common_envvars} /usr/bin/yarn dlx{:rpmspec}` SHOULD be used in place of calling `yarn dlx` itself. - + `yarnpkg-berry` is REQUIRED as a build dependency instead of `yarnpkg`. @@ -675,7 +675,7 @@ These macros assist with the general packaging of applications that use [Electro ##### %electronmeta Set up all basic requirements including build macros for building an Electron app. - + This does NOT install the JavaScript package managers used for builds except for NPM (e.g., `bun`, `deno`, `pnpm`, `yarnpkg`, `yarnpkg-berry`).
Specify these `BuildRequires:{:rpmspec}` manually. @@ -721,7 +721,7 @@ Like other meta macros (e.g., `%forgemeta{:rpmspec}` from Fedora), you MUST be m The safest location is under `Name:{:rpmspec}` and above other preambles. When in doubt, place the macro here. - + `%__provides_exclude` and `%__requires_exclude` can be recursively added to if needed by defining the macro again as a `%global` and appending the needed exclusions using [regex](https://wikipedia.org/wiki/Regular_expression).
Example: `%global __provides_exclude %{__provides_exclude}|libcurl\\.so`
MUST be done after setting `%electronmeta`.
@@ -793,7 +793,7 @@ Example usage: - A second symlink called `alsoapp`. - A desktop file with the `Exec` line reading `Exec=/usr/lib(64)/pkgname/app --enable-features=WaylandWindowDecorations --ozone-platform=wayland %u`. - + Like the webapp build macros, this macro sets the environment variable `$WEBAPP_BUILD_TOOL` to either `electron-builder` or `electron-forge` depending on which the app is built with. SHOULD NOT need to be used manually, but MAY be if needed for any reason. @@ -812,7 +812,7 @@ Available flags: - `-t{:rpmspec}`: Pull Tauri itself from the repos. - This would be used as `BuildRequires: %{tauri_buildrequires -t}{:rpmspec}` - + This does NOT install the JavaScript package managers used for builds except for NPM (e.g., `bun`, `deno`, `pnpm`, `yarnpkg`, `yarnpkg-berry`).
Specify these `BuildRequires:{:rpmspec}` manually. @@ -856,7 +856,7 @@ Supports the same flags as [%tauri_buildrequires](#tauri_buildrequires). BuildRequires generation only works in Mock. - + This does NOT install the JavaScript package managers used for builds except for NPM (e.g., `bun`, `deno`, `pnpm`, `yarnpkg`, `yarnpkg-berry`).
Specify these `BuildRequires:{:rpmspec}` manually. @@ -902,7 +902,7 @@ Capital letter flags generally denote options that SHOULD be used with caution o For more information on each package manager, see [NPM Macros](#npm-macros), [Bun Macros](#bun-macros), [Deno Macros](#deno-macros), [PNPM Macros](#pnpm-macros), and [Yarn Macros](#yarn-macros). - + All of the following macros set the environment variable `$WEBAPP_BUILD_TOOL` to `electron-builder`, `electron-forge`, or `tauri` depending on which the app is built with. SHOULD NOT need to be used manually, but MAY be if needed for any reason. @@ -1318,8 +1318,6 @@ This macro simply appends the [Mold linker arguments](/terra/guidelines#usage-of --- -# Footnotes - [^1]: `x86_64`, `x86_64_v2`, `x86_64_v3`, `x86_64_v4`, `amd64`, `em64t` [^2]: `i386`, `i486`, `i586`, `i686`, `pentium3`, `pentium4`, `athlon`, `geode` [^3]: `mips64`, `mips64el`, `mips64r6`, `mips64r6el`