File: G10AddDistTargets.cmake

package info (click to toggle)
gpgmepp 2.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,172 kB
  • sloc: cpp: 12,050; sh: 148; makefile: 5
file content (123 lines) | stat: -rw-r--r-- 4,890 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# Copyright 2025 g10 Code GmbH
# Software engineering by Ingo Klöcker <dev@ingo-kloecker.de>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# SPDX-License-Identifier: BSD-2-Clause

#[=======================================================================[.rst:
G10AddDistTargets
-----------------

Add custom targets ``dist`` and ``distcheck`` for packaging the sources.

::

  g10_add_dist_targets(
      [VERSION <version>]
      [ARCHIVE_FORMAT <format>]
      [EXTRA_FILES <filename> [...]]
  )


This function adds the custom targets ``dist`` and ``distcheck`` to the project.
These targets are similar to the targets with the same names created by
automake.

The ``dist`` target can be used to create a tarball of the sources.
It uses ``git archive`` for creating the tarball so that the target can only be
used with git clones of the project and not with extracted tarballs. The created
package is named ``<PROJECT_NAME>-<version>.<format>``.

The ``distcheck`` target creates and extracts a tarball of the project and then
configures, builds, installs, uninstalls, installs with DESTDIR, and uninstalls
with DESTDIR.

If ``VERSION`` is not given then ``PROJECT_VERSION`` is used.

If ``ARCHIVE_FORMAT`` is not given then ``tar.gz`` is used. ``git archive``
needs to support the given format.

With ``EXTRA_FILES`` files that are not part of HEAD, e.g. a file generated
with cmake, can be added to the tarball.
#]=======================================================================]

function(G10_ADD_DIST_TARGETS)
    set(options)
    set(one_value_keywords VERSION ARCHIVE_FORMAT)
    set(multi_value_keywords EXTRA_FILES)

    cmake_parse_arguments(PARSE_ARGV 0 arg "${options}" "${one_value_keywords}" "${multi_value_keywords}")

    if(arg_UNPARSED_ARGUMENTS)
        message(FATAL_ERROR "Unknown keywords given to G10_ADD_DIST_TARGETS(): \"${arg_UNPARSED_ARGUMENTS}\"")
    endif()

    if(arg_VERSION)
        set(version ${arg_VERSION})
    else()
        set(version ${PROJECT_VERSION})
    endif()
    if(arg_ARCHIVE_FORMAT)
        set(archive_format ${arg_ARCHIVE_FORMAT})
    else()
        set(archive_format "tar.gz")
    endif()
    if(arg_EXTRA_FILES)
        set(extra_arguments)
        foreach(extra_file IN LISTS arg_EXTRA_FILES)
            set(extra_arguments "${extra_arguments} --add-file \"${extra_file}\"")
        endforeach()
    endif()

    if (NOT TARGET dist)
        set(g10_dist_archive_name "${PROJECT_NAME}-${version}")
        set(g10_dist_archive_format "${archive_format}")
        set(g10_dist_git_archive_extra_arguments "${extra_arguments}")
        configure_file("${CMAKE_SOURCE_DIR}/cmake/modules/g10_dist.sh.in" "g10_dist.sh" @ONLY)
        execute_process(
            COMMAND chmod +x g10_dist.sh
            WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
        )
        add_custom_target(dist
            COMMENT "Packaging HEAD of sources as ${g10_dist_archive_name}.${g10_dist_archive_format}..."
            COMMAND "${CMAKE_BINARY_DIR}/g10_dist.sh"
            WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
        )
    endif()

    if (NOT TARGET distcheck)
        set(g10_distcheck_archive_name "${PROJECT_NAME}-${version}")
        set(g10_distcheck_archive_format "${archive_format}")
        configure_file("${CMAKE_SOURCE_DIR}/cmake/modules/g10_distcheck.sh.in" "g10_distcheck.sh" @ONLY)
        execute_process(
            COMMAND chmod +x g10_distcheck.sh
            WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
        )
        add_custom_target(distcheck
            COMMAND "${CMAKE_BINARY_DIR}/g10_distcheck.sh"
            WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
        )
    endif()

    add_dependencies(distcheck dist)
endfunction()