diff options
authorOlivier Duchateau <duchateau.olivier@gmail.com>2023-03-05 10:12:58 +0000
committerSergio Carlavilla Delgado <carlavilla@FreeBSD.org>2023-03-05 10:12:58 +0000
commit689f1b026a02bf6d7039bdfec59353196d83ccef (patch)
parentc753ac31e3634d306f6c445a8085bcd3a4a5f9f5 (diff)
Add support of USES= budgie in Porters Handbook
With a minor tweak to improve the render from carlavilla@ Reviewed by: pauamma@, carlavilla@ Differential Revision: https://reviews.freebsd.org/D37286
2 files changed, 53 insertions, 0 deletions
diff --git a/documentation/content/en/books/porters-handbook/special/_index.adoc b/documentation/content/en/books/porters-handbook/special/_index.adoc
index d31179deca..4ebeb7f84e 100644
--- a/documentation/content/en/books/porters-handbook/special/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/special/_index.adoc
@@ -4431,6 +4431,50 @@ However, Xfce components and non-Xfce dependencies of the port must be included
Do not count on an Xfce component to provide a sub-dependency other than itself for the main port.
+== Using Budgie
+Applications or libraries depending on the Budgie desktop should set `USES= budgie` and set `USE_BUDGIE` to the list of required components.
+[cols="1,1", frame="none", options="header"]
+| Name
+| Description
+| `libbudgie`
+| Desktop core (library)
+| `raven`
+| All-in-one center in panel for accessing different applications widgets
+| `screensaver`
+| Desktop-specific screensaver
+All application widgets communicate through the *org.budgie_desktop.Raven* service.
+The default dependency is lib- and run-time, it can be changed with `:build` or `:run`, for example:
+USES= budgie
+USE_BUDGIE= screensaver:build
+.`USE_BUDGIE` Example
+USES= budgie gettext gnome meson pkgconfig
+USE_BUDGIE= libbudgie
== Using Databases
diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc
index 58bfeedff5..bf02331dd4 100644
--- a/documentation/content/en/books/porters-handbook/uses/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc
@@ -179,6 +179,15 @@ Possible arguments: (none), `build`, `run`, `both`
Uses package:devel/bison[] By default, with no arguments or with the `build` argument, it implies `bison` is a build-time dependency, `run` implies a run-time dependency, and `both` implies both run-time and build-time dependencies.
+== `budgie`
+Possible arguments: (none)
+Provide support for the Budgie desktop environment.
+Use `USE_BUDGIE` to select the components needed for the port.
+See crossref:special[using-budgie,Using Budgie] for more information.
== `cabal`