From b1e3987cae78ef38460a2affb540dc0140908771 Mon Sep 17 00:00:00 2001 From: David Harder Date: Sat, 4 May 2024 12:34:40 -0500 Subject: [PATCH 1/3] package.yml: Add new macros - Add `%configure_no_runstatedir` - Add `%symlink_check` - Resolves https://github.com/getsolus/help-center-docs/issues/522 --- docs/packaging/package.yml.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/packaging/package.yml.md b/docs/packaging/package.yml.md index b6c0b099f..e5b1dee0b 100644 --- a/docs/packaging/package.yml.md +++ b/docs/packaging/package.yml.md @@ -145,17 +145,19 @@ Macros are prefixed with `%`, and are substituted before your script is executed ### Actionable macros -| Macro | Description | -| ------------------ | --------------------------------------------------------------------------------------------------------------------------- | -| **%autogen** | Runs autogen with our `%CONFOPTS%` to create a configure script then proceeds to run `%configure`. | -| **%cmake** | Configures a cmake project with the distribution specific options, such as prefix and release type. | -| **%cmake_ninja** | Configures a cmake project with ninja so it can be used with `%ninja_build`, `%ninja_install` and `%ninja_check` macros. | -| **%configure** | Runs `./configure` with our `%CONFOPTS%` variable macro. | -| **%make** | Runs the `make` command with the job count specified in `eopkg.conf`. ([More info](advanced-config/eopkg-configuration.md)) | -| **%make_install** | Performs a `make install`, using the `DESTDIR` variant. Should work for the vast majority of packages. | -| **%patch** | Sane patch macro to run in batch mode and not contaminate source tree on failure. | -| **%apply_patches** | Applies all patches listed in the `series` file in `./files` folder. | -| **%reconfigure** | Updates build scripts such as `./configure` and proceeds to run `%configure`. | +| Macro | Description | +| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| **%autogen** | Runs autogen with our `%CONFOPTS%` to create a configure script then proceeds to run `%configure`. | +| **%cmake** | Configures a cmake project with the distribution specific options, such as prefix and release type. | +| **%cmake_ninja** | Configures a cmake project with ninja so it can be used with `%ninja_build`, `%ninja_install` and `%ninja_check` macros. | +| **%configure** | Runs `./configure` with our `%CONFOPTS%` variable macro. | +| **%configure_no_runstatedir** | Use if `%configure` returns `configure: error: unrecognized option: '--runstatedir=/run'` | +| **%make** | Runs the `make` command with the job count specified in `eopkg.conf`. ([More info](advanced-config/eopkg-configuration.md)) | +| **%make_install** | Performs a `make install`, using the `DESTDIR` variant. Should work for the vast majority of packages. | +| **%patch** | Sane patch macro to run in batch mode and not contaminate source tree on failure. | +| **%apply_patches** | Applies all patches listed in the `series` file in `./files` folder. | +| **%reconfigure** | Updates build scripts such as `./configure` and proceeds to run `%configure`. | +| **%symlink_check** | Installed symlinks are checked; if a broken symlink is found the build will fail. Must run after install macros | ### Haskell actionable macros From e22e1c9955665c48d0e28a4095def477dc277ce1 Mon Sep 17 00:00:00 2001 From: David Harder Date: Sat, 4 May 2024 13:52:15 -0500 Subject: [PATCH 2/3] Update docs/packaging/package.yml.md Co-authored-by: Thomas Staudinger --- docs/packaging/package.yml.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/packaging/package.yml.md b/docs/packaging/package.yml.md index e5b1dee0b..8fa73f0a5 100644 --- a/docs/packaging/package.yml.md +++ b/docs/packaging/package.yml.md @@ -157,7 +157,7 @@ Macros are prefixed with `%`, and are substituted before your script is executed | **%patch** | Sane patch macro to run in batch mode and not contaminate source tree on failure. | | **%apply_patches** | Applies all patches listed in the `series` file in `./files` folder. | | **%reconfigure** | Updates build scripts such as `./configure` and proceeds to run `%configure`. | -| **%symlink_check** | Installed symlinks are checked; if a broken symlink is found the build will fail. Must run after install macros | +| **%symlink_check** | Checks for broken symlinks in the install directory and aborts the build if any are found. Must run after install macros. | ### Haskell actionable macros From e3f0cb0af977614ef043b248e9669a4a496bd7a7 Mon Sep 17 00:00:00 2001 From: David Harder Date: Sat, 4 May 2024 14:03:32 -0500 Subject: [PATCH 3/3] staudey review --- docs/packaging/package.yml.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/packaging/package.yml.md b/docs/packaging/package.yml.md index 8fa73f0a5..2456ead8e 100644 --- a/docs/packaging/package.yml.md +++ b/docs/packaging/package.yml.md @@ -145,19 +145,19 @@ Macros are prefixed with `%`, and are substituted before your script is executed ### Actionable macros -| Macro | Description | -| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| **%autogen** | Runs autogen with our `%CONFOPTS%` to create a configure script then proceeds to run `%configure`. | -| **%cmake** | Configures a cmake project with the distribution specific options, such as prefix and release type. | -| **%cmake_ninja** | Configures a cmake project with ninja so it can be used with `%ninja_build`, `%ninja_install` and `%ninja_check` macros. | -| **%configure** | Runs `./configure` with our `%CONFOPTS%` variable macro. | -| **%configure_no_runstatedir** | Use if `%configure` returns `configure: error: unrecognized option: '--runstatedir=/run'` | -| **%make** | Runs the `make` command with the job count specified in `eopkg.conf`. ([More info](advanced-config/eopkg-configuration.md)) | -| **%make_install** | Performs a `make install`, using the `DESTDIR` variant. Should work for the vast majority of packages. | -| **%patch** | Sane patch macro to run in batch mode and not contaminate source tree on failure. | -| **%apply_patches** | Applies all patches listed in the `series` file in `./files` folder. | -| **%reconfigure** | Updates build scripts such as `./configure` and proceeds to run `%configure`. | -| **%symlink_check** | Checks for broken symlinks in the install directory and aborts the build if any are found. Must run after install macros. | +| Macro | Description | +| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| **%autogen** | Runs autogen with our `%CONFOPTS%` to create a configure script then proceeds to run `%configure`. | +| **%cmake** | Configures a CMake project with the distribution specific options, such as prefix and release type. | +| **%cmake_ninja** | Configures a CMake project with ninja so it can be used with `%ninja_build`, `%ninja_install` and `%ninja_check` macros. | +| **%configure** | Runs `./configure` with our `%CONFOPTS%` variable macro. | +| **%configure_no_runstatedir** | Runs `%configure` without the `--runstatedir` option. Use if you encounter `configure: error: unrecognized option: '--runstatedir=/run'`. | +| **%make** | Runs the `make` command with the job count specified in `eopkg.conf` ([more info](advanced-config/eopkg-configuration.md)). | +| **%make_install** | Performs a `make install`, using the `DESTDIR` variant. Should work for the vast majority of packages. | +| **%patch** | Sane patch macro to run in batch mode and not contaminate source tree on failure. | +| **%apply_patches** | Applies all patches listed in the `series` file in `./files` folder. | +| **%reconfigure** | Updates build scripts such as `./configure` and proceeds to run `%configure`. | +| **%symlink_check** | Checks for broken symlinks in the install directory and aborts the build if any are found. Must run after install macros. | ### Haskell actionable macros