This is an automated email from the git hooks/post-receive script. guillem pushed a commit to branch main in repository dpkg.
View the commit online: https://git.dpkg.org/cgit/dpkg/dpkg.git/commit/?id=d130b0a6464fb18b6e97270845cecee0a10531b1 commit d130b0a6464fb18b6e97270845cecee0a10531b1 Author: Guillem Jover <guil...@debian.org> AuthorDate: Sun Sep 17 23:37:35 2023 +0200 doc: Use name() POD syntax instead of C<>, B<> or L<> for function names The POD parsers know what to do automatically for this kind of syntax, and the markup is unnecessary. --- scripts/Dpkg/Changelog.pm | 4 ++-- scripts/Dpkg/Compression.pm | 12 ++++++------ scripts/Dpkg/Compression/FileHandle.pm | 16 ++++++++-------- scripts/Dpkg/Compression/Process.pm | 20 ++++++++++---------- 4 files changed, 26 insertions(+), 26 deletions(-) diff --git a/scripts/Dpkg/Changelog.pm b/scripts/Dpkg/Changelog.pm index 121509d17..8a925c5ec 100644 --- a/scripts/Dpkg/Changelog.pm +++ b/scripts/Dpkg/Changelog.pm @@ -107,7 +107,7 @@ Returns the number of changelog entries that have been parsed with success. =item $c->reset_parse_errors() Can be used to delete all information about errors occurred during -previous L<parse> runs. +previous parse() runs. =cut @@ -139,7 +139,7 @@ sub parse_error { =item $c->get_parse_errors() -Returns all error messages from the last L<parse> run. +Returns all error messages from the last parse() run. If called in scalar context returns a human readable string representation. If called in list context returns an array of arrays. Each of these arrays contains diff --git a/scripts/Dpkg/Compression.pm b/scripts/Dpkg/Compression.pm index de58e336c..9e6074d18 100644 --- a/scripts/Dpkg/Compression.pm +++ b/scripts/Dpkg/Compression.pm @@ -207,7 +207,7 @@ sub compression_get_file_extension { =item $comp = compression_get_default() Return the default compression method. It is "xz" unless -C<compression_set_default> has been used to change it. +compression_set_default() has been used to change it. =cut @@ -235,7 +235,7 @@ Return the global default compression level used when compressing data if it has been set, otherwise the default level for the default compressor. It's "9" for "gzip" and "bzip2", "6" for "xz" and "lzma", unless -C<compression_set_default_level> has been used to change it. +compression_set_default_level() has been used to change it. =cut @@ -251,7 +251,7 @@ sub compression_get_default_level { Change the global default compression level. Passing undef as the level will reset it to the global default compressor specific default, otherwise errors -out if the level is not valid (see C<compression_is_valid_level>). +out if the level is not valid (see compression_is_valid_level()). =cut @@ -286,7 +286,7 @@ sub compression_get_level { Change the compression level for a specific compressor. Passing undef as the level will reset it to the specific default compressor level, otherwise -errors out if the level is not valid (see C<compression_is_valid_level>). +errors out if the level is not valid (see compression_is_valid_level()). =cut @@ -341,7 +341,7 @@ sub compression_set_threads { =item @exec = compression_get_cmdline_compress($comp) -Returns a list ready to be passed to C<exec>, its first element is the +Returns a list ready to be passed to exec(), its first element is the program name for compression and the following elements are parameters for the program. @@ -384,7 +384,7 @@ sub compression_get_cmdline_compress { =item @exec = compression_get_cmdline_decompress($comp) -Returns a list ready to be passed to C<exec>, its first element is the +Returns a list ready to be passed to exec(), its first element is the program name for decompression and the following elements are parameters for the program. diff --git a/scripts/Dpkg/Compression/FileHandle.pm b/scripts/Dpkg/Compression/FileHandle.pm index b29e0ecec..6141ed881 100644 --- a/scripts/Dpkg/Compression/FileHandle.pm +++ b/scripts/Dpkg/Compression/FileHandle.pm @@ -59,11 +59,11 @@ Dpkg::Compression::FileHandle - class dealing transparently with file compressio 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 behavior with the method C<set_compression>. +but you can override this behavior with the method set_compression(). If you don't open the file explicitly, it will be auto-opened on the first read or write operation based on the filename set at creation time -(or later with the C<set_filename> method). +(or later with the set_filename() method). Once a file has been opened, the filehandle must be closed before being able to open another file. @@ -92,11 +92,11 @@ use parent qw(IO::File Tie::Handle); The standard functions acting on filehandles should accept a Dpkg::Compression::FileHandle object transparently including -C<open> (only when using the variant with 3 parameters), C<close>, -C<binmode>, C<eof>, C<fileno>, C<getc>, C<print>, C<printf>, C<read>, -C<sysread>, C<say>, C<write>, C<syswrite>, C<seek>, C<sysseek>, C<tell>. +open() (only when using the variant with 3 parameters), close(), +binmode(), eof(), fileno(), getc(), print(), printf(), read(), +sysread(), say(), write(), syswrite(), seek(), sysseek(), tell(). -Note however that C<seek> and C<sysseek> will only work on uncompressed +Note however that seek() and sysseek() will only work on uncompressed files as compressed files are really pipes to the compressor programs and you can't seek on a pipe. @@ -300,7 +300,7 @@ sub set_compression { =item $fh->set_compression_level($level) Indicate the desired compression level. It should be a value accepted -by the function C<compression_is_valid_level> of B<Dpkg::Compression>. +by the function compression_is_valid_level() of B<Dpkg::Compression>. =cut @@ -364,7 +364,7 @@ sub get_filename { Returns "0" if no compression is used and the compression method used otherwise. If the compression is set to "auto", the value returned -depends on the extension of the filename obtained with the B<get_filename> +depends on the extension of the filename obtained with the get_filename() method. =cut diff --git a/scripts/Dpkg/Compression/Process.pm b/scripts/Dpkg/Compression/Process.pm index 1332722b1..ee1862607 100644 --- a/scripts/Dpkg/Compression/Process.pm +++ b/scripts/Dpkg/Compression/Process.pm @@ -64,7 +64,7 @@ sub new { =item $proc->set_compression($comp) Select the compression method to use. It errors out if the method is not -supported according to C<compression_is_supported> (of +supported according to compression_is_supported() (of B<Dpkg::Compression>). =cut @@ -79,7 +79,7 @@ sub set_compression { =item $proc->set_compression_level($level) Select the compression level to use. It errors out if the level is not -valid according to C<compression_is_valid_level> (of +valid according to compression_is_valid_level() (of B<Dpkg::Compression>). =cut @@ -94,7 +94,7 @@ sub set_compression_level { =item @exec = $proc->get_uncompress_cmdline() -Returns a list ready to be passed to C<exec>, its first element is the +Returns a list ready to be passed to exec(), its first element is the program name (either for compression or decompression) and the following elements are parameters for the program. @@ -136,9 +136,9 @@ sub _check_opts { Starts a compressor program. You must indicate where it will read its uncompressed data from and where it will write its compressed data to. This is accomplished by passing one parameter C<to_*> and one parameter -C<from_*> as accepted by B<Dpkg::IPC::spawn>. +C<from_*> as accepted by Dpkg::IPC::spawn(). -You must call C<wait_end_process> after having called this method to +You must call wait_end_process() after having called this method to properly close the sub-process (and verify that it exited without error). =cut @@ -159,9 +159,9 @@ sub compress { Starts a decompressor program. You must indicate where it will read its compressed data from and where it will write its uncompressed data to. This is accomplished by passing one parameter C<to_*> and one parameter -C<from_*> as accepted by B<Dpkg::IPC::spawn>. +C<from_*> as accepted by Dpkg::IPC::spawn(). -You must call C<wait_end_process> after having called this method to +You must call wait_end_process() after having called this method to properly close the sub-process (and verify that it exited without error). =cut @@ -179,10 +179,10 @@ sub uncompress { =item $proc->wait_end_process(%opts) -Call B<Dpkg::IPC::wait_child> to wait until the sub-process has exited +Call Dpkg::IPC::wait_child() to wait until the sub-process has exited and verify its return code. Any given option will be forwarded to -the C<wait_child> function. Most notably you can use the "nocheck" option -to verify the return code yourself instead of letting C<wait_child> do +the wait_child() function. Most notably you can use the "nocheck" option +to verify the return code yourself instead of letting wait_child() do it for you. =cut -- Dpkg.Org's dpkg
