Update Tidy function comment

This commit is contained in:
vishalnayak 2017-05-04 12:11:00 -04:00
parent d74b1b284a
commit 5683430cb7
1 changed files with 6 additions and 1 deletions

View File

@ -120,7 +120,12 @@ func (c *Core) stopExpiration() error {
return nil return nil
} }
// Tidy cleans up stale leases which are associated with invalid tokens // Tidy cleans up the dangling storage entries for leases. It scans the storage
// view to find all the available leases, checks if the token embedded in it is
// either empty or invalid and in both the cases, it revokes them. It also uses
// a token cache to avoid multiple lookups of the same token ID. It is normally
// not required to use the API that invokes this. This is only intended to
// clean up the corrupt storage due to bugs.
func (m *ExpirationManager) Tidy() error { func (m *ExpirationManager) Tidy() error {
var tidyErrors *multierror.Error var tidyErrors *multierror.Error