Skip to content

HDDS-5285. Document block deleting service classes#2296

Merged
cku328 merged 2 commits intoapache:masterfrom
sky76093016:HDDS-5285
Jun 9, 2021
Merged

HDDS-5285. Document block deleting service classes#2296
cku328 merged 2 commits intoapache:masterfrom
sky76093016:HDDS-5285

Conversation

@sky76093016
Copy link
Contributor

What changes were proposed in this pull request?

Add class-level javadoc for DeletedBlockLogStateManager and DeletedBlockLogStateManagerImpl.

What is the link to the Apache JIRA

https://issues.apache.org/jira/projects/HDDS/issues/HDDS-5285

How was this patch tested?

No test.


/**
* TODO: javadoc.
* DeletedBlockLogStateManager interface to provide BlocksTransaction
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can make this more verbose.

if you trace the code, you'll find it ultimately writes to SCMMetadataStore.getDeletedBlocksTXTable() which says "A Table that keeps the deleted blocks lists and transactions."

You might say it's an interface to manage deleted blocks and record them in the underlying persist store.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be a good proposal, let me revise it.

Copy link
Contributor

@cku328 cku328 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 Thanks @sky76093016 for the update.

@cku328 cku328 merged commit fb4436f into apache:master Jun 9, 2021
@cku328
Copy link
Contributor

cku328 commented Jun 9, 2021

PR merged.
Thanks @sky76093016 for the contribution and @jojochuang for the review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants