This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
document hostname(@args) deprecation
authorZefram <zefram@fysh.org>
Wed, 6 Dec 2017 16:28:18 +0000 (16:28 +0000)
committerZefram <zefram@fysh.org>
Wed, 6 Dec 2017 16:30:45 +0000 (16:30 +0000)
Passing arguments to Sys::Hostname::hostname() is already deprecated.
Note the deprecation's agreed removal version of Perl 5.32.  Also document
it in perldeprecation.pod.  [perl #124349]

ext/Sys-Hostname/Hostname.pm
pod/perldeprecation.pod

index d53410e..8b5dde1 100644 (file)
@@ -16,7 +16,7 @@ use warnings ();
 our $host;
 
 BEGIN {
-    $VERSION = '1.21';
+    $VERSION = '1.22';
     {
        local $SIG{__DIE__};
        eval {
@@ -29,7 +29,7 @@ BEGIN {
 
 
 sub hostname {
-  @_ and warnings::warnif("deprecated", "hostname() doesn't accept any arguments");
+  @_ and warnings::warnif("deprecated", "hostname() doesn't accept any arguments. This will become fatal in Perl 5.32");
 
   # method 1 - we already know it
   return $host if defined $host;
index bb1e8df..e929314 100644 (file)
@@ -56,6 +56,16 @@ C<vec> views its string argument as a sequence of bits.  A string
 containing a code point over 0xFF is nonsensical.  This usage is
 deprecated in Perl 5.28, and will be removed in Perl 5.32.
 
+=head3 hostname() doesn't accept any arguments
+
+The function C<hostname()> in the L<Sys::Hostname> module has always
+been documented to be called with no arguments.  Historically it has not
+enforced this, and has actually accepted and ignored any arguments.  As a
+result, some users have got the mistaken impression that an argument does
+something useful.  To avoid these bugs, the function is being made strict.
+Passing arguments was deprecated in Perl 5.28, and will become fatal in
+Perl 5.32.
+
 =head2 Perl 5.30
 
 =head3 C<< $* >> is no longer supported