flux_kvs_lookup: Documentation fixes #2138
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #2138 +/- ##
==========================================
- Coverage 80.45% 80.42% -0.04%
==========================================
Files 200 200
Lines 31733 31733
==========================================
- Hits 25531 25520 -11
- Misses 6202 6213 +11
|
garlick
reviewed
Apr 29, 2019
doc/man3/flux_kvs_lookup.adoc
Outdated
| @@ -151,6 +152,11 @@ changed. Unlike FLUX_KVS_WATCH_UNIQ, the key being watched need not | |||
| be mentioned in a transaction. This may occur under several | |||
| scenarios, such as a parent directory being altered. | |||
|
|
|||
| FLUX_KVS_WAITCREATE:: | |||
| If a KVS key does not exist, wait for it to exist before returning. | |||
| This flag may be specified along with FLUX_KVS_WATCH. The lookup can | |||
There was a problem hiding this comment.
Should this say "with or without FLUX_KVS_WATCH"?
There was a problem hiding this comment.
I see, that would probably be clearer.
doc/man3/flux_kvs_lookup.adoc
Outdated
| @@ -96,8 +96,7 @@ lookup. | |||
|
|
|||
| `flux_kvs_lookup_cancel()` cancels a stream of lookup responses | |||
| requested with FLUX_KVS_WATCH or a waiting lookup response with | |||
| FLUX_KVS_WAITCREATE (see below). The future will be fulfilled with an | |||
| ENODATA error once the cancel request is received and processed. | |||
| FLUX_KVS_WAITCREATE. See `FLAGS` below for additional information. | |||
There was a problem hiding this comment.
FLAGS as a section heading should not be rendered monospace so the backticks are prob not the right choice. I looked at other man pages and when we reference sections, we have just listed the bare section name in caps.
Re-organize some text from flux_kvs_lookup_cancel() into FLAGS area, so it is more clear how to use it and avoid matchtag leaks. Fixes flux-framework#2012
|
re-pushed with fixes |
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Per #2012 , add
FLUX_KVS_WAITCREATE, reorganized & added some text to make it more clear howflux_kvs_lookup_cancel()should be used.