This is an automated email from the git hooks/post-receive script. guillem pushed a commit to branch master in repository dpkg.
commit c365c51ea613d11b5cdc1c82f1f7062b990d5b07 Author: Guillem Jover <[email protected]> Date: Tue Sep 19 02:29:49 2017 +0200 scripts: Fix function signatures documentation --- debian/changelog | 1 + scripts/Dpkg/Build/Env.pm | 10 +++++----- scripts/Dpkg/Vendor.pm | 12 ++++++------ 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/debian/changelog b/debian/changelog index 6bba86b..1f5680a 100644 --- a/debian/changelog +++ b/debian/changelog @@ -106,6 +106,7 @@ dpkg (1.19.0) UNRELEASED; urgency=medium - Add new rootless build experimental draft specification. Initial proposal by Niels Thykier <[email protected]>, wording fixes and spec clarifications by Guillem Jover <[email protected]>. + - Fix several function signature documentation. * Code internals: - Switch perl code to use -> operator for function variables. - Switch perl code from split() with /\s+/ to ' '. diff --git a/scripts/Dpkg/Build/Env.pm b/scripts/Dpkg/Build/Env.pm index 9312d2d..856d185 100644 --- a/scripts/Dpkg/Build/Env.pm +++ b/scripts/Dpkg/Build/Env.pm @@ -38,7 +38,7 @@ environment variables being used and modified. =over 4 -=item $bf->set($varname, $value) +=item set($varname, $value) Update the build environment variable $varname with value $value. Record it as being accessed and modified. @@ -52,7 +52,7 @@ sub set { $ENV{$varname} = $value; } -=item $bf->get($varname) +=item get($varname) Get the build environment variable $varname value. Record it as being accessed. @@ -65,7 +65,7 @@ sub get { return $ENV{$varname}; } -=item $bf->has($varname) +=item has($varname) Return a boolean indicating whether the environment variable exists. Record it as being accessed. @@ -78,7 +78,7 @@ sub has { return exists $ENV{$varname}; } -=item @list = $bf->list_accessed() +=item @list = list_accessed() Returns a list of all environment variables that have been accessed. @@ -89,7 +89,7 @@ sub list_accessed { return @list; } -=item @list = $bf->list_modified() +=item @list = list_modified() Returns a list of all environment variables that have been modified. diff --git a/scripts/Dpkg/Vendor.pm b/scripts/Dpkg/Vendor.pm index 99b56b5..1961591 100644 --- a/scripts/Dpkg/Vendor.pm +++ b/scripts/Dpkg/Vendor.pm @@ -70,7 +70,7 @@ file can have the same casing as the Vendor field, or it can be capitalized. =over 4 -=item $dir = Dpkg::Vendor::get_vendor_dir() +=item $dir = get_vendor_dir() Returns the current dpkg origins directory name, where the vendor files are stored. @@ -81,7 +81,7 @@ sub get_vendor_dir { return $origins; } -=item $fields = Dpkg::Vendor::get_vendor_info($name) +=item $fields = get_vendor_info($name) Returns a Dpkg::Control object with the information parsed from the corresponding vendor file in $Dpkg::CONFDIR/origins/. If $name is omitted, @@ -104,7 +104,7 @@ sub get_vendor_info(;$) { return $fields; } -=item $name = Dpkg::Vendor::get_vendor_file($name) +=item $name = get_vendor_file($name) Check if there's a file for the given vendor and returns its name. @@ -124,7 +124,7 @@ sub get_vendor_file(;$) { return $file; } -=item $name = Dpkg::Vendor::get_current_vendor() +=item $name = get_current_vendor() Returns the name of the current vendor. If DEB_VENDOR is set, it uses that first, otherwise it falls back to parsing $Dpkg::CONFDIR/origins/default. @@ -143,7 +143,7 @@ sub get_current_vendor() { return; } -=item $object = Dpkg::Vendor::get_vendor_object($name) +=item $object = get_vendor_object($name) Return the Dpkg::Vendor::* object of the corresponding vendor. If $name is omitted, return the object of the current vendor. @@ -180,7 +180,7 @@ sub get_vendor_object { } } -=item Dpkg::Vendor::run_vendor_hook($hookid, @params) +=item run_vendor_hook($hookid, @params) Run a hook implemented by the current vendor object. -- Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/dpkg/dpkg.git
