[guillem@debian.org: Hook into build system. ]

Closes: #1032562
Signed-off-by: Guillem Jover <guillem@debian.org>

This is only needed in perl modules, not in perl programs where it does
nothing relevant.

We should switch our excessive recursive prevention check to cover
exponential expansion. Because with exponential expansion we always
make progress, the current check misses those cases, so we track
expansion per variable, and ignore those variables that do not contain
any dollar symbol as these cannot then be involved in further expansion.

In this context this is not considered a security issue, but a
robustness issue, where we do not want the code to end up consuming
boundless amounts of memory.

Use the American English variants uniformly. Leave the ones found in
changelog entries for other authors than myself to avoid putting words
in their mouths. We also leave the only remaining «our»-ending word
for «favour» as that is part of the maintscripts interface, and to avoid
confusion we leave other non-interface references alone for consistency.

Warned-by: perlcritic
Addresses: NamingConventions::ProhibitAmbiguousNames

This feature (disabled by default) enables 64-bit time on 32-bit
architectures where their ABI does not define it by default. This
feature automatically enables the lfs one as it is required by it.

Do not enable time64 for the new 32-bit architectures that already have
it enabled by default as part of their ABI, that is «arc» and «or1k».

Closes: #1030159
Based-on-patch-by: Helge Deller <deller@gmx.de>

This was a very convoluted way to check whether the files have the same
contents.

Changelog: internal

In Debian this module is not part of the perl-base essential package,
switch to use the encode/decode functions from the utf8 functions
instead.

Changelog: internal

This encapsulates the formatting into a function for more clear code on
the call site.

Changelog: internal

Since perl 5.32 we can use chained comparisons, which should make these
operations more obvious and compact.

We can replace all these regex comparisons with fixed string matches,
including the ones that are case-insensitive as the fields are always
normalized to their preferred form.

Warned-by: perlcritic
Addresses: RegularExpressions::ProhibitFixedStringMatches

This makes the usage more clear, and once we switch to literal string
matches we would need to use the variable explicitly anyway.

Avoid the potential confusion.

Changelog: internal

The code prominently handles fields, so using $f or similarly short
variants of that (as part of a hash variable name) is confusing when
surrounding code is handling fields in also $f named variables.

The usage pattern for this is very non-intuitive on the call sites. Emit
a deprecation warning, to warn any potential external users. And after a
bit this support will be removed.

Passing $_ implicitly is very confusing for the reader on the call
sites. Pass it explicitly, and eventually we'll give these a proper
variable instead.

Warned-by: perlcritic
Addresses: RegularExpressions::ProhibitFixedStringMatches

Suppress perlcritic false positives in code.

Warned-by: perlcritic
Fixes: RegularExpressions::ProhibitCaptureWithoutTest

Reflow the code so that it does not trigger the perlcritic check,
and improve the regex match operator and comment.

Warned-by: perlcritic
Addresses: RegularExpressions::ProhibitCaptureWithoutTest

The code was using a non-existent captured variable, replace it with the
correct one. This did not affect any current usage in the dpkg codebase,
as we always pass pathnames relative to the source root directory.

The immediately preceding regex does not capture, but this seems to
be confusing perlcritic, as we then use a captured variable which is
already being conditionally used.

Warned-by: perlcritic
Addresses: RegularExpressions::ProhibitCaptureWithoutTest

Since perl 5.26, the current directory («.») is no longer added to @INC,
and as such this is not a security concern anymore.

This file was originally copied from the Debconf::Gettext module from
debconf with a BSD-2 license, originally by Joey Hess, which got
modified by Nicolas François on import, and subsequently reworked by
me, and with a trivial change by Raphaël Hertzog.

With agreement from authors with original or non-trivial code:

  Joey Hess
    <https://lists.debian.org/debian-dpkg/2023/03/msg00005.html>
  Nicolas François
    <https://lists.debian.org/debian-dpkg/2023/03/msg00002.html

>

and myself with this commit, relicense this file from BSD-2 to GPL-2+
to simplify the licensing for the Dpkg perl modules.

Signed-off-by: Guillem Jover <guillem@debian.org>

Supported since perl 5.22.

Add a comment on the warning registration to avoid accidental removal,
and update the documentation about the warning to make it clear it has
been removed, and how to cope with the compatibility code.

Use the same formatting as the generated template POT, where the first
line is the translation description, then the copyright claims, followed
bu the license reference, next a blank line separating the translator
list history, followed by an optional blank line and any translator
notes if available.

This is a global variable that was then being shadowed by other
variables with the same name in inner scopes.

Warned-by: perlcritic
Addresses: Variables::ProhibitReusedNames

Do not shadow an already defined variable, instead simply use it
as is, given that the other uses will initialize it when needed.

Warned-by: perlcritic
Addresses: Variables::ProhibitReusedNames

Unpack the arguments into variables to make the core more readable, and
avoid aliasing issues.

Warned-by: perlcritic
Fixes: Subroutines::RequireArgUnpacking

Changelog: silent

For NAME and DESCRIPTION we are describing the whole package, so do
that before the keyword as we do as well when describing variables or
functions.

For FUNCTIONS and METHODS, move them immediately before the functions
or methods they start describing.

Mark them explicitly as private modules, add some minimal description
for their purpose. This also fixes the warnings from pod2man where it
cannot generate a man page for these.

Closes: #1030660

This refer to the source package name, instead of a source package
object or similar.