Felix,
Preamble...
Thank you for taking the time to prepare this package and your contribution to the Debian project.
This review is offered to help package contributors to Debian mentors improve their packages (where needed) prior to possible sponsorship into Debian by a Debian Developer.
Review...
1. Build:
* pbuilder [1]: Good
* sbuild [2]: Good
2. Lintian [3]: Information only. Minor trailing whitespace
Running lintian...
N:
I: golang-github-olareg-olareg-dev: package-contains-documentation-outside-usr-share-doc [usr/share/gocode/src/github.com/olareg/olareg/testdata/.wh.layer2.txt]
N:
N: This package ships a documentation file outside /usr/share/doc
N: Documentation files are normally installed inside /usr/share/doc.
N:
N: If this file doesn't describe the contents or purpose of the directory it
N: is in, please consider moving this file to /usr/share/doc/ or maybe even
N: removing it. If this file does describe the contents or purpose of the
N: directory it is in, please add a lintian override.
N:
N: Visibility: info
N: Show-Always: no
N: Check: documentation
N:
N: Screen: python/egg/metadata
N: Advocates: "Scott Kitterman" <debian@kitterman.com>
N: Reason: The folders XXX.dist-info/ and XXX.egg-info/ hold metadata for
N: Python modules. Those files are not documentation even though
N: some of their names carry the .txt file extension.
N:
N: Python modules can be both public and private.
N:
N: Read more in
N: https://www.python.org/dev/peps/pep-0427/#the-dist-info-directory,
N: https://www.python.org/dev/peps/pep-0376/#id16,
N: https://www.python.org/dev/peps/pep-0610/,
N: https://www.python.org/dev/peps/pep-0639/,
N: https://setuptools.pypa.io/en/latest/deprecated/python_eggs.html,
N: and Bug#1003913.
N:
N:
I: golang-github-olareg-olareg-dev: package-contains-documentation-outside-usr-share-doc [usr/share/gocode/src/github.com/olareg/olareg/testdata/base-a.txt]
N:
I: golang-github-olareg-olareg-dev: package-contains-documentation-outside-usr-share-doc [usr/share/gocode/src/github.com/olareg/olareg/testdata/base-b.txt]
N:
I: golang-github-olareg-olareg-dev: package-contains-documentation-outside-usr-share-doc [usr/share/gocode/src/github.com/olareg/olareg/testdata/layer1.txt]
N:
I: golang-github-olareg-olareg-dev: package-contains-documentation-outside-usr-share-doc [usr/share/gocode/src/github.com/olareg/olareg/testdata/layer2.txt]
N:
I: golang-github-olareg-olareg-dev: package-contains-documentation-outside-usr-share-doc [usr/share/gocode/src/github.com/olareg/olareg/testdata/layer3.txt]
N:
I: olareg: spelling-error-in-binary octects octets [usr/bin/olareg]
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:
N:
I: olareg: spelling-error-in-binary wtH with [usr/bin/olareg]
N:
P: golang-github-olareg-olareg-dev: repeated-path-segment olareg [usr/share/gocode/src/github.com/olareg/olareg/]
N:
N: The file is installed into a location that repeats the given path segment.
N: An example would be /usr/lib/lib or /usr/share/myprogram/share.
N:
N: More often than not this is unintended.
N:
N: Please refer to Bug#950052 and Bug#950027 for details.
N:
N: Visibility: pedantic
N: Show-Always: no
N: Check: files/hierarchy/path-segments
N:
N:
P: golang-github-olareg-olareg-dev: repeated-path-segment olareg [usr/share/gocode/src/github.com/olareg/olareg/cmd/olareg/]
N:
P: golang-github-olareg-olareg source: trailing-whitespace [debian/rules:16]
N:
N: This file contains lines with trailing whitespace characters.
N:
N: Whilst often harmless and unsightly, such extra whitespaces can also cause
N: tools to interpret the whitespace characters literally. The tool diff(1)
N: does not like them, either. They are best avoided.
N:
N: Some of these problems can be hard to track down.
N:
N: Whitespace at the end of lines may be removed with the following:
N:
N: $ sed -i -e 's@[[:space:]]*$@@g' debian/control debian/changelog
N:
N: If you use Emacs, you can also use "M-x wh-cl" (whitespace-cleanup).
N:
N: However, if you wish to only remove trailing spaces and leave trailing
N: tabs (eg. for Makefiles), you can use the following code snippet:
N:
N: $ sed -i -e 's@[ ]*$@@g' debian/rules
N:
N: To remove empty lines from the end of a file, you can use:
N:
N: $ sed -i -e :a -e '/^\n*$/{$d;N;};/\n$/ba' debian/rules
N:
N: Visibility: pedantic
N: Show-Always: no
N: Check: debian/trailing-whitespace
N: Renamed from: file-contains-trailing-whitespace
N:
I: Lintian run was successful.
3. Licenses [4]: Good
4. Watch file [uscan --force-download]: Good
5. Build Twice (build source after successful build) [1]: Good
6. Reproducible builds [5]: Good
Note: This test does not block sponsorship and is for information only at this time. It is good if a package passes this test.
7. Tail of the ratt (architecture dependant packages only) [6]: Good
Note: This test does not block sponsorship and is for information only at this time. It is good if a package passes this test.
philwyett@ks-tarkin:~/Development/builder/debian$ ratt --dist trixie golang-github-olareg-olareg_0.1.1-1_amd64.changes
2025/01/28 15:20:53 Loading changes file "golang-github-olareg-olareg_0.1.1-1_amd64.changes"
2025/01/28 15:20:53 - 3 binary packages: golang-github-olareg-olareg-dev olareg olareg-dbgsym
2025/01/28 15:20:53 Corresponding .debs (will be injected when building):
2025/01/28 15:20:53 golang-github-olareg-olareg-dev_0.1.1-1_all.deb
2025/01/28 15:20:53 olareg-dbgsym_0.1.1-1_amd64.deb
2025/01/28 15:20:53 olareg_0.1.1-1_amd64.deb
2025/01/28 15:20:54 Figuring out reverse build dependencies using dose-ceve(1). This might take a while
2025/01/28 15:21:45 Found 0 reverse build dependencies
2025/01/28 15:21:45 Setting -sbuild_dist=unstable (from .changes file)
2025/01/28 15:21:45 Build results:
8. Install [No previous installs]: Good
9. Upgrade [Over previous installs if any]: N/A
Summary...
I believe 'golang-github-olareg-olareg' is ready for review/possible sponsorship.
If you do not have upload rights or a regular sponsor. You can follow the RFS process linked to below.
https://mentors.debian.net/sponsors/rfs-howto/
Please try the below on your packages...
[1] pbuilder:
* Command for 1.: sudo pbuilder build <PACKAGE>.dsc
* Command for 5.: sudo pbuilder build --twice <PACKAGE>.dsc
* Document: https://wiki.ubuntu.com/PbuilderHowto.
* Document: https://wiki.debian.org/PbuilderTricks
[2] sbuild:
* Command: sbuild -d unstable <PACKAGE>.dsc
* Document: https://wiki.debian.org/sbuild
[3] lintian:
* Command: lintian --display-info --verbose --fail-on error --info --pedantic --show-overrides (*.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
Note: Please report false positives as bug reports against '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
[6] ratt
* Command: ratt --dist=<YOUR_DISTRIBUTION> <PACKAGE>_<VERSION>-<DEBIAN_REVISION>_<ARCHITECTURE>.changes
* Document: https://manpages.debian.org/unstable/ratt/ratt.1.en.html
Regards
Phil
Ready
Phil Wyett at Jan. 28, 2025, 3:27 p.m.
