diff options
author | Guillem Jover <guillem@debian.org> | 2019-11-06 02:07:17 +0100 |
---|---|---|
committer | Guillem Jover <guillem@debian.org> | 2019-11-26 02:42:45 +0100 |
commit | 7ab69d4acbdabd3af0f8c27801527750505c1a11 (patch) | |
tree | eccb3cbbb4cbf993c29832bfcca8bc1bf1b77f58 | |
parent | b287a80263dd4e45bb82b7e6bad76faeb47358d4 (diff) | |
download | dpkg-7ab69d4acbdabd3af0f8c27801527750505c1a11.tar.gz |
Dpkg: Say class instead of object when appropriate
These were referring to the type and not the instance, which makes
using the incorrect nomenclature confusing.
27 files changed, 49 insertions, 47 deletions
diff --git a/debian/changelog b/debian/changelog index 4367a5673..d41eaa836 100644 --- a/debian/changelog +++ b/debian/changelog @@ -87,6 +87,7 @@ dpkg (1.20.0) UNRELEASED; urgency=medium - man: Describe the SONAME formats supported in deb-shlibs(5). - man: Move template symbol documentation into new deb-src-symbols(5). - Dpkg::Changelog::Parse: Remove $ sigil from option names in POD. + - Dpkg: Say class instead of object when appropriate. * Code internals: - Dpkg::Source::Package: Refactor original tarball handling. - perl: Use File::Copy instead of spawning mv/cp commands. diff --git a/scripts/Dpkg/BuildFlags.pm b/scripts/Dpkg/BuildFlags.pm index edf16e4f3..53b3cad00 100644 --- a/scripts/Dpkg/BuildFlags.pm +++ b/scripts/Dpkg/BuildFlags.pm @@ -34,7 +34,7 @@ Dpkg::BuildFlags - query build flags =head1 DESCRIPTION -The Dpkg::BuildFlags object is used by dpkg-buildflags and can be used +This class is used by dpkg-buildflags and can be used to query the same information. =head1 METHODS diff --git a/scripts/Dpkg/BuildOptions.pm b/scripts/Dpkg/BuildOptions.pm index 263381b49..e03ea320b 100644 --- a/scripts/Dpkg/BuildOptions.pm +++ b/scripts/Dpkg/BuildOptions.pm @@ -34,7 +34,7 @@ Dpkg::BuildOptions - parse and update build options =head1 DESCRIPTION -The Dpkg::BuildOptions object can be used to manipulate options stored +This class can be used to manipulate options stored in environment variables like DEB_BUILD_OPTIONS and DEB_BUILD_MAINT_OPTIONS. diff --git a/scripts/Dpkg/Changelog.pm b/scripts/Dpkg/Changelog.pm index 1485ae583..04fa511ec 100644 --- a/scripts/Dpkg/Changelog.pm +++ b/scripts/Dpkg/Changelog.pm @@ -24,7 +24,7 @@ Dpkg::Changelog - base class to implement a changelog parser Dpkg::Changelog is a class representing a changelog file as an array of changelog entries (Dpkg::Changelog::Entry). -By deriving this object and implementing its parse method, you +By deriving this class and implementing its parse method, you add the ability to fill this object with changelog entries. =cut diff --git a/scripts/Dpkg/Changelog/Entry.pm b/scripts/Dpkg/Changelog/Entry.pm index 144dacb0f..d6ce55601 100644 --- a/scripts/Dpkg/Changelog/Entry.pm +++ b/scripts/Dpkg/Changelog/Entry.pm @@ -39,7 +39,7 @@ Dpkg::Changelog::Entry - represents a changelog entry =head1 DESCRIPTION -This object represents a changelog entry. It is composed +This class represents a changelog entry. It is composed of a set of lines with specific purpose: an header line, changes lines, a trailer line. Blank lines can be between those kind of lines. diff --git a/scripts/Dpkg/Changelog/Entry/Debian.pm b/scripts/Dpkg/Changelog/Entry/Debian.pm index 2d1c4e6a1..8658ae493 100644 --- a/scripts/Dpkg/Changelog/Entry/Debian.pm +++ b/scripts/Dpkg/Changelog/Entry/Debian.pm @@ -45,7 +45,7 @@ Dpkg::Changelog::Entry::Debian - represents a Debian changelog entry =head1 DESCRIPTION -This object represents a Debian changelog entry. It implements the +This class represents a Debian changelog entry. It implements the generic interface Dpkg::Changelog::Entry. Only functions specific to this implementation are described below. diff --git a/scripts/Dpkg/Checksums.pm b/scripts/Dpkg/Checksums.pm index 9b7316b07..93bdf4bd8 100644 --- a/scripts/Dpkg/Checksums.pm +++ b/scripts/Dpkg/Checksums.pm @@ -41,7 +41,7 @@ Dpkg::Checksums - generate and manipulate file checksums =head1 DESCRIPTION -This module provides an object that can generate and manipulate +This module provides a class that can generate and manipulate various file checksums as well as some methods to query information about supported checksums. diff --git a/scripts/Dpkg/Compression/FileHandle.pm b/scripts/Dpkg/Compression/FileHandle.pm index 23b39841a..c0d4b0787 100644 --- a/scripts/Dpkg/Compression/FileHandle.pm +++ b/scripts/Dpkg/Compression/FileHandle.pm @@ -31,14 +31,14 @@ use Dpkg::ErrorHandling; use parent qw(IO::File Tie::Handle); # Useful reference to understand some kludges required to -# have the object behave like a filehandle +# have the class behave like a filehandle # http://blog.woobling.org/2009/10/are-filehandles-objects.html =encoding utf8 =head1 NAME -Dpkg::Compression::FileHandle - object dealing transparently with file compression +Dpkg::Compression::FileHandle - class dealing transparently with file compression =head1 SYNOPSIS @@ -76,7 +76,7 @@ Dpkg::Compression::FileHandle - object dealing transparently with file compressi =head1 DESCRIPTION -Dpkg::Compression::FileHandle is an object that can be used +Dpkg::Compression::FileHandle is a class that can be used like any filehandle and that deals transparently with compressed files. By default, the compression scheme is guessed from the filename but you can override this behaviour with the method C<set_compression>. @@ -102,8 +102,8 @@ and you can't seek on a pipe. =head1 FileHandle METHODS -The object inherits from IO::File so all methods that work on this -object should work for Dpkg::Compression::FileHandle too. There +The class inherits from IO::File so all methods that work on this +class should work for Dpkg::Compression::FileHandle too. There may be exceptions though. =head1 PUBLIC METHODS @@ -121,7 +121,7 @@ obviously incompatible with automatic detection of the compression method. =cut -# Object methods +# Class methods sub new { my ($this, %args) = @_; my $class = ref($this) || $this; @@ -378,7 +378,7 @@ sub use_compression { =item $real_fh = $fh->get_filehandle() Returns the real underlying filehandle. Useful if you want to pass it -along in a derived object. +along in a derived class. =cut @@ -444,9 +444,9 @@ sub _cleanup { =back -=head1 DERIVED OBJECTS +=head1 DERIVED CLASSES -If you want to create an object that inherits from +If you want to create a class that inherits from Dpkg::Compression::FileHandle you must be aware that the object is a reference to a GLOB that is returned by Symbol::gensym() and as such it's not a HASH. diff --git a/scripts/Dpkg/Control/Changelog.pm b/scripts/Dpkg/Control/Changelog.pm index 1f65127c4..9184cedbc 100644 --- a/scripts/Dpkg/Control/Changelog.pm +++ b/scripts/Dpkg/Control/Changelog.pm @@ -32,7 +32,7 @@ Dpkg::Control::Changelog - represent info fields output by dpkg-parsechangelog =head1 DESCRIPTION -This object derives directly from Dpkg::Control with the type +This class derives directly from Dpkg::Control with the type CTRL_CHANGELOG. =head1 METHODS diff --git a/scripts/Dpkg/Control/HashCore.pm b/scripts/Dpkg/Control/HashCore.pm index 542069332..04a8a574b 100644 --- a/scripts/Dpkg/Control/HashCore.pm +++ b/scripts/Dpkg/Control/HashCore.pm @@ -43,7 +43,7 @@ Dpkg::Control::HashCore - parse and manipulate a block of RFC822-like fields =head1 DESCRIPTION -The Dpkg::Control::Hash object is a hash-like representation of a set of +The Dpkg::Control::Hash class is a hash-like representation of a set of RFC822-like fields. The fields names are case insensitive and are always capitalized the same when output (see field_capitalize function in Dpkg::Control::Fields). @@ -440,7 +440,7 @@ sub apply_substvars { package Dpkg::Control::HashCore::Tie; -# This object is used to tie a hash. It implements hash-like functions by +# This class is used to tie a hash. It implements hash-like functions by # normalizing the name of fields received in keys (using # Dpkg::Control::Fields::field_capitalize). It also stores the order in # which fields have been added in order to be able to dump them in the diff --git a/scripts/Dpkg/Control/Info.pm b/scripts/Dpkg/Control/Info.pm index 9b07eedbe..5759ab5ad 100644 --- a/scripts/Dpkg/Control/Info.pm +++ b/scripts/Dpkg/Control/Info.pm @@ -38,7 +38,7 @@ Dpkg::Control::Info - parse files like debian/control =head1 DESCRIPTION -It provides an object to access data of files that follow the same +It provides a class to access data of files that follow the same syntax as F<debian/control>. =head1 METHODS diff --git a/scripts/Dpkg/Control/Tests.pm b/scripts/Dpkg/Control/Tests.pm index 439eee8c8..3c8d1c006 100644 --- a/scripts/Dpkg/Control/Tests.pm +++ b/scripts/Dpkg/Control/Tests.pm @@ -34,7 +34,7 @@ Dpkg::Control::Tests - parse files like debian/tests/control =head1 DESCRIPTION -It provides an object to access data of files that follow the same +It provides a class to access data of files that follow the same syntax as F<debian/tests/control>. =head1 METHODS diff --git a/scripts/Dpkg/Control/Tests/Entry.pm b/scripts/Dpkg/Control/Tests/Entry.pm index 92eea49f4..001a6f429 100644 --- a/scripts/Dpkg/Control/Tests/Entry.pm +++ b/scripts/Dpkg/Control/Tests/Entry.pm @@ -34,7 +34,7 @@ Dpkg::Control::Tests::Entry - represents a test suite entry =head1 DESCRIPTION -This object represents a test suite entry. +This class represents a test suite entry. =head1 METHODS diff --git a/scripts/Dpkg/Deps.pm b/scripts/Dpkg/Deps.pm index ec02fd8c8..80d249019 100644 --- a/scripts/Dpkg/Deps.pm +++ b/scripts/Dpkg/Deps.pm @@ -29,7 +29,7 @@ Dpkg::Deps - parse and manipulate dependencies of Debian packages =head1 DESCRIPTION -The Dpkg::Deps module provides objects implementing various types of +The Dpkg::Deps module provides classes implementing various types of dependencies. The most important function is deps_parse(), it turns a dependency line in @@ -429,11 +429,11 @@ sub deps_compare { } } -=head1 OBJECTS - Dpkg::Deps::* +=head1 CLASSES - Dpkg::Deps::* There are several kind of dependencies. A Dpkg::Deps::Simple dependency represents a single dependency statement (it relates to one package only). -Dpkg::Deps::Multiple dependencies are built on top of this object +Dpkg::Deps::Multiple dependencies are built on top of this class and combine several dependencies in different manners. Dpkg::Deps::AND represents the logical "AND" between dependencies while Dpkg::Deps::OR represents the logical "OR". Dpkg::Deps::Multiple objects can contain @@ -443,7 +443,7 @@ In practice, the code is only meant to handle the realistic cases which, given Debian's dependencies structure, imply those restrictions: AND can contain Simple or OR objects, OR can only contain Simple objects. -Dpkg::Deps::KnownFacts is a special object that is used while evaluating +Dpkg::Deps::KnownFacts is a special class that is used while evaluating dependencies and while trying to simplify them. It represents a set of installed packages along with the virtual packages that they might provide. diff --git a/scripts/Dpkg/Deps/AND.pm b/scripts/Dpkg/Deps/AND.pm index e16a2cf35..7b403c237 100644 --- a/scripts/Dpkg/Deps/AND.pm +++ b/scripts/Dpkg/Deps/AND.pm @@ -29,7 +29,7 @@ Dpkg::Deps::AND - list of AND dependencies =head1 DESCRIPTION -This object represents a list of dependencies that must be met at the same +This class represents a list of dependencies that must be met at the same time. It inherits from Dpkg::Deps::Multiple. =cut diff --git a/scripts/Dpkg/Deps/KnownFacts.pm b/scripts/Dpkg/Deps/KnownFacts.pm index a414eb49b..ef8655fdd 100644 --- a/scripts/Dpkg/Deps/KnownFacts.pm +++ b/scripts/Dpkg/Deps/KnownFacts.pm @@ -29,7 +29,7 @@ Dpkg::Deps::KnownFacts - list of installed real and virtual packages =head1 DESCRIPTION -This object represents a list of installed packages and a list of virtual +This class represents a list of installed packages and a list of virtual packages provided (by the set of installed packages). =cut diff --git a/scripts/Dpkg/Deps/OR.pm b/scripts/Dpkg/Deps/OR.pm index b2f8d03ed..4ce5c9818 100644 --- a/scripts/Dpkg/Deps/OR.pm +++ b/scripts/Dpkg/Deps/OR.pm @@ -29,7 +29,7 @@ Dpkg::Deps::OR - list of OR dependencies =head1 DESCRIPTION -This object represents a list of dependencies of which only one must be met +This class represents a list of dependencies of which only one must be met for the dependency to be true. It inherits from Dpkg::Deps::Multiple. =cut diff --git a/scripts/Dpkg/Deps/Simple.pm b/scripts/Dpkg/Deps/Simple.pm index efe635cec..aa23e7da2 100644 --- a/scripts/Dpkg/Deps/Simple.pm +++ b/scripts/Dpkg/Deps/Simple.pm @@ -29,7 +29,8 @@ Dpkg::Deps::Simple - represents a single dependency statement =head1 DESCRIPTION -This object has several interesting properties: +This class represents a single dependency statement. +It has several interesting properties: =over 4 @@ -576,7 +577,7 @@ sub get_evaluation { =item $dep->simplify_deps($facts, @assumed_deps) Simplifies the dependency as much as possible given the list of facts (see -object Dpkg::Deps::KnownFacts) and a list of other dependencies that are +class Dpkg::Deps::KnownFacts) and a list of other dependencies that are known to be true. =cut diff --git a/scripts/Dpkg/Deps/Union.pm b/scripts/Dpkg/Deps/Union.pm index 62cf5c38a..148e38ed3 100644 --- a/scripts/Dpkg/Deps/Union.pm +++ b/scripts/Dpkg/Deps/Union.pm @@ -29,8 +29,8 @@ Dpkg::Deps::Union - list of unrelated dependencies =head1 DESCRIPTION -This object represents a list of relationships. It inherits from -Dpkg::Deps::Multiple. +This class represents a list of relationships. +It inherits from Dpkg::Deps::Multiple. =cut diff --git a/scripts/Dpkg/Index.pm b/scripts/Dpkg/Index.pm index 7859bf669..cfe86ba17 100644 --- a/scripts/Dpkg/Index.pm +++ b/scripts/Dpkg/Index.pm @@ -39,7 +39,7 @@ Dpkg::Index - generic index of control information =head1 DESCRIPTION -This object represent a set of Dpkg::Control objects. +This class represent a set of Dpkg::Control objects. =head1 METHODS diff --git a/scripts/Dpkg/Interface/Storable.pm b/scripts/Dpkg/Interface/Storable.pm index 5ed308cf2..5ac078ac1 100644 --- a/scripts/Dpkg/Interface/Storable.pm +++ b/scripts/Dpkg/Interface/Storable.pm @@ -38,12 +38,12 @@ Dpkg::Interface::Storable - common methods related to object serialization =head1 DESCRIPTION Dpkg::Interface::Storable is only meant to be used as parent -class for other objects. It provides common methods that are +class for other classes. It provides common methods that are all implemented on top of two basic methods parse() and output(). =head1 BASE METHODS -Those methods must be provided by the object that wish to inherit +Those methods must be provided by the class that wish to inherit from Dpkg::Interface::Storable so that the methods provided can work. =over 4 diff --git a/scripts/Dpkg/Source/Format.pm b/scripts/Dpkg/Source/Format.pm index 55172a2ef..41596a233 100644 --- a/scripts/Dpkg/Source/Format.pm +++ b/scripts/Dpkg/Source/Format.pm @@ -24,7 +24,7 @@ Dpkg::Source::Format - manipulate debian/source/format files =head1 DESCRIPTION -This module provides an object that can manipulate Debian source +This module provides a class that can manipulate Debian source package F<debian/source/format> files. =cut diff --git a/scripts/Dpkg/Source/Package.pm b/scripts/Dpkg/Source/Package.pm index d38e228e5..337000cb8 100644 --- a/scripts/Dpkg/Source/Package.pm +++ b/scripts/Dpkg/Source/Package.pm @@ -24,7 +24,7 @@ Dpkg::Source::Package - manipulate Debian source packages =head1 DESCRIPTION -This module provides an object that can manipulate Debian source +This module provides a class that can manipulate Debian source packages. While it supports both the extraction and the creation of source packages, the only API that is officially supported is the one that supports the extraction of the source package. @@ -204,7 +204,7 @@ source package after its extraction. =cut -# Object methods +# Class methods sub new { my ($this, %args) = @_; my $class = ref($this) || $this; diff --git a/scripts/Dpkg/Substvars.pm b/scripts/Dpkg/Substvars.pm index 49ebd902b..27107fe3d 100644 --- a/scripts/Dpkg/Substvars.pm +++ b/scripts/Dpkg/Substvars.pm @@ -39,7 +39,7 @@ Dpkg::Substvars - handle variable substitution in strings =head1 DESCRIPTION -It provides an object which is able to substitute variables in strings. +It provides a class which is able to substitute variables in strings. =cut diff --git a/scripts/Dpkg/Vendor/Debian.pm b/scripts/Dpkg/Vendor/Debian.pm index a37b23cfc..c3e580da7 100644 --- a/scripts/Dpkg/Vendor/Debian.pm +++ b/scripts/Dpkg/Vendor/Debian.pm @@ -36,11 +36,11 @@ use parent qw(Dpkg::Vendor::Default); =head1 NAME -Dpkg::Vendor::Debian - Debian vendor object +Dpkg::Vendor::Debian - Debian vendor class =head1 DESCRIPTION -This vendor object customizes the behaviour of dpkg scripts for Debian +This vendor class customizes the behaviour of dpkg scripts for Debian specific behavior and policies. =cut diff --git a/scripts/Dpkg/Vendor/Default.pm b/scripts/Dpkg/Vendor/Default.pm index 6b7c5204f..42b0f0405 100644 --- a/scripts/Dpkg/Vendor/Default.pm +++ b/scripts/Dpkg/Vendor/Default.pm @@ -20,7 +20,7 @@ use warnings; our $VERSION = '0.01'; -# If you use this file as template to create a new vendor object, please +# If you use this file as template to create a new vendor class, please # uncomment the following lines #use parent qw(Dpkg::Vendor::Default); @@ -28,12 +28,12 @@ our $VERSION = '0.01'; =head1 NAME -Dpkg::Vendor::Default - default vendor object +Dpkg::Vendor::Default - default vendor class =head1 DESCRIPTION -A vendor object is used to provide vendor specific behaviour -in various places. This is the default object used in case +A vendor class is used to provide vendor specific behaviour +in various places. This is the default class used in case there's none for the current vendor or in case the vendor could not be identified (see Dpkg::Vendor documentation). diff --git a/scripts/Dpkg/Vendor/Ubuntu.pm b/scripts/Dpkg/Vendor/Ubuntu.pm index e6335c204..ddee2a192 100644 --- a/scripts/Dpkg/Vendor/Ubuntu.pm +++ b/scripts/Dpkg/Vendor/Ubuntu.pm @@ -34,11 +34,11 @@ use parent qw(Dpkg::Vendor::Debian); =head1 NAME -Dpkg::Vendor::Ubuntu - Ubuntu vendor object +Dpkg::Vendor::Ubuntu - Ubuntu vendor class =head1 DESCRIPTION -This vendor object customizes the behaviour of dpkg scripts for Ubuntu +This vendor class customizes the behaviour of dpkg scripts for Ubuntu specific behavior and policies. =cut |