diff options
author | Friedrich W. H. Kossebau <kossebau@kde.org> | 2021-04-17 11:02:00 +0200 |
---|---|---|
committer | Friedrich W. H. Kossebau <kossebau@kde.org> | 2021-04-23 17:49:14 +0000 |
commit | 5512e03562694ebfe571a3b6068a7d35d9ddfd7a (patch) | |
tree | 3caca041d3526c8427ec3065642b41a52ad8578c /modules/ECMGenerateDBusServiceFile.cmake | |
parent | 38b5d046c4d42232d45bf4464167b2e6feea4cf7 (diff) | |
download | extra-cmake-modules-5512e03562694ebfe571a3b6068a7d35d9ddfd7a.tar.gz extra-cmake-modules-5512e03562694ebfe571a3b6068a7d35d9ddfd7a.tar.bz2 |
Modules docs: move rst docs into bracket comments
CMake >= 3.0 supports bracket comments, and the reStructuredText
integration code in sphinx/ext/ecm.py already supports extracting
the docs from a bracket comment instead.
Editing documentation without leading line comment markers is more simple,
e,g. when reflowing text over lines.
With ECM meanwhile requiring CMake 3.5 now it is possible to switch
(and thus follow also the approach used by cmake itself).
NO_CHANGELOG
Diffstat (limited to 'modules/ECMGenerateDBusServiceFile.cmake')
-rw-r--r-- | modules/ECMGenerateDBusServiceFile.cmake | 104 |
1 files changed, 52 insertions, 52 deletions
diff --git a/modules/ECMGenerateDBusServiceFile.cmake b/modules/ECMGenerateDBusServiceFile.cmake index 12c37c7b..0b76b5f8 100644 --- a/modules/ECMGenerateDBusServiceFile.cmake +++ b/modules/ECMGenerateDBusServiceFile.cmake @@ -1,60 +1,60 @@ -#.rst: -# ECMGenerateDBusServiceFile -# --------------------------- -# -# This module provides the ``ecm_generate_dbus_service_file`` function for -# generating and installing a D-Bus service file. -# -# :: -# -# ecm_generate_dbus_service_file( -# NAME <service name> -# EXECUTABLE <executable> -# [SYSTEMD_SERVICE <systemd service>] -# DESTINATION <install_path> -# [RENAME <dbus service filename>] # Since 5.75 -# ) -# -# A D-Bus service file ``<service name>.service`` will be generated and installed -# in the relevant D-Bus config location. This filename can be customized with RENAME. -# -# ``<executable>`` must be an absolute path to the installed service executable. When using it with -# ``KDEInstallDirs`` it needs to be the ``_FULL_`` variant of the path variable. -# -# Note: On Windows, the macro will only use the file name part of ``<executable>`` since D-Bus -# service executables are to be installed in the same directory as the D-Bus daemon. -# -# Optionally, a ``<systemd service>`` can be specified to launch the corresponding -# systemd service instead of the ``<executable>`` if the D-Bus daemon is started by systemd. -# -# Example usage: -# -# .. code-block:: cmake -# -# ecm_generate_dbus_service_file( -# NAME org.kde.kded5 -# EXECUTABLE ${KDE_INSTALL_FULL_BINDIR}/kded5 -# DESTINATION ${KDE_INSTALL_DBUSSERVICEDIR} -# ) -# -# .. code-block:: cmake -# -# ecm_generate_dbus_service_file( -# NAME org.kde.kded5 -# EXECUTABLE ${KDE_INSTALL_FULL_BINDIR}/kded5 -# SYSTEMD_SERVICE plasma-kded.service -# DESTINATION ${KDE_INSTALL_DBUSSERVICEDIR} -# RENAME org.kde.daemon.service -# ) -# -# Since 5.73.0. - -#============================================================================= # SPDX-FileCopyrightText: 2020 Kai Uwe Broulik <kde@broulik.de> # SPDX-FileCopyrightText: 2020 Henri Chain <henri.chain@enioka.com> # # SPDX-License-Identifier: BSD-3-Clause +#[=======================================================================[.rst: +ECMGenerateDBusServiceFile +--------------------------- + +This module provides the ``ecm_generate_dbus_service_file`` function for +generating and installing a D-Bus service file. + +:: + + ecm_generate_dbus_service_file( + NAME <service name> + EXECUTABLE <executable> + [SYSTEMD_SERVICE <systemd service>] + DESTINATION <install_path> + [RENAME <dbus service filename>] # Since 5.75 + ) + +A D-Bus service file ``<service name>.service`` will be generated and installed +in the relevant D-Bus config location. This filename can be customized with RENAME. + +``<executable>`` must be an absolute path to the installed service executable. When using it with +``KDEInstallDirs`` it needs to be the ``_FULL_`` variant of the path variable. + +Note: On Windows, the macro will only use the file name part of ``<executable>`` since D-Bus +service executables are to be installed in the same directory as the D-Bus daemon. + +Optionally, a ``<systemd service>`` can be specified to launch the corresponding +systemd service instead of the ``<executable>`` if the D-Bus daemon is started by systemd. + +Example usage: + +.. code-block:: cmake + + ecm_generate_dbus_service_file( + NAME org.kde.kded5 + EXECUTABLE ${KDE_INSTALL_FULL_BINDIR}/kded5 + DESTINATION ${KDE_INSTALL_DBUSSERVICEDIR} + ) + +.. code-block:: cmake + + ecm_generate_dbus_service_file( + NAME org.kde.kded5 + EXECUTABLE ${KDE_INSTALL_FULL_BINDIR}/kded5 + SYSTEMD_SERVICE plasma-kded.service + DESTINATION ${KDE_INSTALL_DBUSSERVICEDIR} + RENAME org.kde.daemon.service + ) + +Since 5.73.0. +#]=======================================================================] + include(CMakeParseArguments) function(ecm_generate_dbus_service_file) |