add commentary to container reconciler code
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
OpenStack Object Storage (swift) |
Confirmed
|
Low
|
Unassigned |
Bug Description
The container reconciler process and code is potentially confusing to someone not familiar with the code. In particular, container db object tables are used to maintain queues of potentially misplaced objects, and the table columns are re-purposed e.g. 'etag' actually stores a timestamp, content-type stores an action command.
It would be kind to future maintainers to add some commentary in the code:
- an overview of what is happening at a high level
- highlight that where db row entries are assigned apparently incorrect values, that in fact it is not a bug
- explain some of the logic e.g. when and why tombstones are thrown
The code is mainly in swift/container
There is some discussion in the storage policies overview doc. I'm suggesting adding code comments, not docs.
tags: | added: low-hanging-fruit |
tags: | removed: low-hanging-fruit |
Changed in swift: | |
assignee: | Mohit Motiani (mohit-motiani) → nobody |
I can see most of the methods contains commentary. Do you want it in all the methods?