Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

package.yml: Add new macros #536

Merged
merged 3 commits into from
May 4, 2024
Merged

package.yml: Add new macros #536

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1e3987
package.yml: Add new macros
davidjharder May 4, 2024
e22e1c9
Update docs/packaging/package.yml.md
davidjharder May 4, 2024
e3f0cb0
staudey review
davidjharder May 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions docs/packaging/package.yml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,17 +145,19 @@

### 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** | Runs `%configure` without the `--runstatedir` option. Use if you encounter `configure: error: unrecognized option: '--runstatedir=/run'`. |

Check warning on line 154 in docs/packaging/package.yml.md

View workflow job for this annotation

GitHub Actions / spellcheck 

Unknown word (runstatedir)

Check warning on line 154 in docs/packaging/package.yml.md

View workflow job for this annotation

GitHub Actions / spellcheck 

Unknown word (runstatedir)

Check warning on line 154 in docs/packaging/package.yml.md

View workflow job for this annotation

GitHub Actions / spellcheck 

Unknown word (runstatedir)
| **%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

Expand Down