Sign me up Login

Details about package qatlib

Name: qatlib
Uploader: ColinKing <colin.i.king@gmail.com> (Debian QA page)
Description: libqat4 - Intel QuickAssist user space library
libqat-dev - Development files for Intel QuickAssist user space library
libusdm0 - User space DMAable Memory (UDSM) library
libusdm-dev - Development files for Intel QuickAssist user space DMA library
qatlib-service - Intel QuickAssist daemon
qatlib-examples - Intel QuickAssist user space library examples

Package uploads

Upload #1

Information

Version: 24.02.0-2
Uploaded: 2024-08-12 16:24
Source package: qatlib_24.02.0-2.dsc
Distribution: unstable
Section: devel
Priority: optional
Homepage: https://github.com/intel/qatlib

Changelog

 qatlib (24.02.0-2) unstable; urgency=medium
 .
   * Add man page for cpa_sample_code and only ship this one essential
     example
   * Fix spelling mistake "suppported" -> "supported" in lac_ecsm2.c
   * Rename qat_init.sh to qat_init and fix up man page for this rename

QA information

Comments

  1. Colin,

Preamble...

Thank you for taking the time to prepare this package and your contribution to the Debian project.

The review below is for assistance. This review is offered to help package submitters to Debian mentors inorder to improve their packages prior to possible sponsorship into Debian. There is no obligation on behalf of the submitter to make any alterations based upon information provided in the review.

Review...

1. Build:

  * pbuilder [1]: Good
  * sbuild [2]: Good

2. Lintian [3]: Issue, false positives are possible

Running lintian...
N:
E: qatlib-service: aliased-location [lib/]
N: 
N:   This package installs files into an aliased location and should not be
N:   doing so.
N:   
N:   Since Debian Trixie, the base-files package sets up symbolic links such as
N:   /bin pointing to usr/bin. Installing files in /bin directly thus triggers
N:   undefined behaviour in dpkg.
N:   
N:   Packages must no longer install files into such locations and must install
N:   them to the corresponding location under usr/ instead.
N: 
N:   Please refer to Binaries (Section 10.1) in the Debian Policy Manual and
N:   Bug#1074014 for details.
N: 
N:   Visibility: error
N:   Show-Always: no
N:   Check: files/hierarchy/standard
N: 
N:
E: qatlib-service: aliased-location [lib/systemd/]
N:
E: qatlib-service: aliased-location [lib/systemd/system/]
N:
E: qatlib-service: aliased-location [lib/systemd/system/qat.service]
N:
W: qatlib-examples: groff-message an.tmac:<standard input>:38: warning: tbl preprocessor failed, or it or soelim was not run; table(s) likely not rendered (TE macro called with TW register undefined) [usr/share/man/man7/cpa_sample_code.7.gz:1]
N: 
N:   A manual page provoked warnings or errors from the man program. Here are
N:   some common ones:
N:   
N:   "cannot adjust" or "can't break" are issues with paragraph filling. They
N:   are usually related to long lines. Justifying text on the left hand side
N:   can help with adjustments. Hyphenation can help with breaks.
N:   
N:   For more information, please see "Manipulating Filling and Adjusting" and
N:   "Manipulating Hyphenation" in the Groff manual (see info groff).
N:   
N:   "can't find numbered character" usually means that the input was in a
N:   national legacy encoding. The warning means that some characters were
N:   dropped. Please use escapes such as \[:a] as described on the groff_char
N:   manual page.
N:   
N:   Other common warnings are formatting typos. String arguments to .IP
N:   require quotes. Usually, some text is lost or mangled. See the groff_man
N:   (or groff_mdoc if using mdoc) manual page for details on macros.
N:   
N:   The check for manual pages uses the --warnings option to man to catch
N:   common problems, like a . or a ' at the beginning of a line as literal
N:   text. They are interpreted as Groff commands. Just reformat the paragraph
N:   so the characters are not at the beginning of a line. You can also add a
N:   zero-width space (\&) in front of them.
N:   
N:   Aside from overrides, warnings can be disabled with the .warn directive.
N:   Please see "Debugging" in the Groff manual.
N:   
N:   You can see the warnings yourself by running the command used by Lintian:
N:   
N:       LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 \
N:           man --warnings -E UTF-8 -l -Tutf8 -Z <file> >/dev/null
N: 
N:   Please refer to the groff_man(7) manual page and the groff_mdoc(7) manual
N:   page for details.
N: 
N:   Visibility: warning
N:   Show-Always: no
N:   Check: documentation/manual
N:   Renamed from: manpage-has-errors-from-man
N: 
N:
I: qatlib-service: systemd-service-file-missing-documentation-key [lib/systemd/system/qat.service]
N: 
N:   The systemd service file does not contain a Documentation key.
N:   
N:   Documentation for systemd service files can be automatically viewed using
N:   systemctl help servicename if this field is present.
N: 
N:   Please refer to the systemd.unit(5) manual page for details.
N: 
N:   Visibility: info
N:   Show-Always: no
N:   Check: systemd
N: 
N:
O: qatlib-examples: spelling-error-in-binary wtH with [usr/bin/cpa_sample_code]
N: 
N:   Lintian found a spelling error in the given binary. Lintian has a list of
N:   common misspellings that it looks for. It does not have a dictionary like
N:   a spelling checker does.
N:   
N:   If the string containing the spelling error is translated with the help of
N:   gettext or a similar tool, please fix the error in the translations as
N:   well as the English text to avoid making the translations fuzzy. With
N:   gettext, for example, this means you should also fix the spelling mistake
N:   in the corresponding msgids in the *.po files.
N:   
N:   You can often find the word in the source code by running:
N:   
N:    grep -rw <word> <source-tree>
N:   
N:   This tag may produce false positives for words that contain non-ASCII
N:   characters due to limitations in strings.
N: 
N:   Visibility: info
N:   Show-Always: no
N:   Check: binaries/spelling
N: 

E: Lintian run failed (runtime error)

3. Licenses [4]: Good

4. Watch file [uscan --force-download]: Good

5. Build Twice [sudo pbuilder build --twice <package>.dsc]: Good

6. Reproducible builds [5]: Good

7. Install [No previous installs]: Not performed at this time

8. Upgrade [Over previous installs if any]: N/A

Additional...

A. autopkgtest failure

Preparing to unpack .../5-qatlib-service.deb ...
/var/lib/dpkg/tmp.ci/preinst: 7: groupadd: not found
dpkg: error processing archive /tmp/apt-dpkg-install-3VS3GR/5-qatlib-service.deb (--unpack):
 new qatlib-service package pre-installation script subprocess returned error exit status 127
Errors were encountered while processing:
 /tmp/apt-dpkg-install-3VS3GR/5-qatlib-service.deb
E: Sub-process /usr/bin/dpkg returned an error code (1)
E: Failed to process build dependencies
libqat-dev           FAIL badpkg

B. New packages to Debian should have a version that ends '-1'.

C. New packages to Debian should have a changelog entry like below that states the initial release and closes the Intent To Package (ITP) bug report.

qatlib (24.02.0-1) unstable; urgency=medium
 .
   * Initial release. (Closes: #ITP_BUG_NUMBER)

Summary...

Colin, See issues raised. It would be good to have an RFS for this and work on getting all the 'qat*' related packages good for a DD to look at.

Regards

Phil

[1] pbuilder:

  * Command: sudo pbuilder build <PACKAGE>.dsc
  * Document: https://wiki.ubuntu.com/PbuilderHowto.
  * Document: https://wiki.debian.org/PbuilderTricks

[2] sbuild:

  * Command: sbuild <PACKAGE>.dsc
  * Document: https://wiki.debian.org/sbuild

[3] lintian:

  * Command: lintian -v -i -I -E --pedantic --profile debian (*.dsc, *.changes, *.buildinfo). Each can throw up different results, so be thorough.
  * Document: https://wiki.debian.org/Lintian

[4] lrc:

  * Command: lrc
  * Document: https://wiki.debian.org/CopyrightReviewTools#licenserecon

[5] reprotest

  * Command: sudo reprotest --vary=-build_path,domain_host.use_sudo=1 --auto-build <PACKAGE>.dsc -- schroot unstable-amd64-sbuild
  * Document: https://wiki.kathenas.org/pmwiki.php/Kathenas/Article00000004
  * Document: https://wiki.debian.org/ReproducibleBuilds/
  * Document: https://wiki.debian.org/ReproducibleBuilds/Howto#Newer_method
    Needs work Phil Wyett at Dec. 14, 2024, 3:53 a.m.