Skip to content

Document dependency on MIME::Base32#1223

Merged
marc-vanderwal merged 1 commit into
zonemaster:developfrom
marc-vanderwal:feature/depend-on-mime-base32
Dec 4, 2023
Merged

Document dependency on MIME::Base32#1223
marc-vanderwal merged 1 commit into
zonemaster:developfrom
marc-vanderwal:feature/depend-on-mime-base32

Conversation

@marc-vanderwal

@marc-vanderwal marc-vanderwal commented Nov 22, 2023

Copy link
Copy Markdown
Contributor

Purpose

This PR documents a new test-time dependency on MIME::Base32.

Context

The change was made necessary by PR zonemaster/zonemaster-ldns#178.

Changes

Add MIME::Base32 as dependency in various places.

How to test this PR

Documentation update.

@marc-vanderwal
Document dependency on MIME::Base32
1009c28 
Pull request zonemaster/zonemaster-ldns#178 adds a test-time dependency
on MIME::Base32. This commit documents the change.

This package should be installed manually in build environments.

The module does not seem to be packaged in Red Hat-based Linux
distributions. On those OSes, the MIME::Base32 has to be installed
through CPAN.
@marc-vanderwal marc-vanderwal added this to the v2023.2 milestone Nov 22, 2023
@marc-vanderwal marc-vanderwal mentioned this pull request Nov 23, 2023
Merged
@mattias-p

mattias-p commented Nov 30, 2023

Copy link
Copy Markdown
Member

If it's a test-time dependency should it be included in the installation instruction? We're installing with --notest.

@matsduf

matsduf commented Nov 30, 2023

Copy link
Copy Markdown
Contributor

If it's a test-time dependency should it be included in the installation instruction? We're installing with --notest.

Yes, but we also advice running the installation without --notest in case of problem and then the dependency is needed:

Troubleshooting installation

If you have any issue with installation, and installed with cpanm, redo the
installation above but without the --notest and with the --verbose option.
Installation will take longer time.

@matsduf

matsduf commented Nov 30, 2023

Copy link
Copy Markdown
Contributor

Since the dependency is added to the installation document, it is not needed in the documents under "distrib-testing" as far as I can see. But it does no harm, on the other side.

mattias-p
mattias-p approved these changes Nov 30, 2023
View reviewed changes

@mattias-p mattias-p left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but we also advice running the installation without --notest

Fair enough!

@marc-vanderwal marc-vanderwal merged commit ba22cc8 into zonemaster:develop Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mattias-p mattias-p mattias-p approved these changes
@matsduf matsduf matsduf approved these changes
@tgreenx tgreenx tgreenx approved these changes
@hannaeko hannaeko Awaiting requested review from hannaeko

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

v2023.2

Development

Successfully merging this pull request may close these issues.

4 participants

@marc-vanderwal @mattias-p @matsduf @tgreenx