Bug#1083052: RFS: vimium/2.1.2-1 [ITP] -- keyboard-based navigation and control

[Soren Stoutner]

Control: owner -1 !
Andreas,

I would like to review this package for sponsorship. However, it doesn’t look
like the package repository is correctly documented. I see:

Vcs-Git: https://github.com/philc/vimium.git
Vcs-Browser: https://github.com/philc/vimium

However, these are the upstream repository, not the Debian packaging
repository. If you don’t currently have a Debian packaging repository, I
would recommend you set it up on salsa.debian.org.

Please let me know once the Debian packaging repository is available.

Control: tags -1 +confirmed
Andreas,
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...
* pbuilder [1]: Good
* sbuild [2]: Good
2. Lintian [3]: Information, non blocking
Running lintian...
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-
doc [usr/share/chromium/extensions/vimium/pages/action.html]
N: This package ships a documentation file outside /usr/share/doc
N: Documentation files are normally installed inside /usr/share/doc.
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: Visibility: info
N: Show-Always: no
N: Check: documentation
N: Screen: python/egg/metadata
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: Python modules can be both public and private.
N: Read more in
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/,
https://setuptools.pypa.io/en/latest/deprecated/python_eggs.html,
N: and Bug#1003913.
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-
doc [usr/share/chromium/extensions/vimium/pages/blank.html]
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-
doc [usr/share/chromium/extensions/vimium/pages/completion_engines.html]
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-
doc [usr/share/chromium/extensions/vimium/pages/exclusions.html]
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-
doc [usr/share/chromium/extensions/vimium/pages/help_dialog.html]
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-
doc [usr/share/chromium/extensions/vimium/pages/hud.html]
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-
doc [usr/share/chromium/extensions/vimium/pages/options.html]
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-
doc [usr/share/chromium/extensions/vimium/pages/reload.html]
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-
doc [usr/share/chromium/extensions/vimium/pages/vomnibar.html]
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-
doc [usr/share/chromium/extensions/vimium/resources/tlds.txt]
I: webext-vimium-firefox: package-contains-documentation-outside-usr-share-
doc [usr/share/mozilla/extensions/{ec8030f7-c20a-464f-9b0e-
13a3a9e97384}/{d7742d87-e61d-4b78-b8a1-b469842139fa}/pages/action.html]
I: webext-vimium-firefox: package-contains-documentation-outside-usr-share-
doc [usr/share/mozilla/extensions/{ec8030f7-c20a-464f-9b0e-
13a3a9e97384}/{d7742d87-e61d-4b78-b8a1-b469842139fa}/pages/blank.html]
I: webext-vimium-firefox: package-contains-documentation-outside-usr-share-
doc [usr/share/mozilla/extensions/{ec8030f7-c20a-464f-9b0e-
13a3a9e97384}/{d7742d87-e61d-4b78-b8a1-
b469842139fa}/pages/completion_engines.html]
I: webext-vimium-firefox: package-contains-documentation-outside-usr-share-
doc [usr/share/mozilla/extensions/{ec8030f7-c20a-464f-9b0e-
13a3a9e97384}/{d7742d87-e61d-4b78-b8a1-b469842139fa}/pages/exclusions.html]
I: webext-vimium-firefox: package-contains-documentation-outside-usr-share-
doc [usr/share/mozilla/extensions/{ec8030f7-c20a-464f-9b0e-
13a3a9e97384}/{d7742d87-e61d-4b78-b8a1-b469842139fa}/pages/help_dialog.html]
I: webext-vimium-firefox: package-contains-documentation-outside-usr-share-
doc [usr/share/mozilla/extensions/{ec8030f7-c20a-464f-9b0e-
13a3a9e97384}/{d7742d87-e61d-4b78-b8a1-b469842139fa}/pages/hud.html]
I: webext-vimium-firefox: package-contains-documentation-outside-usr-share-
doc [usr/share/mozilla/extensions/{ec8030f7-c20a-464f-9b0e-
13a3a9e97384}/{d7742d87-e61d-4b78-b8a1-b469842139fa}/pages/options.html]
I: webext-vimium-firefox: package-contains-documentation-outside-usr-share-
doc [usr/share/mozilla/extensions/{ec8030f7-c20a-464f-9b0e-
13a3a9e97384}/{d7742d87-e61d-4b78-b8a1-b469842139fa}/pages/reload.html]
I: webext-vimium-firefox: package-contains-documentation-outside-usr-share-
doc [usr/share/mozilla/extensions/{ec8030f7-c20a-464f-9b0e-
13a3a9e97384}/{d7742d87-e61d-4b78-b8a1-b469842139fa}/pages/vomnibar.html]
I: webext-vimium-firefox: package-contains-documentation-outside-usr-share-
doc [usr/share/mozilla/extensions/{ec8030f7-c20a-464f-9b0e-
13a3a9e97384}/{d7742d87-e61d-4b78-b8a1-b469842139fa}/resources/tlds.txt]
I: Lintian run was successful.
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]: Good
8. Upgrade [Over previous installs if any]: N/A
Summary...
I believe vimium is ready for review/possible sponsorship. Could a Debian
Developer (DD) with available free time, please review this package and
upload if you feel it is ready and appropriate for the distribution.
A DD with interest in browsers would be an advantage for reviewing and
sponsoring this package.
Regards
Phil
* Command: sudo pbuilder build <PACKAGE>.dsc
* Document: https://wiki.ubuntu.com/PbuilderHowto.
* Document: https://wiki.debian.org/PbuilderTricks
* Command: sbuild <PACKAGE>.dsc
* Document: https://wiki.kathenas.org/pmwiki.php/Kathenas/Article00000002
* Document: https://wiki.debian.org/sbuild
* 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
* 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

[Andreas Altergott]

Hi Soren,

On Thursday, 10th Oct 2024 at 15:44:01 -07:00:00 Soren Stoutner

Post by Soren Stoutner
I would like to review this package for sponsorship. However, it
doesn’t look
Vcs-Git: https://github.com/philc/vimium.git
Vcs-Browser: https://github.com/philc/vimium
However, these are the upstream repository, not the Debian packaging
repository. If you don’t currently have a Debian packaging
repository, I
would recommend you set it up on salsa.debian.org.
Please let me know once the Debian packaging repository is available.

Thanks for reviewing the package.

The package has been set up on salsa.debian.org. Vcs-Git and
Vcs-Browser have been updated to the correct URL.
A new build has been uploaded to mentors.debian.net.

Regards,
Andreas

[Soren Stoutner]

Andreas,

Post by Andreas Altergott
The package has been set up on salsa.debian.org. Vcs-Git and
Vcs-Browser have been updated to the correct URL.
A new build has been uploaded to mentors.debian.net.

This package is in really good shape. There are just a few things I think ought to be
addressed before I sponsor it.

1.
There are a number of lintian Info tags about files it thinks are documentation. My sense is
that most or all of these are false positives. If so, please add lintian overrides for them.

I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-doc
[usr/share/chromium/extensions/vimium/pages/action.html]
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" <***@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: webext-vimium-chromium: package-contains-documentation-outside-usr-share-doc
[usr/share/chromium/extensions/vimium/pages/blank.html]
N:
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-doc
[usr/share/chromium/extensions/vimium/pages/completion_engines.html]
N:
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-doc
[usr/share/chromium/extensions/vimium/pages/exclusions.html]
N:
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-doc
[usr/share/chromium/extensions/vimium/pages/help_dialog.html]
N:
I: webext-vimium-chromium: package-contains-documentation-outside-usr-share-doc
[usr/share/chromium/extensions/vimium/pages/hud.html]

[Soren Stoutner]

Andrea,

One further comment I forgot to include below. Your README.Debian file is
superfluous as it doesn’t contain any information that is not in the package
description. I would just remove it if I were you.

Post by Soren Stoutner
Andreas,

Post by Andreas Altergott
The package has been set up on salsa.debian.org. Vcs-Git and
Vcs-Browser have been updated to the correct URL.
A new build has been uploaded to mentors.debian.net.

This package is in really good shape. There are just a few things I think
ought to be addressed before I sponsor it.
1.
There are a number of lintian Info tags about files it thinks are
documentation. My sense is that most or all of these are false positives.
If so, please add lintian overrides for them.
package-contains-documentation-outside-usr-share-doc
[usr/share/chromium/extensions/vimium/pages/action.html]
N: This package ships a documentation file outside /usr/share/doc
N: Documentation files are normally installed inside /usr/share/doc.
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: Visibility: info
N: Show-Always: no
N: Check: documentation
N: Screen: python/egg/metadata
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: Python modules can be both public and private.
N: Read more in
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/,
and Bug#1003913.
package-contains-documentation-outside-usr-share-doc
[usr/share/chromium/extensions/vimium/pages/blank.html]
package-contains-documentation-outside-usr-share-doc
package-contains-documentation-outside-usr-share-doc
[usr/share/chromium/extensions/vimium/pages/exclusions.html]
package-contains-documentation-outside-usr-share-doc
[usr/share/chromium/extensions/vimium/pages/help_dialog.html]
package-contains-documentation-outside-usr-share-doc
[usr/share/chromium/extensions/vimium/pages/hud.html]

[Andreas Altergott]

Hi Soren,

Post by Soren Stoutner
One further comment I forgot to include below. Your README.Debian file is
superfluous as it doesn’t contain any information that is not in
the package
description. I would just remove it if I were you.

Post by Soren Stoutner
This package is in really good shape. There are just a few things I think
ought to be addressed before I sponsor it.

the following changes have been added to the current release.

* Adds lintian override for documentation outside /usr/share/doc.
* Adds Forwarded status for debian/patches/*.
* Refers to Expat license instead of MIT.
* Uses Expat license for easier upstream collaboration in debian/*.
* Removes unnecessary README.Debian file.

Thanks for the hints on the improvements.

I've been struggling with the lintian override for the documentation
outside /usr/share/doc. I was unable to silence this informational
lintian output.
The current override documents the intention to do so, but produces an
additional informational lintian output about an unused override (-_-')


Regards,
Andreas

[Soren Stoutner]

Andreas,

Post by Andreas Altergott
I've been struggling with the lintian override for the documentation
outside /usr/share/doc. I was unable to silence this informational
lintian output.
The current override documents the intention to do so, but produces an
additional informational lintian output about an unused override (-_-')

I think the following MR should fix the issue:

https://salsa.debian.org/andreas82/vimium/-/merge_requests/1

[Soren Stoutner]

Andreas,

Just for info. You already explained that the source-is-missing tag is
an experimental tag and isn't considered necessary to override.
Package builds by the use of pbuilder without any lintian warnings on
current Debian Sid.
On current Debian Stable as well as on mentors.debian.net I get a
lintian error for source-is-missing [content_scripts/mode_visual.js]

I think the interesting aspect of this is that this lintian tag used to not be
marked as experimental, but was changed to experimental in a recent lintian
release due to the large number of false-positives.

Stable has an old version of lintian. Mentors runs an old version of lintian
(I believe from stable). Lintian also runs on all packages uploaded to NEW
and autorejects some based on the severity of the tags. I don’t know which
version of lintian NEW uses.

I have uploaded the package to NEW. We’ll see in a few minutes if it is
autorejected. If so, we will need to add the override back in.