-
Notifications
You must be signed in to change notification settings - Fork 51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
kvs: Rename internal "commit" API to "kvstxn" API #1348
Conversation
For consistentcy with other portions of code in Flux, rename the internal "commit" API to avoid confusion with an actual "commit" RPC. Rename it to the "kvstxn" API. No logical code changes occurred in this commit. Search and replacing "commit" to "kvstxn" was mostly done. Some variables were renamed as a result (e.g. "cm" with "ktm"). Some functions were also renamed as a result for clarity (e.g. instead of "txn", used "transaction" in some locations). Minor comment adjustments as well.
For consistency in terminology, rename the #readycommits statistic to #readytransactions.
For consistency in terminology, rename commit-merge module option to transaction-merge. Update unit tests appropriately.
For consistency in terminology, rename test to transactionmerge test.
For consistency in terminology, rename several functions with "commit" in the name to "transaction".
Since this hasn't been merged yet, I went ahead and pushed my changes to the "fence" data structure. This handles bullet #2.
The TBD I chose was "treq", standing for transaction request. I chose this instead of "txnreq" b/c with the "kvstxn" API, I thought have the word "txn" all over the place was a bit confusing. Just like renaming the "commit" API, there were all these side cleanups I had to do as well. |
Codecov Report
@@ Coverage Diff @@
## master #1348 +/- ##
==========================================
- Coverage 78.54% 78.52% -0.02%
==========================================
Files 162 162
Lines 29618 29619 +1
==========================================
- Hits 23264 23259 -5
- Misses 6354 6360 +6
|
Oops, noticed one place I forgot to rename a variable. Went ahead and squashed it into the PR & repushed. |
restarted a builder, hit #731 |
For consistentcy with other portions of code in Flux, rename the internal "fence" API to avoid confusion with an actual "fence" RPC. Rename it to the "treq" API. No logical code changes occurred in this commit. Search and replacing "fence" to "treq" was mostly done. Some variables were renamed as a result (e.g. "fm" with "trm"). Some functions were also renamed as a result for clarity (e.g. instead of "fences", used "transactions" in some locations). Minor comment adjustments as well.
For consistency in terminology, rename the #fences statistic to #transactions. Update a unit test appropriately.
Shorten to treq_get_ops(), the json is superfluous.
For consistency in terminology, update use of the word "fence" throughout code. Update functions, variables, log messages, and strings with the name in it to use "transaction" or an appropriate term.
Oops, noticed one other place I forgot to rename a variable. Already squashed & repushed. |
Looks straightforward. I'll go ahead and merge. Thanks! |
Per discussion in #1344. I originally was going to do a lot more work before sending in a PR, but there were more "mini cleanups" to do a long the way than I realized, so I think it's a good stopping point for a PR. Per discussion in the issue, this PR handles the first bullet point I listed.
I chose to name the api
kvstxn
, as I wanted to differentiate this as not the normal "txn" API, as special things like merges and what not can occur.