Bug#1085943: RFS: qatzip -- Compression Library accelerated by Intel® QuickAssist Technology

[Soren Stoutner]

Colin,

Hi Philip,
Thanks for this review. I'd like to keep to the two last lines in the
debian changelog as an intentional aide-mémoire to remind me to ensure
the spelling mistake patch gets landed in the upstream project and also
get the upstream project to handle build cleaning before the next
release. I handle quite a few packages and keeping track of these
packaging details requires me to note what needs doing between each
upload and upstream fixes before the next release occurs.

I appreciate that you have developed a workflow that works for you, but in this
case Debian is pretty specific that the changelog should just include Debian
changes, and that the first changelog should only contain a single line
(because nothing is changing in comparison to a previous Debian release). I
would recommend you somehow change your workflow to keep track of these things
separately.

[Colin King (gmail)]

Post by Soren Stoutner
Colin,

Hi Philip,
Thanks for this review. I'd like to keep to the two last lines in the
debian changelog as an intentional aide-mémoire to remind me to ensure
the spelling mistake patch gets landed in the upstream project and also
get the upstream project to handle build cleaning before the next
release. I handle quite a few packages and keeping track of these
packaging details requires me to note what needs doing between each
upload and upstream fixes before the next release occurs.

I appreciate that you have developed a workflow that works for you, but in this
case Debian is pretty specific that the changelog should just include Debian
changes, and that the first changelog should only contain a single line
(because nothing is changing in comparison to a previous Debian release). I
would recommend you somehow change your workflow to keep track of these things
separately.

Good point, I'll remove the lines and re-upload. :-)

Colin

[Colin King (gmail)]

I've uploaded to mentors a re-worked changelog, I think I just need some
kind DD to upload this now.

Kind regards,

Colin

Post by Soren Stoutner
Colin,

Hi Philip,
Thanks for this review. I'd like to keep to the two last lines in the
debian changelog as an intentional aide-mémoire to remind me to ensure
the spelling mistake patch gets landed in the upstream project and also
get the upstream project to handle build cleaning before the next
release. I handle quite a few packages and keeping track of these
packaging details requires me to note what needs doing between each
upload and upstream fixes before the next release occurs.

I appreciate that you have developed a workflow that works for you, but in this
case Debian is pretty specific that the changelog should just include Debian
changes, and that the first changelog should only contain a single line
(because nothing is changing in comparison to a previous Debian release). I
would recommend you somehow change your workflow to keep track of these things
separately.

[Soren Stoutner]

Colin,

Seeing as how you were kind enough to follow my advice, I will return the
favor by review your packages on Mentors, starting with this one.

It doesn’t look like you currently have your packing hosted in a Git
repository (or, at least, it isn’t indicated in a VCS field). I always require
building from Git when sponsoring a package. Although you can host it
anywhere you like, I highly recommend you host it on Salsa (which has a lot of
cool integrations with the rest of the Debian infrastructure, including
automatic CI that you can enable).

https://salsa.debian.org/

If there isn’t an existing group that would make sense for this package, you
can either place it in the Debian group (which makes it easy for any Debian
Developer to help with the package maintenance, or place it under your own
name). If you would like to host it in the Debian group, just let me know
your Salsa username and I can create the repository and give you permissions
to upload to it.

[Soren Stoutner]

Hi Soren,
Thanks for offering to sponsor this package. However, is having
packaging hosted in a Git repo necessary for getting the package
sponsored? Although it's a nice to do thing, I've had 24 other packages
sponsored without this requirement in the past.

No, it is not a requirement of Debian. However, it is a personal requirement
for any package I sponsor, because it makes collaborative development so much
easier (including things like NMUs). I could write a long description of why,
and would be happy to do so if anyone has any questions. Otherwise, I might
simply point out that there are various discussions about making it either
highly recommended for Debian contributions or mandatory (with some strenuous
pushback by some Debian Developers, because, of course, the is Debian, and
people have strong feelings about their workflows), and some Debian teams do
make it mandatory. For example, see:

https://lists.debian.org/debian-devel/2024/08/msg00433.html

https://salsa.debian.org/python-team/tools/python-modules/blob/master/
policy.rst

Are there any specific instructions on how to host the packaging in Salsa?

Let me offer you two recommendations. I will sponsor your packages even if you
choose not to use these, but my personal experience is that they make your
life as a packager so much better that I often recommend them to people.

1. Use gbp (Git-Buildpackage) to manage the packaging repository. Wrapping
your mind around gpb takes a little bit of work. I would offer you two links.
One is a basic explanation I wrote previously on Debian Mentors:

https://lists.debian.org/debian-mentors/2024/09/msg00057.html

The second is the link to the official wiki page:

https://wiki.debian.org/PackagingWithGit

2. Enable the default Salsa CI.

To do so, follow the TL;DR instructions at:

https://salsa.debian.org/salsa-ci-team/pipeline#basic-use

[Soren Stoutner]

Control: owner -1 !

Post by Colin King (gmail)
I've uploaded to mentors a re-worked changelog, I think I just need some
kind DD to upload this now.

Colin,

Seeing as how you were kind enough to follow my advice, I will return the
favor by review your packages on Mentors, starting with this one.

[Soren Stoutner]

Hi,
I made the appropriate changes as requested and I'm still waiting for a
DD to sponsor this, is it possible for somebody to do this as it's been
waiting now for a few months.
Colin

As mentioned previously, I will be happy to take a look at it if you host the
packaging repository on Salsa. If not, there are probably some Debian
Developers who will be willing to take a look at it otherwise.

[Soren Stoutner]

Hi Soren,
I've pushed it to Salsa,
https://salsa.debian.org/ColinKing/qatzip
This is my first attempt at using Salsa for this kind of upload process,
so I hope I did everything OK.

I am not able to access it. Did you perhaps set it to be private instead of
public?

[Soren Stoutner]

Colin,

Post by Soren Stoutner
I am not able to access it. Did you perhaps set it to be private instead of
public?

My bad, I've flipped it to public now.

This looks to be in pretty good shape. I have just a few small things you
should look at before I sponsor the upload.

1. Some of the files are dual licensed. These need to be reflected in debian/
copyright. I spot checked a few of these but not all of them. Sometimes lrc
has false positives, so don’t worry if these hints are wrong for a few files.

$ lrc
en: Versions: recon 3.3 check 3.3.9-1

Parsing Source Tree ....
Reading d/copyright ....
Running licensecheck ....

d/copyright | licensecheck

BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_process_opt/4xxx_dev0.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_process_opt/4xxx_dev1.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_process_opt/4xxx_dev2.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_process_opt/4xxx_dev3.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_process_opt/4xxx_dev4.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_process_opt/4xxx_dev5.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_process_opt/4xxx_dev6.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_process_opt/4xxx_dev7.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_thread_opt/4xxx_dev0.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_thread_opt/4xxx_dev1.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_thread_opt/4xxx_dev2.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_thread_opt/4xxx_dev3.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_thread_opt/4xxx_dev4.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_thread_opt/4xxx_dev5.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_thread_opt/4xxx_dev6.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/4xxx/
multiple_thread_opt/4xxx_dev7.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/c3xxx/
multiple_process_opt/c3xxx_dev0.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/c3xxx/
multiple_thread_opt/c3xxx_dev0.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/c6xx/
multiple_process_opt/c6xx_dev0.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/c6xx/
multiple_process_opt/c6xx_dev1.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/c6xx/
multiple_process_opt/c6xx_dev2.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/c6xx/
multiple_thread_opt/c6xx_dev0.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/c6xx/
multiple_thread_opt/c6xx_dev1.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/c6xx/
multiple_thread_opt/c6xx_dev2.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/dh895xcc/
multiple_process_opt/dh895xcc_dev0.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 config_file/dh895xcc/
multiple_thread_opt/dh895xcc_dev0.conf
BSD-3-Clause | GPL-2 config_file/LICENSE.GPL
BSD-3-Clause | BSD-2-clause LICENSE.LZ4
BSD-3-Clause | BSD-2-clause LICENSE.XXHASH
BSD-3-Clause | Zlib LICENSE.ZLIB
MIT | Expat qatzip.spec.in
BSD-3-Clause | BSD-2-clause and/or BSD-3-clause src/xxhash.c
BSD-3-Clause | BSD-2-clause and/or BSD-3-clause src/xxhash.h
BSD-3-Clause | BSD-3-clause and/or GPL-2 test/performance_tests/config_file/
4xxx/4xxx_dev0.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 test/performance_tests/config_file/
4xxx/4xxx_dev1.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 test/performance_tests/config_file/
4xxx/4xxx_dev2.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 test/performance_tests/config_file/
4xxx/4xxx_dev3.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 test/performance_tests/config_file/
4xxx/4xxx_dev4.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 test/performance_tests/config_file/
4xxx/4xxx_dev5.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 test/performance_tests/config_file/
4xxx/4xxx_dev6.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 test/performance_tests/config_file/
4xxx/4xxx_dev7.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 test/performance_tests/config_file/
c3xxx/c3xxx_dev0.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 test/performance_tests/config_file/
c6xx/c6xx_dev0.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 test/performance_tests/config_file/
c6xx/c6xx_dev1.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 test/performance_tests/config_file/
c6xx/c6xx_dev2.conf
BSD-3-Clause | BSD-3-clause and/or GPL-2 test/performance_tests/config_file/
dh895xcc/dh895xcc_dev0.conf


2. You should add a debian/upstream/metadata file. There are a number of
possible fields. You only need to add the ones that make sense for this
project. Here is an example:

https://salsa.debian.org/soren/privacybrowser/-/blob/master/debian/upstream/
metadata?ref_type=heads

3. Because you are making the above changes, you should update the date in
the changelog and the year for debian/* in debian/copyright. For the
changelog, you can update it automatically by running `dch -r`.

4. I see that the upstream ships some tests. You might want to configure
autopkgtests to run them. Doing this isn’t necessary for me to sponsor this
upload, but it is probably something you want to look at for a future release.

5. You might consider setting up Salsa CI by following the instructions at:

https://salsa.debian.org/salsa-ci-team/pipeline

This isn’t necessary for me to sponsor your package, but I think you will find
it makes your job as a packager easier.

Shoot me an email when you have addressed points 1-3.