* [PR PATCH] doxygen: add documentation
@ 2023-05-25 17:58 meator
2023-05-25 18:29 ` meator
` (8 more replies)
0 siblings, 9 replies; 10+ messages in thread
From: meator @ 2023-05-25 17:58 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 488 bytes --]
There is a new pull request by meator against master on the void-packages repository
https://github.com/meator/void-packages doxygen
https://github.com/void-linux/void-packages/pull/44079
doxygen: add documentation
<!-- Uncomment relevant sections and delete options which are not applicable -->
CC maintainer @ericonr
#### Testing the changes
- I tested the changes in this PR: **YES**
A patch file from https://github.com/void-linux/void-packages/pull/44079.patch is attached
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-doxygen-44079.patch --]
[-- Type: text/x-diff, Size: 1947 bytes --]
From e012e418287327d05f9e22d063ee38c9890d8cd9 Mon Sep 17 00:00:00 2001
From: meator <meator.dev@gmail.com>
Date: Thu, 25 May 2023 19:51:37 +0200
Subject: [PATCH] doxygen: add documentation
---
srcpkgs/doxygen-doc | 1 +
srcpkgs/doxygen/template | 30 +++++++++++++++++++++++++-----
2 files changed, 26 insertions(+), 5 deletions(-)
create mode 120000 srcpkgs/doxygen-doc
diff --git a/srcpkgs/doxygen-doc b/srcpkgs/doxygen-doc
new file mode 120000
index 000000000000..a7610321645c
--- /dev/null
+++ b/srcpkgs/doxygen-doc
@@ -0,0 +1 @@
+doxygen
\ No newline at end of file
diff --git a/srcpkgs/doxygen/template b/srcpkgs/doxygen/template
index 981eb49049a9..4ebd6c15b493 100644
--- a/srcpkgs/doxygen/template
+++ b/srcpkgs/doxygen/template
@@ -1,9 +1,11 @@
# Template file for 'doxygen'
pkgname=doxygen
version=1.9.5
-revision=2
+revision=3
build_style=cmake
-hostmakedepends="perl python3 flex"
+configure_args="-Dbuild_doc=ON"
+hostmakedepends="perl python3 flex texlive-ConTeXt texlive-latexextra
+ texlive-dvi"
checkdepends="libxml2 texlive-BibTeX"
short_desc="Source code documentation generator tool"
maintainer="Érico Nogueira <ericonr@disroot.org>"
@@ -25,9 +27,27 @@ if [ "$build_option_wizard" ]; then
makedepends+=" qt5-devel"
fi
+post_build() {
+ ninja -C build docs
+}
+
post_install() {
- vman doc/doxygen.1
- if [ "$build_option_wizard" ]; then
- vman doc/doxywizard.1
+ if [ ! "$build_option_wizard" ]; then
+ rm ${DESTDIR}/usr/share/man/man1/doxywizard.1
fi
+
+ # These manpages are generated because build_doc is ON, but we don't
+ # build these programs.
+ rm ${DESTDIR}/usr/share/man/man1/doxyindexer.1
+ rm ${DESTDIR}/usr/share/man/man1/doxysearch.1
+
+ mv ${DESTDIR}/usr/share/doc/packages/doxygen ${DESTDIR}/usr/share/doc/doxygen
+}
+
+doxygen-doc_package() {
+ short_desc+=" - documentation"
+ depends="${sourcepkg}>=${version}_${revision}"
+ pkg_install() {
+ vmove usr/share/doc/doxygen
+ }
}
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: doxygen: add documentation
2023-05-25 17:58 [PR PATCH] doxygen: add documentation meator
@ 2023-05-25 18:29 ` meator
2023-05-27 16:34 ` meator
` (7 subsequent siblings)
8 siblings, 0 replies; 10+ messages in thread
From: meator @ 2023-05-25 18:29 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 802 bytes --]
New comment by meator on void-packages repository
https://github.com/void-linux/void-packages/pull/44079#issuecomment-1563331927
Comment:
Ugh. This happens every time. Why do build systems always want to execute the program they are building?
This isn't my first time in the rodeo. AFAIK there are two solutions to this: `build_helper=qemu` and stuff `vtargetrun`
somewhere in doxygen's build system or make doxygen depend on itself (the cross version on the native version) and then use native version's files in the cross package. I would prefer the second solution because I am not familiar with doxygen's build system.
I don't want to invest time into this if it will be rejected so: Will this be rejected? Is this too hacky for void-packages?
Offline documentation is really nice.
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: doxygen: add documentation
2023-05-25 17:58 [PR PATCH] doxygen: add documentation meator
2023-05-25 18:29 ` meator
@ 2023-05-27 16:34 ` meator
2023-05-27 18:26 ` [PR PATCH] [Updated] " meator
` (6 subsequent siblings)
8 siblings, 0 replies; 10+ messages in thread
From: meator @ 2023-05-27 16:34 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 316 bytes --]
New comment by meator on void-packages repository
https://github.com/void-linux/void-packages/pull/44079#issuecomment-1565585704
Comment:
I am working on updating doxygen to 1.9.7 but I've encountered an issue with building documentation. I have contacted upstream: https://github.com/doxygen/doxygen/issues/10094
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PR PATCH] [Updated] doxygen: add documentation
2023-05-25 17:58 [PR PATCH] doxygen: add documentation meator
2023-05-25 18:29 ` meator
2023-05-27 16:34 ` meator
@ 2023-05-27 18:26 ` meator
2023-05-31 11:23 ` [PR PATCH] [Updated] doxygen: update + " meator
` (5 subsequent siblings)
8 siblings, 0 replies; 10+ messages in thread
From: meator @ 2023-05-27 18:26 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 493 bytes --]
There is an updated pull request by meator against master on the void-packages repository
https://github.com/meator/void-packages doxygen
https://github.com/void-linux/void-packages/pull/44079
doxygen: add documentation
<!-- Uncomment relevant sections and delete options which are not applicable -->
CC maintainer @ericonr
#### Testing the changes
- I tested the changes in this PR: **YES**
A patch file from https://github.com/void-linux/void-packages/pull/44079.patch is attached
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-doxygen-44079.patch --]
[-- Type: text/x-diff, Size: 5253 bytes --]
From 6c314328d1b74bff04b382f7bc94143fbeb0c163 Mon Sep 17 00:00:00 2001
From: meator <meator.dev@gmail.com>
Date: Thu, 25 May 2023 19:51:37 +0200
Subject: [PATCH] doxygen: update to 1.9.7 + add documentation
This adds a new subpackage doxygen-doc which contains doxygen's
documentation in PDF and HTML form.
---
srcpkgs/doxygen-doc | 1 +
.../doxygen/files/use-native-doxygen.patch | 39 +++++++++++++++
srcpkgs/doxygen/template | 50 ++++++++++++++++---
3 files changed, 83 insertions(+), 7 deletions(-)
create mode 120000 srcpkgs/doxygen-doc
create mode 100644 srcpkgs/doxygen/files/use-native-doxygen.patch
diff --git a/srcpkgs/doxygen-doc b/srcpkgs/doxygen-doc
new file mode 120000
index 000000000000..a7610321645c
--- /dev/null
+++ b/srcpkgs/doxygen-doc
@@ -0,0 +1 @@
+doxygen
\ No newline at end of file
diff --git a/srcpkgs/doxygen/files/use-native-doxygen.patch b/srcpkgs/doxygen/files/use-native-doxygen.patch
new file mode 100644
index 000000000000..bb8c516e40ec
--- /dev/null
+++ b/srcpkgs/doxygen/files/use-native-doxygen.patch
@@ -0,0 +1,39 @@
+This patch is applied only when cross building. It makes sure that the native
+version of doxygen is used for documentation generation and not the freshly built
+one (which cannot be executed on host).
+--- a/doc/CMakeLists.txt
++++ b/doc/CMakeLists.txt
+@@ -21,13 +21,9 @@
+ find_program(MAKEINDEX NAMES makeindex )
+ include(GNUInstallDirs)
+
+-if (doxygen_BINARY_DIR)
+- set(DOXYGEN_EXECUTABLE ${doxygen_BINARY_DIR}/bin/doxygen)
+-else()
+ # when building only the doxygen_doc, from the doc/ directory, the
+ # doxygen project variables are unknown so look for doxygen in PATH
+ find_package(Doxygen)
+-endif()
+
+ set(DOC_INSTALL_DIR "share/doc/packages/doxygen" CACHE STRING "Relative path where to install the documentation")
+ set(DOC_FILES
+--- a/examples/CMakeLists.txt
++++ b/examples/CMakeLists.txt
+@@ -62,6 +62,8 @@
+ EXAMPLE_manual EXAMPLE_mux
+ )
+
++find_package(Doxygen)
++
+ foreach (f_inp ${BASIC_EXAMPLES})
+ list(LENGTH ${f_inp} f_len)
+ list(GET ${f_inp} 0 f)
+@@ -74,7 +76,7 @@
+ add_custom_command(
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/html/examples/${f}
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/latex/examples/${f}
+- COMMAND ${CMAKE_COMMAND} -E env PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR} ${EXECUTABLE_OUTPUT_PATH}/doxygen ${f}.cfg
++ COMMAND ${CMAKE_COMMAND} -E env PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR} ${DOXYGEN_EXECUTABLE} ${f}.cfg
+ COMMAND ${PYTHON_EXECUTABLE} ${TOP}/examples/strip_example.py < ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman.tex > ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman_doc.tex
+ DEPENDS doxygen ${f}.${f_ext} ${f}.cfg ${TOP}/examples/strip_example.py ${f_dep}
+ OUTPUT ${PROJECT_BINARY_DIR}/html/examples/${f}/html/index.html ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman_doc.tex
diff --git a/srcpkgs/doxygen/template b/srcpkgs/doxygen/template
index 981eb49049a9..3d9d26663269 100644
--- a/srcpkgs/doxygen/template
+++ b/srcpkgs/doxygen/template
@@ -1,9 +1,11 @@
# Template file for 'doxygen'
pkgname=doxygen
-version=1.9.5
-revision=2
+version=1.9.7
+revision=1
build_style=cmake
-hostmakedepends="perl python3 flex"
+configure_args="-Dbuild_doc=ON"
+hostmakedepends="perl python3 flex texlive-ConTeXt texlive-latexextra
+ texlive-dvi"
checkdepends="libxml2 texlive-BibTeX"
short_desc="Source code documentation generator tool"
maintainer="Érico Nogueira <ericonr@disroot.org>"
@@ -11,7 +13,11 @@ license="GPL-2.0-only"
homepage="http://www.doxygen.org/"
changelog="https://www.doxygen.nl/manual/changelog.html"
distfiles="http://doxygen.nl/files/doxygen-${version}.src.tar.gz"
-checksum=55b454b35d998229a96f3d5485d57a0a517ce2b78d025efb79d57b5a2e4b2eec
+checksum=87007641c38e2c392c8596f36711eb97633b984c8430f389e7bcf6323a098d94
+
+if [ "$CROSS_BUILD" ]; then
+ hostmakedepends+=" doxygen"
+fi
build_options="wizard"
desc_option_wizard="build Qt5 GUI configuration tool, doxywizard"
@@ -25,9 +31,39 @@ if [ "$build_option_wizard" ]; then
makedepends+=" qt5-devel"
fi
+post_extract() {
+ # See https://github.com/doxygen/doxygen/issues/10094
+ rm src/._formula.h templates/._.DS_Store templates/html/._resize.js deps/filesystem/._filesystem.hpp
+}
+
+# Use the host doxygen when building documentation on cross.
+do_patch() {
+ if [ "$CROSS_BUILD" ]; then
+ patch -Np1 < ${FILESDIR}/use-native-doxygen.patch
+ fi
+}
+
+post_build() {
+ ninja -C build docs
+}
+
post_install() {
- vman doc/doxygen.1
- if [ "$build_option_wizard" ]; then
- vman doc/doxywizard.1
+ if [ ! "$build_option_wizard" ]; then
+ rm ${DESTDIR}/usr/share/man/man1/doxywizard.1
fi
+
+ # These manpages are generated because build_doc is ON, but we don't
+ # build these programs.
+ rm ${DESTDIR}/usr/share/man/man1/doxyindexer.1
+ rm ${DESTDIR}/usr/share/man/man1/doxysearch.1
+
+ mv ${DESTDIR}/usr/share/doc/packages/doxygen ${DESTDIR}/usr/share/doc/doxygen
+}
+
+doxygen-doc_package() {
+ short_desc+=" - documentation"
+ depends="${sourcepkg}>=${version}_${revision}"
+ pkg_install() {
+ vmove usr/share/doc/doxygen
+ }
}
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PR PATCH] [Updated] doxygen: update + add documentation
2023-05-25 17:58 [PR PATCH] doxygen: add documentation meator
` (2 preceding siblings ...)
2023-05-27 18:26 ` [PR PATCH] [Updated] " meator
@ 2023-05-31 11:23 ` meator
2023-05-31 11:26 ` meator
` (4 subsequent siblings)
8 siblings, 0 replies; 10+ messages in thread
From: meator @ 2023-05-31 11:23 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 502 bytes --]
There is an updated pull request by meator against master on the void-packages repository
https://github.com/meator/void-packages doxygen
https://github.com/void-linux/void-packages/pull/44079
doxygen: update + add documentation
<!-- Uncomment relevant sections and delete options which are not applicable -->
CC maintainer @ericonr
#### Testing the changes
- I tested the changes in this PR: **YES**
A patch file from https://github.com/void-linux/void-packages/pull/44079.patch is attached
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-doxygen-44079.patch --]
[-- Type: text/x-diff, Size: 5312 bytes --]
From e6baca99392811c7009b60c56d3eeda9ca6a10c2 Mon Sep 17 00:00:00 2001
From: meator <meator.dev@gmail.com>
Date: Thu, 25 May 2023 19:51:37 +0200
Subject: [PATCH] doxygen: update to 1.9.7 + add documentation
This adds a new subpackage doxygen-doc which contains doxygen's
documentation in PDF and HTML form.
This uses the .repack version of doxygen which contains some fixes,
notably for #10094 and #10053 doxygen issues.
---
srcpkgs/doxygen-doc | 1 +
.../doxygen/files/use-native-doxygen.patch | 39 +++++++++++++++
srcpkgs/doxygen/template | 48 +++++++++++++++----
3 files changed, 80 insertions(+), 8 deletions(-)
create mode 120000 srcpkgs/doxygen-doc
create mode 100644 srcpkgs/doxygen/files/use-native-doxygen.patch
diff --git a/srcpkgs/doxygen-doc b/srcpkgs/doxygen-doc
new file mode 120000
index 000000000000..a7610321645c
--- /dev/null
+++ b/srcpkgs/doxygen-doc
@@ -0,0 +1 @@
+doxygen
\ No newline at end of file
diff --git a/srcpkgs/doxygen/files/use-native-doxygen.patch b/srcpkgs/doxygen/files/use-native-doxygen.patch
new file mode 100644
index 000000000000..bb8c516e40ec
--- /dev/null
+++ b/srcpkgs/doxygen/files/use-native-doxygen.patch
@@ -0,0 +1,39 @@
+This patch is applied only when cross building. It makes sure that the native
+version of doxygen is used for documentation generation and not the freshly built
+one (which cannot be executed on host).
+--- a/doc/CMakeLists.txt
++++ b/doc/CMakeLists.txt
+@@ -21,13 +21,9 @@
+ find_program(MAKEINDEX NAMES makeindex )
+ include(GNUInstallDirs)
+
+-if (doxygen_BINARY_DIR)
+- set(DOXYGEN_EXECUTABLE ${doxygen_BINARY_DIR}/bin/doxygen)
+-else()
+ # when building only the doxygen_doc, from the doc/ directory, the
+ # doxygen project variables are unknown so look for doxygen in PATH
+ find_package(Doxygen)
+-endif()
+
+ set(DOC_INSTALL_DIR "share/doc/packages/doxygen" CACHE STRING "Relative path where to install the documentation")
+ set(DOC_FILES
+--- a/examples/CMakeLists.txt
++++ b/examples/CMakeLists.txt
+@@ -62,6 +62,8 @@
+ EXAMPLE_manual EXAMPLE_mux
+ )
+
++find_package(Doxygen)
++
+ foreach (f_inp ${BASIC_EXAMPLES})
+ list(LENGTH ${f_inp} f_len)
+ list(GET ${f_inp} 0 f)
+@@ -74,7 +76,7 @@
+ add_custom_command(
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/html/examples/${f}
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/latex/examples/${f}
+- COMMAND ${CMAKE_COMMAND} -E env PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR} ${EXECUTABLE_OUTPUT_PATH}/doxygen ${f}.cfg
++ COMMAND ${CMAKE_COMMAND} -E env PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR} ${DOXYGEN_EXECUTABLE} ${f}.cfg
+ COMMAND ${PYTHON_EXECUTABLE} ${TOP}/examples/strip_example.py < ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman.tex > ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman_doc.tex
+ DEPENDS doxygen ${f}.${f_ext} ${f}.cfg ${TOP}/examples/strip_example.py ${f_dep}
+ OUTPUT ${PROJECT_BINARY_DIR}/html/examples/${f}/html/index.html ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman_doc.tex
diff --git a/srcpkgs/doxygen/template b/srcpkgs/doxygen/template
index 981eb49049a9..46378ec8131a 100644
--- a/srcpkgs/doxygen/template
+++ b/srcpkgs/doxygen/template
@@ -1,17 +1,24 @@
# Template file for 'doxygen'
pkgname=doxygen
-version=1.9.5
-revision=2
+version=1.9.7
+revision=1
build_style=cmake
-hostmakedepends="perl python3 flex"
+configure_args="-Dbuild_doc=ON"
+hostmakedepends="perl python3 flex texlive-ConTeXt texlive-latexextra
+ texlive-dvi"
checkdepends="libxml2 texlive-BibTeX"
short_desc="Source code documentation generator tool"
maintainer="Érico Nogueira <ericonr@disroot.org>"
license="GPL-2.0-only"
homepage="http://www.doxygen.org/"
changelog="https://www.doxygen.nl/manual/changelog.html"
-distfiles="http://doxygen.nl/files/doxygen-${version}.src.tar.gz"
-checksum=55b454b35d998229a96f3d5485d57a0a517ce2b78d025efb79d57b5a2e4b2eec
+# This archive contains few fixes. Next update must remove .repack
+distfiles="https://doxygen.nl/files/doxygen-${version}.repack.src.tar.gz"
+checksum=aa9b2118578f4d277954c8584eb7228be47cdf29e8041ce4dcba21e41dfb89f3
+
+if [ "$CROSS_BUILD" ]; then
+ hostmakedepends+=" doxygen"
+fi
build_options="wizard"
desc_option_wizard="build Qt5 GUI configuration tool, doxywizard"
@@ -25,9 +32,34 @@ if [ "$build_option_wizard" ]; then
makedepends+=" qt5-devel"
fi
+# Use the host doxygen when building documentation on cross.
+do_patch() {
+ if [ "$CROSS_BUILD" ]; then
+ patch -Np1 < ${FILESDIR}/use-native-doxygen.patch
+ fi
+}
+
+post_build() {
+ ninja -C build docs
+}
+
post_install() {
- vman doc/doxygen.1
- if [ "$build_option_wizard" ]; then
- vman doc/doxywizard.1
+ if [ ! "$build_option_wizard" ]; then
+ rm ${DESTDIR}/usr/share/man/man1/doxywizard.1
fi
+
+ # These manpages are generated because build_doc is ON, but we don't
+ # build these programs.
+ rm ${DESTDIR}/usr/share/man/man1/doxyindexer.1
+ rm ${DESTDIR}/usr/share/man/man1/doxysearch.1
+
+ mv ${DESTDIR}/usr/share/doc/packages/doxygen ${DESTDIR}/usr/share/doc/doxygen
+}
+
+doxygen-doc_package() {
+ short_desc+=" - documentation"
+ depends="${sourcepkg}>=${version}_${revision}"
+ pkg_install() {
+ vmove usr/share/doc/doxygen
+ }
}
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PR PATCH] [Updated] doxygen: update + add documentation
2023-05-25 17:58 [PR PATCH] doxygen: add documentation meator
` (3 preceding siblings ...)
2023-05-31 11:23 ` [PR PATCH] [Updated] doxygen: update + " meator
@ 2023-05-31 11:26 ` meator
2023-05-31 11:26 ` meator
` (3 subsequent siblings)
8 siblings, 0 replies; 10+ messages in thread
From: meator @ 2023-05-31 11:26 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 502 bytes --]
There is an updated pull request by meator against master on the void-packages repository
https://github.com/meator/void-packages doxygen
https://github.com/void-linux/void-packages/pull/44079
doxygen: update + add documentation
<!-- Uncomment relevant sections and delete options which are not applicable -->
CC maintainer @ericonr
#### Testing the changes
- I tested the changes in this PR: **YES**
A patch file from https://github.com/void-linux/void-packages/pull/44079.patch is attached
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-doxygen-44079.patch --]
[-- Type: text/x-diff, Size: 5384 bytes --]
From 934ccdf9589cebc13a9fc51776803eed95357894 Mon Sep 17 00:00:00 2001
From: meator <meator.dev@gmail.com>
Date: Thu, 25 May 2023 19:51:37 +0200
Subject: [PATCH] doxygen: update to 1.9.7 + add documentation
This adds a new subpackage doxygen-doc which contains doxygen's
documentation in PDF and HTML form.
This uses the .repack version of doxygen which contains some fixes,
notably for https://github.com/doxygen/doxygen/issues/10094 and
https://github.com/doxygen/doxygen/issues/10053#10053
---
srcpkgs/doxygen-doc | 1 +
.../doxygen/files/use-native-doxygen.patch | 39 +++++++++++++++
srcpkgs/doxygen/template | 48 +++++++++++++++----
3 files changed, 80 insertions(+), 8 deletions(-)
create mode 120000 srcpkgs/doxygen-doc
create mode 100644 srcpkgs/doxygen/files/use-native-doxygen.patch
diff --git a/srcpkgs/doxygen-doc b/srcpkgs/doxygen-doc
new file mode 120000
index 000000000000..a7610321645c
--- /dev/null
+++ b/srcpkgs/doxygen-doc
@@ -0,0 +1 @@
+doxygen
\ No newline at end of file
diff --git a/srcpkgs/doxygen/files/use-native-doxygen.patch b/srcpkgs/doxygen/files/use-native-doxygen.patch
new file mode 100644
index 000000000000..bb8c516e40ec
--- /dev/null
+++ b/srcpkgs/doxygen/files/use-native-doxygen.patch
@@ -0,0 +1,39 @@
+This patch is applied only when cross building. It makes sure that the native
+version of doxygen is used for documentation generation and not the freshly built
+one (which cannot be executed on host).
+--- a/doc/CMakeLists.txt
++++ b/doc/CMakeLists.txt
+@@ -21,13 +21,9 @@
+ find_program(MAKEINDEX NAMES makeindex )
+ include(GNUInstallDirs)
+
+-if (doxygen_BINARY_DIR)
+- set(DOXYGEN_EXECUTABLE ${doxygen_BINARY_DIR}/bin/doxygen)
+-else()
+ # when building only the doxygen_doc, from the doc/ directory, the
+ # doxygen project variables are unknown so look for doxygen in PATH
+ find_package(Doxygen)
+-endif()
+
+ set(DOC_INSTALL_DIR "share/doc/packages/doxygen" CACHE STRING "Relative path where to install the documentation")
+ set(DOC_FILES
+--- a/examples/CMakeLists.txt
++++ b/examples/CMakeLists.txt
+@@ -62,6 +62,8 @@
+ EXAMPLE_manual EXAMPLE_mux
+ )
+
++find_package(Doxygen)
++
+ foreach (f_inp ${BASIC_EXAMPLES})
+ list(LENGTH ${f_inp} f_len)
+ list(GET ${f_inp} 0 f)
+@@ -74,7 +76,7 @@
+ add_custom_command(
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/html/examples/${f}
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/latex/examples/${f}
+- COMMAND ${CMAKE_COMMAND} -E env PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR} ${EXECUTABLE_OUTPUT_PATH}/doxygen ${f}.cfg
++ COMMAND ${CMAKE_COMMAND} -E env PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR} ${DOXYGEN_EXECUTABLE} ${f}.cfg
+ COMMAND ${PYTHON_EXECUTABLE} ${TOP}/examples/strip_example.py < ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman.tex > ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman_doc.tex
+ DEPENDS doxygen ${f}.${f_ext} ${f}.cfg ${TOP}/examples/strip_example.py ${f_dep}
+ OUTPUT ${PROJECT_BINARY_DIR}/html/examples/${f}/html/index.html ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman_doc.tex
diff --git a/srcpkgs/doxygen/template b/srcpkgs/doxygen/template
index 981eb49049a9..46378ec8131a 100644
--- a/srcpkgs/doxygen/template
+++ b/srcpkgs/doxygen/template
@@ -1,17 +1,24 @@
# Template file for 'doxygen'
pkgname=doxygen
-version=1.9.5
-revision=2
+version=1.9.7
+revision=1
build_style=cmake
-hostmakedepends="perl python3 flex"
+configure_args="-Dbuild_doc=ON"
+hostmakedepends="perl python3 flex texlive-ConTeXt texlive-latexextra
+ texlive-dvi"
checkdepends="libxml2 texlive-BibTeX"
short_desc="Source code documentation generator tool"
maintainer="Érico Nogueira <ericonr@disroot.org>"
license="GPL-2.0-only"
homepage="http://www.doxygen.org/"
changelog="https://www.doxygen.nl/manual/changelog.html"
-distfiles="http://doxygen.nl/files/doxygen-${version}.src.tar.gz"
-checksum=55b454b35d998229a96f3d5485d57a0a517ce2b78d025efb79d57b5a2e4b2eec
+# This archive contains few fixes. Next update must remove .repack
+distfiles="https://doxygen.nl/files/doxygen-${version}.repack.src.tar.gz"
+checksum=aa9b2118578f4d277954c8584eb7228be47cdf29e8041ce4dcba21e41dfb89f3
+
+if [ "$CROSS_BUILD" ]; then
+ hostmakedepends+=" doxygen"
+fi
build_options="wizard"
desc_option_wizard="build Qt5 GUI configuration tool, doxywizard"
@@ -25,9 +32,34 @@ if [ "$build_option_wizard" ]; then
makedepends+=" qt5-devel"
fi
+# Use the host doxygen when building documentation on cross.
+do_patch() {
+ if [ "$CROSS_BUILD" ]; then
+ patch -Np1 < ${FILESDIR}/use-native-doxygen.patch
+ fi
+}
+
+post_build() {
+ ninja -C build docs
+}
+
post_install() {
- vman doc/doxygen.1
- if [ "$build_option_wizard" ]; then
- vman doc/doxywizard.1
+ if [ ! "$build_option_wizard" ]; then
+ rm ${DESTDIR}/usr/share/man/man1/doxywizard.1
fi
+
+ # These manpages are generated because build_doc is ON, but we don't
+ # build these programs.
+ rm ${DESTDIR}/usr/share/man/man1/doxyindexer.1
+ rm ${DESTDIR}/usr/share/man/man1/doxysearch.1
+
+ mv ${DESTDIR}/usr/share/doc/packages/doxygen ${DESTDIR}/usr/share/doc/doxygen
+}
+
+doxygen-doc_package() {
+ short_desc+=" - documentation"
+ depends="${sourcepkg}>=${version}_${revision}"
+ pkg_install() {
+ vmove usr/share/doc/doxygen
+ }
}
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PR PATCH] [Updated] doxygen: update + add documentation
2023-05-25 17:58 [PR PATCH] doxygen: add documentation meator
` (4 preceding siblings ...)
2023-05-31 11:26 ` meator
@ 2023-05-31 11:26 ` meator
2023-07-30 14:21 ` meator
` (2 subsequent siblings)
8 siblings, 0 replies; 10+ messages in thread
From: meator @ 2023-05-31 11:26 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 502 bytes --]
There is an updated pull request by meator against master on the void-packages repository
https://github.com/meator/void-packages doxygen
https://github.com/void-linux/void-packages/pull/44079
doxygen: update + add documentation
<!-- Uncomment relevant sections and delete options which are not applicable -->
CC maintainer @ericonr
#### Testing the changes
- I tested the changes in this PR: **YES**
A patch file from https://github.com/void-linux/void-packages/pull/44079.patch is attached
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-doxygen-44079.patch --]
[-- Type: text/x-diff, Size: 5378 bytes --]
From 808a55cc664c3f0cb259b9ec6afa1204f31a498c Mon Sep 17 00:00:00 2001
From: meator <meator.dev@gmail.com>
Date: Thu, 25 May 2023 19:51:37 +0200
Subject: [PATCH] doxygen: update to 1.9.7 + add documentation
This adds a new subpackage doxygen-doc which contains doxygen's
documentation in PDF and HTML form.
This uses the .repack version of doxygen which contains some fixes,
notably for https://github.com/doxygen/doxygen/issues/10094 and
https://github.com/doxygen/doxygen/issues/10053
---
srcpkgs/doxygen-doc | 1 +
.../doxygen/files/use-native-doxygen.patch | 39 +++++++++++++++
srcpkgs/doxygen/template | 48 +++++++++++++++----
3 files changed, 80 insertions(+), 8 deletions(-)
create mode 120000 srcpkgs/doxygen-doc
create mode 100644 srcpkgs/doxygen/files/use-native-doxygen.patch
diff --git a/srcpkgs/doxygen-doc b/srcpkgs/doxygen-doc
new file mode 120000
index 000000000000..a7610321645c
--- /dev/null
+++ b/srcpkgs/doxygen-doc
@@ -0,0 +1 @@
+doxygen
\ No newline at end of file
diff --git a/srcpkgs/doxygen/files/use-native-doxygen.patch b/srcpkgs/doxygen/files/use-native-doxygen.patch
new file mode 100644
index 000000000000..bb8c516e40ec
--- /dev/null
+++ b/srcpkgs/doxygen/files/use-native-doxygen.patch
@@ -0,0 +1,39 @@
+This patch is applied only when cross building. It makes sure that the native
+version of doxygen is used for documentation generation and not the freshly built
+one (which cannot be executed on host).
+--- a/doc/CMakeLists.txt
++++ b/doc/CMakeLists.txt
+@@ -21,13 +21,9 @@
+ find_program(MAKEINDEX NAMES makeindex )
+ include(GNUInstallDirs)
+
+-if (doxygen_BINARY_DIR)
+- set(DOXYGEN_EXECUTABLE ${doxygen_BINARY_DIR}/bin/doxygen)
+-else()
+ # when building only the doxygen_doc, from the doc/ directory, the
+ # doxygen project variables are unknown so look for doxygen in PATH
+ find_package(Doxygen)
+-endif()
+
+ set(DOC_INSTALL_DIR "share/doc/packages/doxygen" CACHE STRING "Relative path where to install the documentation")
+ set(DOC_FILES
+--- a/examples/CMakeLists.txt
++++ b/examples/CMakeLists.txt
+@@ -62,6 +62,8 @@
+ EXAMPLE_manual EXAMPLE_mux
+ )
+
++find_package(Doxygen)
++
+ foreach (f_inp ${BASIC_EXAMPLES})
+ list(LENGTH ${f_inp} f_len)
+ list(GET ${f_inp} 0 f)
+@@ -74,7 +76,7 @@
+ add_custom_command(
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/html/examples/${f}
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/latex/examples/${f}
+- COMMAND ${CMAKE_COMMAND} -E env PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR} ${EXECUTABLE_OUTPUT_PATH}/doxygen ${f}.cfg
++ COMMAND ${CMAKE_COMMAND} -E env PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR} ${DOXYGEN_EXECUTABLE} ${f}.cfg
+ COMMAND ${PYTHON_EXECUTABLE} ${TOP}/examples/strip_example.py < ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman.tex > ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman_doc.tex
+ DEPENDS doxygen ${f}.${f_ext} ${f}.cfg ${TOP}/examples/strip_example.py ${f_dep}
+ OUTPUT ${PROJECT_BINARY_DIR}/html/examples/${f}/html/index.html ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman_doc.tex
diff --git a/srcpkgs/doxygen/template b/srcpkgs/doxygen/template
index 981eb49049a9..46378ec8131a 100644
--- a/srcpkgs/doxygen/template
+++ b/srcpkgs/doxygen/template
@@ -1,17 +1,24 @@
# Template file for 'doxygen'
pkgname=doxygen
-version=1.9.5
-revision=2
+version=1.9.7
+revision=1
build_style=cmake
-hostmakedepends="perl python3 flex"
+configure_args="-Dbuild_doc=ON"
+hostmakedepends="perl python3 flex texlive-ConTeXt texlive-latexextra
+ texlive-dvi"
checkdepends="libxml2 texlive-BibTeX"
short_desc="Source code documentation generator tool"
maintainer="Érico Nogueira <ericonr@disroot.org>"
license="GPL-2.0-only"
homepage="http://www.doxygen.org/"
changelog="https://www.doxygen.nl/manual/changelog.html"
-distfiles="http://doxygen.nl/files/doxygen-${version}.src.tar.gz"
-checksum=55b454b35d998229a96f3d5485d57a0a517ce2b78d025efb79d57b5a2e4b2eec
+# This archive contains few fixes. Next update must remove .repack
+distfiles="https://doxygen.nl/files/doxygen-${version}.repack.src.tar.gz"
+checksum=aa9b2118578f4d277954c8584eb7228be47cdf29e8041ce4dcba21e41dfb89f3
+
+if [ "$CROSS_BUILD" ]; then
+ hostmakedepends+=" doxygen"
+fi
build_options="wizard"
desc_option_wizard="build Qt5 GUI configuration tool, doxywizard"
@@ -25,9 +32,34 @@ if [ "$build_option_wizard" ]; then
makedepends+=" qt5-devel"
fi
+# Use the host doxygen when building documentation on cross.
+do_patch() {
+ if [ "$CROSS_BUILD" ]; then
+ patch -Np1 < ${FILESDIR}/use-native-doxygen.patch
+ fi
+}
+
+post_build() {
+ ninja -C build docs
+}
+
post_install() {
- vman doc/doxygen.1
- if [ "$build_option_wizard" ]; then
- vman doc/doxywizard.1
+ if [ ! "$build_option_wizard" ]; then
+ rm ${DESTDIR}/usr/share/man/man1/doxywizard.1
fi
+
+ # These manpages are generated because build_doc is ON, but we don't
+ # build these programs.
+ rm ${DESTDIR}/usr/share/man/man1/doxyindexer.1
+ rm ${DESTDIR}/usr/share/man/man1/doxysearch.1
+
+ mv ${DESTDIR}/usr/share/doc/packages/doxygen ${DESTDIR}/usr/share/doc/doxygen
+}
+
+doxygen-doc_package() {
+ short_desc+=" - documentation"
+ depends="${sourcepkg}>=${version}_${revision}"
+ pkg_install() {
+ vmove usr/share/doc/doxygen
+ }
}
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PR PATCH] [Updated] doxygen: update + add documentation
2023-05-25 17:58 [PR PATCH] doxygen: add documentation meator
` (5 preceding siblings ...)
2023-05-31 11:26 ` meator
@ 2023-07-30 14:21 ` meator
2023-10-29 1:45 ` doxygen: " github-actions
2023-11-12 1:46 ` [PR PATCH] [Closed]: " github-actions
8 siblings, 0 replies; 10+ messages in thread
From: meator @ 2023-07-30 14:21 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 502 bytes --]
There is an updated pull request by meator against master on the void-packages repository
https://github.com/meator/void-packages doxygen
https://github.com/void-linux/void-packages/pull/44079
doxygen: update + add documentation
<!-- Uncomment relevant sections and delete options which are not applicable -->
CC maintainer @ericonr
#### Testing the changes
- I tested the changes in this PR: **YES**
A patch file from https://github.com/void-linux/void-packages/pull/44079.patch is attached
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-doxygen-44079.patch --]
[-- Type: text/x-diff, Size: 5308 bytes --]
From 867f3ae201736a78562aedac9de1af8a983b4afb Mon Sep 17 00:00:00 2001
From: meator <meator.dev@gmail.com>
Date: Thu, 25 May 2023 19:51:37 +0200
Subject: [PATCH] doxygen: add documentation
This adds a new subpackage doxygen-doc which contains doxygen's
documentation in PDF and HTML form.
This uses the .repack version of doxygen which contains some fixes,
notably for https://github.com/doxygen/doxygen/issues/10094 and
https://github.com/doxygen/doxygen/issues/10053
---
srcpkgs/doxygen-doc | 1 +
.../doxygen/files/use-native-doxygen.patch | 39 ++++++++++++++++
srcpkgs/doxygen/template | 44 ++++++++++++++++---
3 files changed, 78 insertions(+), 6 deletions(-)
create mode 120000 srcpkgs/doxygen-doc
create mode 100644 srcpkgs/doxygen/files/use-native-doxygen.patch
diff --git a/srcpkgs/doxygen-doc b/srcpkgs/doxygen-doc
new file mode 120000
index 0000000000000..a7610321645c8
--- /dev/null
+++ b/srcpkgs/doxygen-doc
@@ -0,0 +1 @@
+doxygen
\ No newline at end of file
diff --git a/srcpkgs/doxygen/files/use-native-doxygen.patch b/srcpkgs/doxygen/files/use-native-doxygen.patch
new file mode 100644
index 0000000000000..bb8c516e40ec3
--- /dev/null
+++ b/srcpkgs/doxygen/files/use-native-doxygen.patch
@@ -0,0 +1,39 @@
+This patch is applied only when cross building. It makes sure that the native
+version of doxygen is used for documentation generation and not the freshly built
+one (which cannot be executed on host).
+--- a/doc/CMakeLists.txt
++++ b/doc/CMakeLists.txt
+@@ -21,13 +21,9 @@
+ find_program(MAKEINDEX NAMES makeindex )
+ include(GNUInstallDirs)
+
+-if (doxygen_BINARY_DIR)
+- set(DOXYGEN_EXECUTABLE ${doxygen_BINARY_DIR}/bin/doxygen)
+-else()
+ # when building only the doxygen_doc, from the doc/ directory, the
+ # doxygen project variables are unknown so look for doxygen in PATH
+ find_package(Doxygen)
+-endif()
+
+ set(DOC_INSTALL_DIR "share/doc/packages/doxygen" CACHE STRING "Relative path where to install the documentation")
+ set(DOC_FILES
+--- a/examples/CMakeLists.txt
++++ b/examples/CMakeLists.txt
+@@ -62,6 +62,8 @@
+ EXAMPLE_manual EXAMPLE_mux
+ )
+
++find_package(Doxygen)
++
+ foreach (f_inp ${BASIC_EXAMPLES})
+ list(LENGTH ${f_inp} f_len)
+ list(GET ${f_inp} 0 f)
+@@ -74,7 +76,7 @@
+ add_custom_command(
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/html/examples/${f}
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/latex/examples/${f}
+- COMMAND ${CMAKE_COMMAND} -E env PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR} ${EXECUTABLE_OUTPUT_PATH}/doxygen ${f}.cfg
++ COMMAND ${CMAKE_COMMAND} -E env PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR} ${DOXYGEN_EXECUTABLE} ${f}.cfg
+ COMMAND ${PYTHON_EXECUTABLE} ${TOP}/examples/strip_example.py < ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman.tex > ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman_doc.tex
+ DEPENDS doxygen ${f}.${f_ext} ${f}.cfg ${TOP}/examples/strip_example.py ${f_dep}
+ OUTPUT ${PROJECT_BINARY_DIR}/html/examples/${f}/html/index.html ${PROJECT_BINARY_DIR}/latex/examples/${f}/latex/refman_doc.tex
diff --git a/srcpkgs/doxygen/template b/srcpkgs/doxygen/template
index f627aa84027bb..46378ec8131a2 100644
--- a/srcpkgs/doxygen/template
+++ b/srcpkgs/doxygen/template
@@ -3,15 +3,22 @@ pkgname=doxygen
version=1.9.7
revision=1
build_style=cmake
-hostmakedepends="perl python3 flex"
+configure_args="-Dbuild_doc=ON"
+hostmakedepends="perl python3 flex texlive-ConTeXt texlive-latexextra
+ texlive-dvi"
checkdepends="libxml2 texlive-BibTeX"
short_desc="Source code documentation generator tool"
maintainer="Érico Nogueira <ericonr@disroot.org>"
license="GPL-2.0-only"
homepage="http://www.doxygen.org/"
changelog="https://www.doxygen.nl/manual/changelog.html"
-distfiles="http://doxygen.nl/files/doxygen-${version}.src.tar.gz"
-checksum=87007641c38e2c392c8596f36711eb97633b984c8430f389e7bcf6323a098d94
+# This archive contains few fixes. Next update must remove .repack
+distfiles="https://doxygen.nl/files/doxygen-${version}.repack.src.tar.gz"
+checksum=aa9b2118578f4d277954c8584eb7228be47cdf29e8041ce4dcba21e41dfb89f3
+
+if [ "$CROSS_BUILD" ]; then
+ hostmakedepends+=" doxygen"
+fi
build_options="wizard"
desc_option_wizard="build Qt5 GUI configuration tool, doxywizard"
@@ -25,9 +32,34 @@ if [ "$build_option_wizard" ]; then
makedepends+=" qt5-devel"
fi
+# Use the host doxygen when building documentation on cross.
+do_patch() {
+ if [ "$CROSS_BUILD" ]; then
+ patch -Np1 < ${FILESDIR}/use-native-doxygen.patch
+ fi
+}
+
+post_build() {
+ ninja -C build docs
+}
+
post_install() {
- vman doc/doxygen.1
- if [ "$build_option_wizard" ]; then
- vman doc/doxywizard.1
+ if [ ! "$build_option_wizard" ]; then
+ rm ${DESTDIR}/usr/share/man/man1/doxywizard.1
fi
+
+ # These manpages are generated because build_doc is ON, but we don't
+ # build these programs.
+ rm ${DESTDIR}/usr/share/man/man1/doxyindexer.1
+ rm ${DESTDIR}/usr/share/man/man1/doxysearch.1
+
+ mv ${DESTDIR}/usr/share/doc/packages/doxygen ${DESTDIR}/usr/share/doc/doxygen
+}
+
+doxygen-doc_package() {
+ short_desc+=" - documentation"
+ depends="${sourcepkg}>=${version}_${revision}"
+ pkg_install() {
+ vmove usr/share/doc/doxygen
+ }
}
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: doxygen: add documentation
2023-05-25 17:58 [PR PATCH] doxygen: add documentation meator
` (6 preceding siblings ...)
2023-07-30 14:21 ` meator
@ 2023-10-29 1:45 ` github-actions
2023-11-12 1:46 ` [PR PATCH] [Closed]: " github-actions
8 siblings, 0 replies; 10+ messages in thread
From: github-actions @ 2023-10-29 1:45 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 305 bytes --]
New comment by github-actions[bot] on void-packages repository
https://github.com/void-linux/void-packages/pull/44079#issuecomment-1783973010
Comment:
Pull Requests become stale 90 days after last activity and are closed 14 days after that. If this pull request is still relevant bump it or assign it.
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PR PATCH] [Closed]: doxygen: add documentation
2023-05-25 17:58 [PR PATCH] doxygen: add documentation meator
` (7 preceding siblings ...)
2023-10-29 1:45 ` doxygen: " github-actions
@ 2023-11-12 1:46 ` github-actions
8 siblings, 0 replies; 10+ messages in thread
From: github-actions @ 2023-11-12 1:46 UTC (permalink / raw)
To: ml
[-- Attachment #1: Type: text/plain, Size: 339 bytes --]
There's a closed pull request on the void-packages repository
doxygen: add documentation
https://github.com/void-linux/void-packages/pull/44079
Description:
<!-- Uncomment relevant sections and delete options which are not applicable -->
CC maintainer @ericonr
#### Testing the changes
- I tested the changes in this PR: **YES**
^ permalink raw reply [flat|nested] 10+ messages in thread
end of thread, other threads:[~2023-11-12 1:46 UTC | newest]
Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-05-25 17:58 [PR PATCH] doxygen: add documentation meator
2023-05-25 18:29 ` meator
2023-05-27 16:34 ` meator
2023-05-27 18:26 ` [PR PATCH] [Updated] " meator
2023-05-31 11:23 ` [PR PATCH] [Updated] doxygen: update + " meator
2023-05-31 11:26 ` meator
2023-05-31 11:26 ` meator
2023-07-30 14:21 ` meator
2023-10-29 1:45 ` doxygen: " github-actions
2023-11-12 1:46 ` [PR PATCH] [Closed]: " github-actions
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).