Rearrange public API headers#4841
Conversation
a23c64e to
afa8750
Compare
afa8750 to
1109820
Compare
|
Flyby: I had completely forgotten to add most of the synchronization primitives to the API page, now they're there. Question: Should we already add the trio Edit: I've now added headers for |
9783f00 to
eed6733
Compare
|
I find this a bit strange. Why not have and inside the and not leave it to chance that the user 'knows' every module that has local and distributed versions? |
I'm quite honestly unsure if we agree or disagree here. That sounds exactly like what I've done. See e.g. |
eed6733 to
1353c5d
Compare
|
Sorry. I completely misunderstood the PR and got the diffs the wrong way around. Please proceed and ignore my comments. |
As discussed with @hkaiser and @aurianer. We decided to change
hpx/x.hppheaders to include both distributed and local headers wherever it fits (likefuture.hppandruntime.hpp, more in the future), and the distributed header is conditionally included depending on if the distributed runtime is enabled in the configuration.Users that really always only want the local functionality should include
hpx/local/x.hpp. Not everything has a header inhpx/localorhpx/distributedas it doesn't make sense for everything. Should we add dummy headershpx/local/x.hpp/hpx/distributed/x.hpp(that would just include the same ashpx/x.hpp) for some sort of symmetry? (I vote no, since it's just more to maintain and the cases where the split is needed will be listed in the documentation.)Extra: I moved most of the API headers to the
includemodule where it's a bit easier to have an overview of them.