From ab02cd27c0b4fe9e3996e9d5d388b30d36d51045 Mon Sep 17 00:00:00 2001 From: John Mulligan Date: Thu, 5 Dec 2019 13:58:18 -0500 Subject: [PATCH] ceph: expand doc to go a bit Make the doc comment in doc.go a bit more fleshed out with pointers to the real functionality of the library. Signed-off-by: John Mulligan --- doc.go | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/doc.go b/doc.go index 491166c..2344717 100644 --- a/doc.go +++ b/doc.go @@ -1,5 +1,16 @@ /* -Set of wrappers around Ceph APIs. +Package ceph is the root of a set of packages that wrap the Ceph APIs. + +Generally, this package only exists to host subsystem specific packages +and contains no functions. + +The "rados" sub-package wraps APIs that handle RADOS specific functions. + +The "rdb" sub-package wraps APIs that handle RBD specific functions. + +The "cephfs" sub-package wraps APIs that handle CephFS specific functions. + +Consult the documentation for each package for additional details. */ package ceph