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

Merge pull request #89 from CodeLingoBot/rewrite 

Fix function comments based on best practices from Effective Go
This commit is contained in:
John Mulligan 2019-12-11 19:56:20 -05:00 committed by GitHub
parent 2d52744470 9e2fbe369f
commit 5ea85a9419
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
rados/conn.go
View File

@ -175,7 +175,7 @@ func (c *Conn) ensure_connected() error {
}
}
// GetClusterStat returns statistics about the cluster associated with the
// GetClusterStats returns statistics about the cluster associated with the
// connection.
func (c *Conn) GetClusterStats() (stat ClusterStat, err error) {
if err := c.ensure_connected(); err != nil {
@ -317,7 +317,7 @@ func (c *Conn) MonCommand(args []byte) (buffer []byte, info string, err error) {
return c.monCommand(args, nil)
}
// MonCommand sends a command to one of the monitors, with an input buffer
// MonCommandWithInputBuffer sends a command to one of the monitors, with an input buffer
func (c *Conn) MonCommandWithInputBuffer(args, inputBuffer []byte) (buffer []byte, info string, err error) {
return c.monCommand(args, inputBuffer)
}

20
rados/ioctx.go
View File

@ -356,7 +356,7 @@ func (ioctx *IOContext) ListXattrs(oid string) (map[string][]byte, error) {
}
}
// Remove an xattr with key `name` from object `oid`
// RmXattr removes an xattr with key `name` from object `oid`
func (ioctx *IOContext) RmXattr(oid string, name string) error {
c_oid := C.CString(oid)
c_name := C.CString(name)
@ -541,7 +541,7 @@ func (ioctx *IOContext) GetAllOmapValues(oid string, startAfter string, filterPr
return omap, nil
}
// Remove the specified `keys` from the omap `oid`
// RmOmapKeys removes the specified `keys` from the omap `oid`
func (ioctx *IOContext) RmOmapKeys(oid string, keys []string) error {
c_oid := C.CString(oid)
defer C.free(unsafe.Pointer(c_oid))
@ -572,7 +572,7 @@ func (ioctx *IOContext) RmOmapKeys(oid string, keys []string) error {
return GetRadosError(int(ret))
}
// Clear the omap `oid`
// CleanOmap clears the omap `oid`
func (ioctx *IOContext) CleanOmap(oid string) error {
c_oid := C.CString(oid)
defer C.free(unsafe.Pointer(c_oid))
@ -595,7 +595,7 @@ type Iter struct {
type IterToken uint32
// Return a Iterator object that can be used to list the object names in the current pool
// Iter returns a Iterator object that can be used to list the object names in the current pool
func (ioctx *IOContext) Iter() (*Iter, error) {
iter := Iter{}
if cerr := C.rados_nobjects_list_open(ioctx.ioctx, &iter.ctx); cerr < 0 {
@ -604,7 +604,7 @@ func (ioctx *IOContext) Iter() (*Iter, error) {
return &iter, nil
}
// Returns a token marking the current position of the iterator. To be used in combination with Iter.Seek()
// Token returns a token marking the current position of the iterator. To be used in combination with Iter.Seek()
func (iter *Iter) Token() IterToken {
return IterToken(C.rados_nobjects_list_get_pg_hash_position(iter.ctx))
}
@ -639,7 +639,7 @@ func (iter *Iter) Next() bool {
return true
}
// Returns the current value of the iterator (object name), after a successful call to Next.
// Value returns the current value of the iterator (object name), after a successful call to Next.
func (iter *Iter) Value() string {
if iter.err != nil {
return ""
@ -647,7 +647,7 @@ func (iter *Iter) Value() string {
return iter.entry
}
// Returns the namespace associated with the current value of the iterator (object name), after a successful call to Next.
// Namespace returns the namespace associated with the current value of the iterator (object name), after a successful call to Next.
func (iter *Iter) Namespace() string {
if iter.err != nil {
return ""
@ -655,7 +655,7 @@ func (iter *Iter) Namespace() string {
return iter.namespace
}
// Checks whether the iterator has encountered an error.
// Err checks whether the iterator has encountered an error.
func (iter *Iter) Err() error {
if iter.err == RadosErrorNotFound {
return nil
@ -669,7 +669,7 @@ func (iter *Iter) Close() {
C.rados_nobjects_list_close(iter.ctx)
}
// Take an exclusive lock on an object.
// LockExclusive takes an exclusive lock on an object.
func (ioctx *IOContext) LockExclusive(oid, name, cookie, desc string, duration time.Duration, flags *byte) (int, error) {
c_oid := C.CString(oid)
c_name := C.CString(name)
@ -717,7 +717,7 @@ func (ioctx *IOContext) LockExclusive(oid, name, cookie, desc string, duration t
}
}
// Take a shared lock on an object.
// LockShared takes a shared lock on an object.
func (ioctx *IOContext) LockShared(oid, name, cookie, tag, desc string, duration time.Duration, flags *byte) (int, error) {
c_oid := C.CString(oid)
c_name := C.CString(name)