cybercyst/go
1
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-05-30 19:52:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

log/syslog: expand docs a bit to reduce confusion

Browse Source 
Fixes #15731

Change-Id: I6f4da0cbb3b6c93e175f5e384ffa118f383b7c3b
Reviewed-on: https://go-review.googlesource.com/45089
Reviewed-by: Ian Lance Taylor <iant@golang.org>
This commit is contained in:
Brad Fitzpatrick 2017-06-08 17:44:03 +00:00
parent 84890c72fc
commit 1570a27e78
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/log/syslog/syslog.go
View File

@ -102,15 +102,16 @@ type netConn struct {
// New establishes a new connection to the system log daemon. Each // New establishes a new connection to the system log daemon. Each
// write to the returned writer sends a log message with the given // write to the returned writer sends a log message with the given
// priority and prefix. // priority (a combination of the syslog facility and severity) and
// prefix tag. If tag is empty, the os.Args[0] is used.
func New(priority Priority, tag string) (*Writer, error) { func New(priority Priority, tag string) (*Writer, error) {
return Dial("", "", priority, tag) return Dial("", "", priority, tag)
} }
// Dial establishes a connection to a log daemon by connecting to // Dial establishes a connection to a log daemon by connecting to
// address raddr on the specified network. Each write to the returned // address raddr on the specified network. Each write to the returned
// writer sends a log message with the given facility, severity and // writer sends a log message with the facility and severity
// tag. // (from priority) and tag. If tag is empty, the os.Args[0] is used.
// If network is empty, Dial will connect to the local syslog server. // If network is empty, Dial will connect to the local syslog server.
// Otherwise, see the documentation for net.Dial for valid values // Otherwise, see the documentation for net.Dial for valid values
// of network and raddr. // of network and raddr.
@ -301,10 +302,10 @@ func (n *netConn) close() error {
return n.conn.Close() return n.conn.Close()
} }
// NewLogger creates a log.Logger whose output is written to // NewLogger creates a log.Logger whose output is written to the
// the system log service with the specified priority. The logFlag // system log service with the specified priority, a combination of
// argument is the flag set passed through to log.New to create // the syslog facility and severity. The logFlag argument is the flag
// the Logger. // set passed through to log.New to create the Logger.
func NewLogger(p Priority, logFlag int) (*log.Logger, error) { func NewLogger(p Priority, logFlag int) (*log.Logger, error) {
s, err := New(p, "") s, err := New(p, "")
if err != nil { if err != nil {