summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBastian Krause <bst@pengutronix.de>2021-05-04 13:39:28 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-05-06 08:41:26 +0100
commitce39d05d511c62eb439d9385d107a4058a8d1f60 (patch)
tree1a235d4a47316dce4b009d5125cbc93f084590f3
parent9f951a2d4985d2d05ceb135e0786e1e1ecd73fc0 (diff)
downloadpoky-ce39d05d511c62eb439d9385d107a4058a8d1f60.tar.gz
ccache: add packageconfig docs option
Before, ccache's configure stage built HTML documentation and man pages depending on if asciidoc is installed. This patch makes it configurable. Pass the new cmake option BUILD_DOCS along and add the asciidoc dependency if necessary. This fixes an issue when ccache's configure stage found asciidoc/a2x on the system outside of the sysroot (e.g. installed via 'apt install asciidoc'). ccache would then decide to build docs and manual pages, but would fail during compilation: the system's a2x could not find the system's asciidoc because it did not reside in the set PATH. By enabling/disabling docs/man page generation explicitly and adding asciidoc to DEPENDS as necessary, this is no longer an issue. (From OE-Core rev: b0aedd74f13b174861ff742eb503d8d343f9e714) Signed-off-by: Bastian Krause <bst@pengutronix.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat
-rw-r--r--meta/recipes-devtools/ccache/ccache/0001-doc-allow-disabling-docs-man-page-generation.patch161
-rw-r--r--meta/recipes-devtools/ccache/ccache_4.2.1.bb6
2 files changed, 166 insertions, 1 deletions
diff --git a/meta/recipes-devtools/ccache/ccache/0001-doc-allow-disabling-docs-man-page-generation.patch b/meta/recipes-devtools/ccache/ccache/0001-doc-allow-disabling-docs-man-page-generation.patch
new file mode 100644
index 0000000000..51ca0e82f6
--- /dev/null
+++ b/meta/recipes-devtools/ccache/ccache/0001-doc-allow-disabling-docs-man-page-generation.patch
@@ -0,0 +1,161 @@
1From aebabafe085dd1b84027a1e31e5566c82528bd62 Mon Sep 17 00:00:00 2001
2From: Bastian Krause <bst@pengutronix.de>
3Date: Tue, 4 May 2021 11:41:56 +0200
4Subject: [PATCH] doc: allow disabling docs/man page generation
5
6The assumption that HTML documentation and manual pages should be
7generated if the required tools (asciidoc) are present is not always
8true. So add a cmake option that allows disabling the docs/man page
9generation. The default is to generate docs/man pages like before.
10
11Origin: https://github.com/ccache/ccache/pull/844
12Upstream-Status: Submitted
13Signed-off-by: Bastian Krause <bst@pengutronix.de>
14---
15 doc/CMakeLists.txt | 128 +++++++++++++++++++++++----------------------
16 1 file changed, 66 insertions(+), 62 deletions(-)
17
18diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
19index c5ce224d..74b7831b 100644
20--- a/doc/CMakeLists.txt
21+++ b/doc/CMakeLists.txt
22@@ -1,70 +1,74 @@
23+option(BUILD_DOCS "Indicates whether HTML documentation and manual pages should be built or not" ON)
24+
25 find_program(ASCIIDOC_EXE asciidoc)
26 mark_as_advanced(ASCIIDOC_EXE) # Don't show in CMake UIs
27
28-if(NOT ASCIIDOC_EXE)
29- message(WARNING "Could not find asciidoc; documentation will not be generated")
30-else()
31- #
32- # HTML documentation
33- #
34- function(generate_html adoc_file)
35- get_filename_component(base_name "${adoc_file}" NAME_WE)
36- set(html_file "${base_name}.html")
37- add_custom_command(
38- OUTPUT "${html_file}"
39- COMMAND
40- ${ASCIIDOC_EXE}
41- -o "${html_file}"
42- -a revnumber="${CCACHE_VERSION}"
43- -a toc
44- -b xhtml11
45- "${CMAKE_SOURCE_DIR}/${adoc_file}"
46- MAIN_DEPENDENCY "${CMAKE_SOURCE_DIR}/${adoc_file}"
47- )
48- set(html_files "${html_files}" "${html_file}" PARENT_SCOPE)
49- endfunction()
50+if (BUILD_DOCS)
51+ if(NOT ASCIIDOC_EXE)
52+ message(WARNING "Could not find asciidoc; documentation will not be generated")
53+ else()
54+ #
55+ # HTML documentation
56+ #
57+ function(generate_html adoc_file)
58+ get_filename_component(base_name "${adoc_file}" NAME_WE)
59+ set(html_file "${base_name}.html")
60+ add_custom_command(
61+ OUTPUT "${html_file}"
62+ COMMAND
63+ ${ASCIIDOC_EXE}
64+ -o "${html_file}"
65+ -a revnumber="${CCACHE_VERSION}"
66+ -a toc
67+ -b xhtml11
68+ "${CMAKE_SOURCE_DIR}/${adoc_file}"
69+ MAIN_DEPENDENCY "${CMAKE_SOURCE_DIR}/${adoc_file}"
70+ )
71+ set(html_files "${html_files}" "${html_file}" PARENT_SCOPE)
72+ endfunction()
73
74- generate_html(LICENSE.adoc)
75- generate_html(doc/AUTHORS.adoc)
76- generate_html(doc/MANUAL.adoc)
77- generate_html(doc/NEWS.adoc)
78+ generate_html(LICENSE.adoc)
79+ generate_html(doc/AUTHORS.adoc)
80+ generate_html(doc/MANUAL.adoc)
81+ generate_html(doc/NEWS.adoc)
82
83- add_custom_target(doc-html DEPENDS "${html_files}")
84- set(doc_files "${html_files}")
85+ add_custom_target(doc-html DEPENDS "${html_files}")
86+ set(doc_files "${html_files}")
87
88- #
89- # Man page
90- #
91- find_program(A2X_EXE a2x)
92- mark_as_advanced(A2X_EXE) # Don't show in CMake UIs
93- if(NOT A2X_EXE)
94- message(WARNING "Could not find a2x; man page will not be generated")
95- else()
96- # MANUAL.adoc -> MANUAL.xml -> man page
97- add_custom_command(
98- OUTPUT MANUAL.xml
99- COMMAND
100- ${ASCIIDOC_EXE}
101- -o -
102- -a revnumber=${CCACHE_VERSION}
103- -d manpage
104- -b docbook "${CMAKE_SOURCE_DIR}/doc/MANUAL.adoc"
105- | perl -pe 's!<literal>\(.*?\)</literal>!<emphasis role="strong">\\1</emphasis>!g'
106- >MANUAL.xml
107- MAIN_DEPENDENCY "${CMAKE_SOURCE_DIR}/doc/MANUAL.adoc"
108- )
109- add_custom_command(
110- OUTPUT ccache.1
111- COMMAND ${A2X_EXE} --doctype manpage --format manpage MANUAL.xml
112- MAIN_DEPENDENCY MANUAL.xml
113- )
114- add_custom_target(doc-man-page DEPENDS ccache.1)
115- install(
116- FILES "${CMAKE_CURRENT_BINARY_DIR}/ccache.1"
117- DESTINATION "${CMAKE_INSTALL_MANDIR}/man1"
118- )
119- set(doc_files "${doc_files}" ccache.1)
120- endif()
121+ #
122+ # Man page
123+ #
124+ find_program(A2X_EXE a2x)
125+ mark_as_advanced(A2X_EXE) # Don't show in CMake UIs
126+ if(NOT A2X_EXE)
127+ message(WARNING "Could not find a2x; man page will not be generated")
128+ else()
129+ # MANUAL.adoc -> MANUAL.xml -> man page
130+ add_custom_command(
131+ OUTPUT MANUAL.xml
132+ COMMAND
133+ ${ASCIIDOC_EXE}
134+ -o -
135+ -a revnumber=${CCACHE_VERSION}
136+ -d manpage
137+ -b docbook "${CMAKE_SOURCE_DIR}/doc/MANUAL.adoc"
138+ | perl -pe 's!<literal>\(.*?\)</literal>!<emphasis role="strong">\\1</emphasis>!g'
139+ >MANUAL.xml
140+ MAIN_DEPENDENCY "${CMAKE_SOURCE_DIR}/doc/MANUAL.adoc"
141+ )
142+ add_custom_command(
143+ OUTPUT ccache.1
144+ COMMAND ${A2X_EXE} --doctype manpage --format manpage MANUAL.xml
145+ MAIN_DEPENDENCY MANUAL.xml
146+ )
147+ add_custom_target(doc-man-page DEPENDS ccache.1)
148+ install(
149+ FILES "${CMAKE_CURRENT_BINARY_DIR}/ccache.1"
150+ DESTINATION "${CMAKE_INSTALL_MANDIR}/man1"
151+ )
152+ set(doc_files "${doc_files}" ccache.1)
153+ endif()
154
155- add_custom_target(doc ALL DEPENDS "${doc_files}")
156+ add_custom_target(doc ALL DEPENDS "${doc_files}")
157+ endif()
158 endif()
159--
1602.29.2
161
diff --git a/meta/recipes-devtools/ccache/ccache_4.2.1.bb b/meta/recipes-devtools/ccache/ccache_4.2.1.bb
index 90b9c6181f..8dd5893d68 100644
--- a/meta/recipes-devtools/ccache/ccache_4.2.1.bb
+++ b/meta/recipes-devtools/ccache/ccache_4.2.1.bb
@@ -11,7 +11,9 @@ LIC_FILES_CHKSUM = "file://LICENSE.adoc;md5=698a26b57e513d678e1e7727bf56395b"
11 11
12DEPENDS = "zstd" 12DEPENDS = "zstd"
13 13
14SRC_URI = "https://github.com/ccache/ccache/releases/download/v${PV}/${BP}.tar.gz" 14SRC_URI = "https://github.com/ccache/ccache/releases/download/v${PV}/${BP}.tar.gz \
15 file://0001-doc-allow-disabling-docs-man-page-generation.patch \
16 "
15SRC_URI[sha256sum] = "320d2b17d2f76393e5d4bb28c8dee5ca783248e9cd23dff0654694d60f8a4b62" 17SRC_URI[sha256sum] = "320d2b17d2f76393e5d4bb28c8dee5ca783248e9cd23dff0654694d60f8a4b62"
16 18
17UPSTREAM_CHECK_URI = "https://github.com/ccache/ccache/releases/" 19UPSTREAM_CHECK_URI = "https://github.com/ccache/ccache/releases/"
@@ -21,3 +23,5 @@ inherit cmake
21PATCHTOOL = "patch" 23PATCHTOOL = "patch"
22 24
23BBCLASSEXTEND = "native nativesdk" 25BBCLASSEXTEND = "native nativesdk"
26
27PACKAGECONFIG[docs] = "-DBUILD_DOCS=ON,-DBUILD_DOCS=OFF,asciidoc"
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-27 13:51:58 +0000