debugz

Documentation

Overview

Package debugz contains functionality for debugging. At some point it should be possible to delete this package.

Index

• Variables
• func DebugSleep(ctx context.Context)

Variables

var OptProgressDebugForce = options.NewBool(
	"debug.progress.force",
	nil,
	false,
	"DEBUG: Always render progress bars",
	`DEBUG: Always render progress bars, even when stderr is not a terminal, or
progress is not enabled. This is useful for testing the progress impl.`,
)

OptProgressDebugForce forces instantiation of progress bars, even if stderr is not a terminal. It should be removed when the progress impl is stable.

var OptProgressDebugSleep = options.NewDuration(
	"debug.progress.sleep",
	nil,
	0,
	"DEBUG: Sleep during operations to facilitate testing progress bars",
	`DEBUG: Sleep during operations to facilitate testing progress bars.`,
)

OptProgressDebugSleep configures DebugSleep. It should be removed when the progress impl is stable.

Functions

func DebugSleep

func DebugSleep(ctx context.Context)

DebugSleep sleeps for a period of time to facilitate testing the progress impl. It uses the value from OptProgressDebugSleep. This function (and OptProgressDebugSleep) should be removed when the progress impl is stable.