RepoMirrors/go-ceph
1
0
Fork 0
mirror of https://github.com/ceph/go-ceph synced 2024-12-23 06:33:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

rados: fix doc comments for omap related functions

Browse Source 
This is a minor cleanup that only stops the checker from complaining
rather than actually improving the documentation.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
This commit is contained in:
John Mulligan 2020-02-05 14:32:21 -05:00 committed by Niels de Vos
parent f29d760894
commit 970300d25a
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
rados/omap.go
View File

@ -70,7 +70,9 @@ func (ioctx *IOContext) SetOmap(oid string, pairs map[string][]byte) error {
// visited by ListOmapValues // visited by ListOmapValues
type OmapListFunc func(key string, value []byte) type OmapListFunc func(key string, value []byte)
// Iterate on a set of keys and their values from an omap // ListOmapValues iterates over the keys and values in an omap by way of
// a callback function.
//
// `startAfter`: iterate only on the keys after this specified one // `startAfter`: iterate only on the keys after this specified one
// `filterPrefix`: iterate only on the keys beginning with this prefix // `filterPrefix`: iterate only on the keys beginning with this prefix
// `maxReturn`: iterate no more than `maxReturn` key/value pairs // `maxReturn`: iterate no more than `maxReturn` key/value pairs
@ -131,7 +133,7 @@ func (ioctx *IOContext) ListOmapValues(oid string, startAfter string, filterPref
return nil return nil
} }
// Fetch a set of keys and their values from an omap and returns then as a map // GetOmapValues fetches a set of keys and their values from an omap and returns then as a map
// `startAfter`: retrieve only the keys after this specified one // `startAfter`: retrieve only the keys after this specified one
// `filterPrefix`: retrieve only the keys beginning with this prefix // `filterPrefix`: retrieve only the keys beginning with this prefix
// `maxReturn`: retrieve no more than `maxReturn` key/value pairs // `maxReturn`: retrieve no more than `maxReturn` key/value pairs
@ -148,7 +150,7 @@ func (ioctx *IOContext) GetOmapValues(oid string, startAfter string, filterPrefi
return omap, err return omap, err
} }
// Fetch all the keys and their values from an omap and returns then as a map // GetAllOmapValues fetches all the keys and their values from an omap and returns then as a map
// `startAfter`: retrieve only the keys after this specified one // `startAfter`: retrieve only the keys after this specified one
// `filterPrefix`: retrieve only the keys beginning with this prefix // `filterPrefix`: retrieve only the keys beginning with this prefix
// `iteratorSize`: internal number of keys to fetch during a read operation // `iteratorSize`: internal number of keys to fetch during a read operation