Add documentation for several packages.

sdg0919 · Jun 25, 2016 · 0bfacc7 · 0bfacc7
1 parent 7229e27
commit 0bfacc7
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 0 deletions.
diff --git a/logfwd/doc.go b/logfwd/doc.go
@@ -0,0 +1,8 @@
+// Copyright 2016 Canonical Ltd.
+// Licensed under the AGPLv3, see LICENCE file for details.
+
+// The logfwd package contains the tools needed to do log record
+// forwarding in juju. The common code sits at the top level. The
+// different forwarding targets (e.g. syslog) are provided through
+// sub-packages.
+package logfwd
diff --git a/logfwd/syslog/doc.go b/logfwd/syslog/doc.go
@@ -0,0 +1,6 @@
+// Copyright 2016 Canonical Ltd.
+// Licensed under the AGPLv3, see LICENCE file for details.
+
+// The syslog package holds the tools needed to perform log forwarding
+// from Juju to a remote syslog (RFC 5424) host.
+package syslog
diff --git a/standards/rfc5424/doc.go b/standards/rfc5424/doc.go
@@ -0,0 +1,7 @@
+// Copyright 2016 Canonical Ltd.
+// Licensed under the AGPLv3, see LICENCE file for details.
+
+// The rfc5424 package holds an implementation of a RFC 5424 syslog
+// client along with types and functions that facilitate complying
+// with the RFC.
+package rfc5424
diff --git a/standards/rfc5424/sdelements/doc.go b/standards/rfc5424/sdelements/doc.go
@@ -0,0 +1,6 @@
+// Copyright 2016 Canonical Ltd.
+// Licensed under the AGPLv3, see LICENCE file for details.
+
+// The sdelements package holds the implementations of the different
+// RFC 5424 structured data elements.
+package sdelements
diff --git a/standards/tls/doc.go b/standards/tls/doc.go
@@ -0,0 +1,6 @@
+// Copyright 2016 Canonical Ltd.
+// Licensed under the AGPLv3, see LICENCE file for details.
+
+// The tls package holds utilities and abstractions that build
+// out functionality on top of the stdlib crypto/tls package.
+package tls