summaryrefslogtreecommitdiff
path: root/sd_daemon/doc.go
diff options
context:
space:
mode:
authorLuke Shumaker <lukeshu@sbcglobal.net>2016-12-27 21:59:17 -0700
committerLuke Shumaker <lukeshu@sbcglobal.net>2016-12-27 21:59:17 -0700
commit963644c19058829f74bd7d19a484c0786d6777cd (patch)
treec827fc6b5245aec2fc78aaf29eb0552f1e8bce41 /sd_daemon/doc.go
parent13cdadaf934e6079f7a835cd680cf0ffe89d6ca6 (diff)
Documentation improvements.
Also, I renamed a couple of the sd_id128 functions for better clarity. But since I haven't pushed since originally implementing them, I'm not labeling it as a breaking change.
Diffstat (limited to 'sd_daemon/doc.go')
-rw-r--r--sd_daemon/doc.go8
1 files changed, 6 insertions, 2 deletions
diff --git a/sd_daemon/doc.go b/sd_daemon/doc.go
index 90616f6..927ac7f 100644
--- a/sd_daemon/doc.go
+++ b/sd_daemon/doc.go
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-// Package sd_daemon provides functions for writing "new-style"
+// Package sd_daemon implements utilities for writing "new-style"
// daemons.
//
// The daemon(7) manual page has historically documented the very long
@@ -24,7 +24,11 @@
// systemd, they are all very simple mechanisms which can easily be
// implemented with a variety of service managers.
//
-// [daemon(7)]: https://www.freedesktop.org/software/systemd/man/daemon.html
+// daemon(7): https://www.freedesktop.org/software/systemd/man/daemon.html
+//
+// BUG(lukeshu): Logically, sd_id128.GetInvocationID might belong in
+// this package, but we defer to the C-language libsystemd's placement
+// of sd_id128_get_invocation() in sd-id128.h.
package sd_daemon
import "errors"