Skip to content
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

flux_kvs_lookup: Documentation fixes #2138

Merged
merged 2 commits into from Apr 29, 2019

Conversation

@chu11
Copy link
Contributor

commented Apr 24, 2019

Per #2012 , add FLUX_KVS_WAITCREATE, reorganized & added some text to make it more clear how flux_kvs_lookup_cancel() should be used.

@codecov-io

This comment has been minimized.

Copy link

commented Apr 24, 2019

Codecov Report

Merging #2138 into master will decrease coverage by 0.03%.
The diff coverage is n/a.

@@            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
Impacted Files Coverage Δ
src/modules/job-ingest/worker.c 65.03% <0%> (-7.7%) ⬇️
src/modules/connector-local/local.c 73.62% <0%> (-1.04%) ⬇️
src/broker/modservice.c 78.84% <0%> (-0.97%) ⬇️
src/broker/module.c 82.74% <0%> (+0.26%) ⬆️
src/common/libutil/dirwalk.c 94.4% <0%> (+0.69%) ⬆️
src/common/libflux/mrpc.c 88.93% <0%> (+1.18%) ⬆️
src/modules/barrier/barrier.c 80.53% <0%> (+2.01%) ⬆️
Copy link
Member

left a comment

Looks good, thanks for the cleanup! I left a couple of minor review comments.

@@ -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

This comment has been minimized.

Copy link
@garlick

garlick Apr 29, 2019

Member

Should this say "with or without FLUX_KVS_WATCH"?

This comment has been minimized.

Copy link
@chu11

chu11 Apr 29, 2019

Author Contributor

I see, that would probably be clearer.

@@ -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.

This comment has been minimized.

Copy link
@garlick

garlick Apr 29, 2019

Member

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.

chu11 added 2 commits Apr 24, 2019
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 #2012
@chu11 chu11 force-pushed the chu11:issue2012 branch from 2ddbc70 to 384244a Apr 29, 2019
@chu11

This comment has been minimized.

Copy link
Contributor Author

commented Apr 29, 2019

re-pushed with fixes

@garlick

This comment has been minimized.

Copy link
Member

commented Apr 29, 2019

Thanks!

@garlick garlick merged commit 6475001 into flux-framework:master Apr 29, 2019
4 checks passed
4 checks passed
Mergify — Summary 1 potential rule
Details
codecov/patch Coverage not affected when comparing a6852e3...384244a
Details
codecov/project 80.44% (-0.01%) compared to a6852e3
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.