RepoMirrors
/
go-ceph
mirror of https://github.com/ceph/go-ceph
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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 <jmulligan@redhat.com>
This commit is contained in:
John Mulligan 2019-12-05 13:58:18 -05:00 committed by John Mulligan
parent 9460b11d88
commit ab02cd27c0
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc.go
View File

@ -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