scripts: Unify constructor and function options documentation
commit9cf0594cf5739f0335bf11ab0900fa9130e92d73
authorGuillem Jover <guillem@debian.org>
Tue, 6 Aug 2024 03:53:03 +0000 (6 05:53 +0200)
committerGuillem Jover <guillem@debian.org>
Wed, 7 Aug 2024 01:43:56 +0000 (7 03:43 +0200)
tree86eb4c217e3477aaa9d520df45b5ce2941a2dee2
parent0e7694ceb00248516048fd54caa72fd9e4b4eb6d
scripts: Unify constructor and function options documentation

Consistently use "Options:" as a header when introducing the options.
Itemize them to make it easier to find each one, instead of describing
them in long paragraphs. Mark up the option names in bold. Reorder
options by expected common usage. Document whether an option is required
after the item itself in parenthesis.
25 files changed:
scripts/Dpkg/Arch.pm
scripts/Dpkg/Archive/Ar.pm
scripts/Dpkg/BuildDriver.pm
scripts/Dpkg/BuildFlags.pm
scripts/Dpkg/BuildOptions.pm
scripts/Dpkg/BuildTree.pm
scripts/Dpkg/Changelog.pm
scripts/Dpkg/Changelog/Parse.pm
scripts/Dpkg/Checksums.pm
scripts/Dpkg/Compression/FileHandle.pm
scripts/Dpkg/Compression/Process.pm
scripts/Dpkg/Conf.pm
scripts/Dpkg/Control.pm
scripts/Dpkg/Control/HashCore.pm
scripts/Dpkg/Control/Info.pm
scripts/Dpkg/Control/Tests.pm
scripts/Dpkg/Control/Tests/Entry.pm
scripts/Dpkg/Deps/Simple.pm
scripts/Dpkg/IPC.pm
scripts/Dpkg/Index.pm
scripts/Dpkg/Source/Format.pm
scripts/Dpkg/Source/Package.pm
scripts/Dpkg/Substvars.pm
scripts/Dpkg/Version.pm
t/pod-spell.t