On Sat, 31 May 2025 00:55:49 -0400 syzygial <syzygial....@gmail.com> wrote:
Thanks so much! I have a first draft here
https://mentors.debian.net/package/sol2/ . I would definitely
appreciate a review and/or sponsorship
Hello Syzygial,
Thanks for working on this. Just a few comments as a feedback.
- The revision shouldn't have been set to 3.5.0-2, as the package was never
uploaded to unstable. Even though this is your second upload here, it still
remains 3.5.0-1 for Debian. Please include only one changelog entry for
this case.
- In the debian/control file, for both binary packages, adding a Multi-Arch
hint is advisable.
See: https://wiki.debian.org/MultiArch/Hints#Multi-Arch:_foreign_library
- The installation of the Sphinx documentation should go into
/usr/share/doc/sol2-doc/html/, so html/ and not sphinx/
- Also when investigating the .deb file of the doc package, under _static
you can see that you're pointing to files provided by libjs-sphinxdoc.
But you're missing a dependency on that.
To fix both these points, the below changes would need to be applied
diff --git a/debian/control b/debian/control
index 723926a..35cef43 100644
--- a/debian/control
+++ b/debian/control
@@ -5,6 +5,7 @@ Maintainer: syzygial <syzygial....@gmail.com>
Rules-Requires-Root: no
Build-Depends:
debhelper-compat (= 13),
+ dh-sequence-sphinxdoc,
cmake (>= 3.26.0),
liblua5.4-dev <!nocheck> | liblua5.3-dev <!nocheck> | liblua5.2-dev <!nocheck> |
liblua5.1-dev <!nocheck>,
libcatch2-dev <!nocheck>,
@@ -35,7 +36,8 @@ Build-Profiles: <!nodoc>
Section: doc
Architecture: all
Depends:
- ${misc:Depends}
+ ${misc:Depends},
+ ${sphinxdoc:Depends},
Description: Sol2 Documentation
Sol2 is a header-only C++ library which facilitates C++/Lua
interoperability.
diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt
index 1c7b675..141ddd2 100644
--- a/documentation/CMakeLists.txt
+++ b/documentation/CMakeLists.txt
@@ -51,7 +51,7 @@ set(SOL2_DOXYGEN_INDEX_FILE
${SOL2_DOXYGEN_XML_OUTPUT_DIR}/index.xml)
set(SOL2_DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
set(SOL2_DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
set(SOL2_SPHINX_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/source)
-set(SOL2_SPHINX_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/sphinx)
+set(SOL2_SPHINX_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/html)
# Get all Sphinx source files
file(GLOB_RECURSE sol2_sphinx_sources
The changes in documentation/CMakeLists.txt need a patch within the patch queue.
If you follow my suggestion, you'll need to edit other related sequencer files
too.
- While not a major issue, is there a reason you set urgency=low in the
changelog?
The default expectation for uploads to unstable is urgency=medium.
low is more appropriate when changes are large or potentially disruptive
in unexpected ways, and it delays migration to testing to 10 days instead
of the usual 5 for medium.
Reference:
https://www.debian.org/doc/manuals/developers-reference/best-pkging-practices.en.html#selecting-the-upload-urgency
- Consider making the upstream tests runnable as autopkgtests.
Since we're now in the hard freeze and this package won’t be in trixie,
there’s time to work on that if you're interested.
Best,
Enkelena
