docs: remove all PREVIEW comments

Signed-off-by: Sven Anderson <sven@redhat.com>
This commit is contained in:
Sven Anderson 2022-05-19 20:08:31 +02:00 committed by mergify[bot]
parent 9f55b65d17
commit f4fb583252
14 changed files with 0 additions and 32 deletions

View File

@ -15,7 +15,6 @@ type Admin struct {
// NewFromConn creates an new management object from a preexisting
// rados connection. The existing connection can be rados.Conn or any
// type implementing the RadosCommander interface.
// PREVIEW
func NewFromConn(conn ccom.RadosCommander) *Admin {
return &Admin{conn}
}

View File

@ -108,7 +108,6 @@ func parseExportInfo(res commands.Response) (ExportInfo, error) {
}
// CreateCephFSExport will create a new NFS export for a CephFS file system.
// PREVIEW
//
// Similar To:
// ceph nfs export create cephfs
@ -126,7 +125,6 @@ func (nfsa *Admin) CreateCephFSExport(spec CephFSExportSpec) (
const delSucc = "Successfully deleted export"
// RemoveExport will remove an NFS export based on the pseudo-path of the export.
// PREVIEW
//
// Similar To:
// ceph nfs export rm
@ -142,7 +140,6 @@ func (nfsa *Admin) RemoveExport(clusterID, pseudoPath string) error {
}
// ListDetailedExports will return a list of exports with details.
// PREVIEW
//
// Similar To:
// ceph nfs export ls --detailed
@ -166,7 +163,6 @@ func (nfsa *Admin) ListDetailedExports(clusterID string) ([]ExportInfo, error) {
// ExportInfo will return a structure describing the export specified by it's
// pseudo-path.
// PREVIEW
//
// Similar To:
// ceph nfs export info

View File

@ -10,13 +10,11 @@ import (
)
// SetWarnf sets the log.Printf compatible receiver for warning logs.
// PREVIEW
func SetWarnf(f func(format string, v ...interface{})) {
intLog.Warnf = f
}
// SetDebugf sets the log.Printf compatible receiver for debug logs.
// PREVIEW
func SetDebugf(f func(format string, v ...interface{})) {
intLog.Debugf = f
}

View File

@ -12,7 +12,6 @@ import "C"
// AssertVersion ensures that the object exists and that its internal version
// number is equal to "ver" before reading. "ver" should be a version number
// previously obtained with IOContext.GetLastVersion().
// PREVIEW
//
// Implements:
// void rados_read_op_assert_version(rados_read_op_t read_op,

View File

@ -16,7 +16,6 @@ import (
// SetLocator sets the key for mapping objects to pgs within an io context.
// Until a different locator key is set, all objects in this io context will be placed in the same pg.
// To reset the locator, an empty string must be set.
// PREVIEW
//
// Implements:
// void rados_ioctx_locator_set_key(rados_ioctx_t io, const char *key);

View File

@ -12,7 +12,6 @@ import "C"
// AssertVersion ensures that the object exists and that its internal version
// number is equal to "ver" before writing. "ver" should be a version number
// previously obtained with IOContext.GetLastVersion().
// PREVIEW
//
// Implements:
// void rados_read_op_assert_version(rados_read_op_t read_op,

View File

@ -10,7 +10,6 @@ package rados
import "C"
// Remove object.
// PREVIEW
//
// Implements:
// void rados_write_op_remove(rados_write_op_t write_op)

View File

@ -14,7 +14,6 @@ import (
)
// SetXattr sets an xattr.
// PREVIEW
//
// Implements:
// void rados_write_op_setxattr(rados_write_op_t write_op,

View File

@ -58,7 +58,6 @@ func (s *ReadOpOmapGetValsByKeysStep) update() error {
// ReadOpOmapGetValsByKeysStep's internal iterator.
// If there are no more elements to retrieve, (nil, nil) is returned.
// May be called only after Operate() finished.
// PREVIEW
func (s *ReadOpOmapGetValsByKeysStep) Next() (*OmapKeyValue, error) {
if !s.canIterate {
return nil, ErrOperationIncomplete
@ -88,7 +87,6 @@ func (s *ReadOpOmapGetValsByKeysStep) Next() (*OmapKeyValue, error) {
}
// GetOmapValuesByKeys starts iterating over specific key/value pairs.
// PREVIEW
//
// Implements:
// void rados_read_op_omap_get_vals_by_keys2(rados_read_op_t read_op,

View File

@ -49,7 +49,6 @@ func newReadOpReadStep() *ReadOpReadStep {
// Read bytes from offset into buffer.
// len(buffer) is the maximum number of bytes read from the object.
// buffer[:ReadOpReadStep.BytesRead] then contains object data.
// PREVIEW
//
// Implements:
// void rados_read_op_read(rados_read_op_t read_op,

View File

@ -69,7 +69,6 @@ var (
)
// Watch creates a Watcher for the specified object.
// PREVIEW
//
// A Watcher receives all notifications that are sent to the object on which it
// has been created. It exposes two read-only channels: Events() receives all
@ -103,7 +102,6 @@ func (ioctx *IOContext) Watch(obj string) (*Watcher, error) {
// WatchWithTimeout creates a watcher on an object. Same as Watcher(), but
// different timeout than the default can be specified.
// PREVIEW
//
// Implements:
// int rados_watch3(rados_ioctx_t io, const char *o, uint64_t *cookie,
@ -142,26 +140,22 @@ func (ioctx *IOContext) WatchWithTimeout(oid string, timeout time.Duration) (*Wa
}
// ID returns the WatcherId of the Watcher
// PREVIEW
func (w *Watcher) ID() WatcherID {
return w.id
}
// Events returns a read-only channel, that receives all notifications that are
// sent to the object of the Watcher.
// PREVIEW
func (w *Watcher) Events() <-chan NotifyEvent {
return w.events
}
// Errors returns a read-only channel, that receives all errors for the Watcher.
// PREVIEW
func (w *Watcher) Errors() <-chan error {
return w.errors
}
// Check on the status of a Watcher.
// PREVIEW
//
// Returns the time since it was last confirmed. If there is an error, the
// Watcher is no longer valid, and should be destroyed with the Delete() method.
@ -177,7 +171,6 @@ func (w *Watcher) Check() (time.Duration, error) {
}
// Delete the watcher. This closes both the event and error channel.
// PREVIEW
//
// Implements:
// int rados_unwatch2(rados_ioctx_t io, uint64_t cookie)
@ -203,7 +196,6 @@ func (w *Watcher) Delete() error {
// Notify sends a notification with the provided data to all Watchers of the
// specified object.
// PREVIEW
//
// CAUTION: even if the error is not nil. the returned slices
// might still contain data.
@ -213,7 +205,6 @@ func (ioctx *IOContext) Notify(obj string, data []byte) ([]NotifyAck, []NotifyTi
// NotifyWithTimeout is like Notify() but with a different timeout than the
// default.
// PREVIEW
//
// Implements:
// int rados_notify2(rados_ioctx_t io, const char* o, const char* buf, int buf_len,
@ -246,7 +237,6 @@ func (ioctx *IOContext) NotifyWithTimeout(obj string, data []byte, timeout time.
// Ack sends an acknowledgement with the specified response data to the notfier
// of the NotifyEvent. If a notify is not ack'ed, the originating Notify() call
// blocks and eventiually times out.
// PREVIEW
//
// Implements:
// int rados_notify_ack(rados_ioctx_t io, const char *o, uint64_t notify_id,
@ -276,7 +266,6 @@ func (ne *NotifyEvent) Ack(response []byte) error {
}
// WatcherFlush flushes all pending notifications of the cluster.
// PREVIEW
//
// Implements:
// int rados_watch_flush(rados_t cluster)

View File

@ -13,7 +13,6 @@ import (
)
// Rename a snapshot.
// PREVIEW
//
// Implements:
// int rbd_snap_rename(rbd_image_t image, const char *snapname,

View File

@ -17,7 +17,6 @@ type BucketLinkInput struct {
// UnlinkBucket unlink a bucket from a specified user
// Primarily useful for changing bucket ownership.
// PREVIEW
func (api *API) UnlinkBucket(ctx context.Context, link BucketLinkInput) error {
if link.UID == "" {
return errMissingUserID
@ -31,7 +30,6 @@ func (api *API) UnlinkBucket(ctx context.Context, link BucketLinkInput) error {
// LinkBucket will link a bucket to a specified user
// unlinking the bucket from any previous user
// PREVIEW
func (api *API) LinkBucket(ctx context.Context, link BucketLinkInput) error {
if link.UID == "" {
return errMissingUserID

View File

@ -41,7 +41,6 @@ func makeInvalidSubuserAccessLevelError(spec SubuserSpec) error {
// gracefully).
// CreateSubuser - https://docs.ceph.com/en/latest/radosgw/adminops/#create-subuser
// PREVIEW
func (api *API) CreateSubuser(ctx context.Context, user User, subuser SubuserSpec) error {
if user.ID == "" {
return errMissingUserID
@ -64,7 +63,6 @@ func (api *API) CreateSubuser(ctx context.Context, user User, subuser SubuserSpe
}
// RemoveSubuser - https://docs.ceph.com/en/latest/radosgw/adminops/#remove-subuser
// PREVIEW
func (api *API) RemoveSubuser(ctx context.Context, user User, subuser SubuserSpec) error {
if user.ID == "" {
return errMissingUserID
@ -84,7 +82,6 @@ func (api *API) RemoveSubuser(ctx context.Context, user User, subuser SubuserSpe
}
// ModifySubuser - https://docs.ceph.com/en/latest/radosgw/adminops/#modify-subuser
// PREVIEW
func (api *API) ModifySubuser(ctx context.Context, user User, subuser SubuserSpec) error {
if user.ID == "" {
return errMissingUserID