From: Rafael Garcia-Suarez <rgarciasuarez@gmail.com>
Date: Wed, 31 Aug 2005 15:14:28 +0000 (+0000)
Subject: Document that Sys::Syslog::openlog might die.
X-Git-Tag: perl-5.9.3~1234
X-Git-Url: https://perl5.git.perl.org/perl5.git/commitdiff_plain/b91ed0194cb2707fc4bb2619e1294e4287626407

Document that Sys::Syslog::openlog might die.
Fixes [perl #36848] Sys::Syslog::syslog kills program if syslogd not running

p4raw-id: //depot/perl@25342
---

diff --git a/ext/Sys/Syslog/Syslog.pm b/ext/Sys/Syslog/Syslog.pm
index 7581bcb..c56d37c 100644
--- a/ext/Sys/Syslog/Syslog.pm
+++ b/ext/Sys/Syslog/Syslog.pm
@@ -53,13 +53,15 @@ Syslog provides the functions:
 
 =item openlog $ident, $logopt, $facility
 
+Opens the syslog.
 I<$ident> is prepended to every message.  I<$logopt> contains zero or
 more of the words I<pid>, I<ndelay>, I<nowait>.  The cons option is
 ignored, since the failover mechanism will drop down to the console
 automatically if all other media fail.  I<$facility> specifies the
 part of the system to report about, for example LOG_USER or LOG_LOCAL0:
 see your C<syslog(3)> documentation for the facilities available in
-your system.
+your system. This function will croak if it can't connect to the syslog
+daemon.
 
 B<You should use openlog() before calling syslog().>