Bug 2256466 - Review Request: kf6-kapidox - KDE Frameworks 6 Tier 4 scripts and data for building API documentation
Summary: Review Request: kf6-kapidox - KDE Frameworks 6 Tier 4 scripts and data for bu...
Keywords:
Status: CLOSED DUPLICATE of bug 2256766
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Nobody's working on this, feel free to take it
QA Contact: Fedora Extras Quality Assurance
URL: https://invent.kde.org/frameworks/%{f...
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2024-01-02 13:16 UTC by loise@kde.org
Modified: 2024-01-04 12:32 UTC (History)
4 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2024-01-04 12:32:47 UTC
Type: ---
Embargoed:


Attachments (Terms of Use)
The .spec file difference from Copr build 6848301 to 6848302 (706 bytes, patch)
2024-01-02 15:14 UTC, Fedora Review Service
no flags Details | Diff

Description loise@kde.org 2024-01-02 13:16:59 UTC
Spec URL: https://download.copr.fedorainfracloud.org/results/loise/kf6-API/fedora-rawhide-x86_64/06847948-kf6-kapidox/kf6-kapidox.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/loise/kf6-API/fedora-rawhide-x86_64/06847948-kf6-kapidox/kf6-kapidox-5.247.0-1.fc40.src.rpm
Description: KDE Frameworks 6 Tier 4 scripts and data for building API documentation
Fedora Account System Username: loise

Comment 1 loise@kde.org 2024-01-02 13:21:10 UTC
I've made a copr and now adding doc packages to KF6, starting with an experiment on kf6-bluez-qt which gave the desired results.

I can install kf6-bluez-qt-doc and it automatically shows up in Qt Creator for me.

The thing missing will be the cross-links later to the Qt documentation as there is none yet in Fedora for Qt6 (which is another item on my todo)

If the package is accepted and available, I want to add the changes to the KF6 packages adding a doc package for each one to be done (already doing so for later use and testing)

Comment 2 loise@kde.org 2024-01-02 13:26:09 UTC
https://copr.fedorainfracloud.org/coprs/loise/kf6-API/builds/

kf6-bluez-qt as first example here:

https://copr.fedorainfracloud.org/coprs/loise/kf6-API/build/6847952/

SPEC file: https://download.copr.fedorainfracloud.org/results/loise/kf6-API/fedora-rawhide-x86_64/06847952-kf6-bluez-qt/kf6-bluez-qt.spec

So, basically all kf6 packages need following additons:

BuildRequires:  kf6-kapidox
+ BuildRequires: kf6-*-doc where the accoring dependencies have QCH files for crosslinks

%package        doc
Summary:        Developer Documentation files for %{name}
%description    doc
Developer Documentation files for %{name} for use with KDevelop or QtCreator.

 %{cmake_kf6} \
  -DBUILD_QCH:BOOL=ON \

%files doc
%{_qt6_docdir}/KF6BluezQt.qch
%{_qt6_docdir}/KF6BluezQt.tags

where * would last.

Comment 4 Steve Cossette 2024-01-02 15:06:26 UTC
1- Remove all build requirements except for python3-devel and kf6-filesystem (kf6-rpm-macros is included in that, thus not needed here either)

2- Add the following build requirements, used for the import test:
# Test dependencies:
BuildRequires: python3dist(pytest)
BuildRequires: python3dist(gv)

3- Add the following right after the %prep section, per https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/:

%generate_buildrequires
%pyproject_buildrequires

4- %build section should only contain:
%pyproject_wheel

5- %install section should only contain the following:
%pyproject_install
%pyproject_save_files kapidox

6- Some tests should be added in %check. Seems the meager test(s) in this package dont really work with %tox or %pytest, and the test script itself don't run with python. So we basically can only do an import test. Add a %check section, and add this in it:
%pyproject_check_import

7- Change %files to:
%files -f %{pyproject_files}

8- Remove the following from %files:
%{python3_sitelib}/kapidox
%{python3_sitelib}/kapidox-%{version}-py*.egg-info

9- Change licensing to SPDX:
BSD-2-Clause AND CC0-1.0 AND LGPL-3.0-or-later

That should do it.

Comment 5 Fedora Review Service 2024-01-02 15:12:28 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/6848301
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2256466-kf6-kapidox/fedora-rawhide-x86_64/06848301-kf6-kapidox/fedora-review/review.txt

Please take a look if any issues were found.


---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 6 Fedora Review Service 2024-01-02 15:14:35 UTC
Created attachment 2006848 [details]
The .spec file difference from Copr build 6848301 to 6848302

Comment 7 Fedora Review Service 2024-01-02 15:14:37 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/6848302
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2256466-kf6-kapidox/fedora-rawhide-x86_64/06848302-kf6-kapidox/fedora-review/review.txt

Please take a look if any issues were found.


---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 8 Steve Cossette 2024-01-04 12:00:24 UTC
After speaking with Loise about this, I'll be taking over this review.

Comment 9 Steve Cossette 2024-01-04 12:17:10 UTC
Spec URL: https://farchord.fedorapeople.org/reviews/kf6-kapidox/kf6-kapidox.spec
SRPM URL: https://farchord.fedorapeople.org/reviews/kf6-kapidox/kf6-kapidox-5.247.0-1.fc40.src.rpm

Updated spec with Fedora packaging directives' instructions

Comment 10 Steve Cossette 2024-01-04 12:32:47 UTC

*** This bug has been marked as a duplicate of bug 2256766 ***


Note You need to log in before you can comment on or make changes to this bug.