openstack/swift
Code Issues Proposed changes

Update diskfile docstring for get_ondisk_files

Browse Source 
The return value for diskfile.BaseDiskFileManager.get_ondisk_files is
a bit more rich than the current doc string describes; try to fill in
some gaps.

Co-Author: Alistair Coles <alistair.coles@hpe.com>

Change-Id: Ief10644825ead124e58f3da5693bbdc1c6dc31ed
This commit is contained in:
Mahati Chamarthy 2016-07-25 20:10:44 +05:30
parent dd512a3207
commit ccff366811
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
swift/obj/diskfile.py
View File

@ -749,10 +749,17 @@ class BaseDiskFileManager(object):
ts_file -> path to a .ts file or None
data_file -> path to a .data file or None
meta_file -> path to a .meta file or None
ctype_file -> path to a .meta file or None
and may contain keys:
ts_info -> a file info dict for a .ts file
data_info -> a file info dict for a .data file
meta_info -> a file info dict for a .meta file
ctype_info -> a file info dict for a .meta file which
contains the content-type value
unexpected -> a list of file paths for unexpected
files
possible_reclaim -> a list of file info dicts for possible
reclaimable files
obsolete -> a list of file info dicts for obsolete files
"""
# Build the exts data structure: