Enable beman-tidy (--require-all mode) into beman.execution#291
Merged
Conversation
|
coverage: 93.858%. remained the same — neatudarius-patch-2 into main |
dietmarkuehl
force-pushed
the
neatudarius-patch-2
branch
from
85136aa to
fc19624
Compare
There was a problem hiding this comment.
Pull request overview
This PR updates beman.execution to align with beman-tidy --require-all by introducing top-level “umbrella” headers (<beman/execution.hpp> and <beman/stop_token.hpp>) and switching tests/examples/docs to include those headers instead of the deeper <beman/execution/execution.hpp> / <beman/execution/stop_token.hpp> paths. It also normalizes several example/doc filenames to underscore style and enables --require-all in the pre-commit configuration.
Changes:
- Add new public wrapper headers:
include/beman/execution.hppandinclude/beman/stop_token.hpp, and wire them into the library’s header install set. - Update tests, examples, and
execution26headers to include the new umbrella headers. - Update documentation (README + docs) to reference the new include paths and renamed example/doc filenames; enable
beman-tidy --require-allin pre-commit.
Reviewed changes
Copilot reviewed 161 out of 161 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/beman/execution/thread.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/thread-stoptoken.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/thread-stoptoken-syn.compile.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/thread-stoptoken-intro.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stoptoken.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stoptoken-never.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stoptoken-never-general.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stoptoken-mem.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stoptoken-inplace.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stoptoken-inplace-members.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stoptoken-inplace-general.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stoptoken-general.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stoptoken-concepts.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopsource.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopsource-mem.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopsource-inplace.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopsource-inplace-mem.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopsource-inplace-general.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopsource-inplace-cons.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopsource-general.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopsource-cons.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopcallback.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopcallback-inplace.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopcallback-inplace-general.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopcallback-inplace-cons.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopcallback-general.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/stopcallback-cons.test.cpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/notify.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/issue-186.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/issue-174.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/issue-144.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/include/test/thread_pool.hpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/include/test/stop_token.hpp | Switch stop-token include to <beman/stop_token.hpp> |
| tests/beman/execution/function-objects.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/execution-syn.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/execution-queryable-concept.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-with-awaitable-senders.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-when-all.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-utils-cmplsigs.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-sync-wait.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-sync-wait-with-variant.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-starts-on.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-split.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-snd-transform.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-snd-expos.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-snd-concepts.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-set-value.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-set-stopped.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-set-error.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-sender-adaptor-closure.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-recv.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-recv-concepts.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-parallel-scheduler.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-opstate-start.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-inline-scheduler.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-getcomplsigs.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-get-stop-token.test.cpp | Switch execution + stop-token includes to umbrella headers |
| tests/beman/execution/exec-get-env.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-get-domain.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-get-allocator.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-general.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-fwd-env.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-continues-on.test.cpp | Switch execution include to <beman/execution.hpp> |
| tests/beman/execution/exec-bulk.test.cpp | Switch execution include to <beman/execution.hpp> |
| src/beman/execution/CMakeLists.txt | Add umbrella headers to installed/public header set |
| README.md | Update formatting and add “Try on Compiler Explorer” badge |
| include/beman/stop_token.hpp | New umbrella header for stop_token |
| include/beman/execution26/stop_token.hpp | Point execution26 stop-token header at <beman/stop_token.hpp> |
| include/beman/execution26/execution.hpp | Point execution26 umbrella at <beman/execution.hpp> |
| include/beman/execution/stop_token.hpp | Banner comment updated (but currently incorrect) |
| include/beman/execution/execution.hpp | Banner comment updated (but currently incorrect) |
| include/beman/execution/detail/within.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/then.hpp | Doxygen \headerfile + examples updated to <beman/execution.hpp> |
| include/beman/execution/detail/sync_wait.hpp | Doxygen \headerfile + examples updated to <beman/execution.hpp> |
| include/beman/execution/detail/stop_source_of.hpp | Switch stop-token include to <beman/stop_token.hpp> |
| include/beman/execution/detail/state_rep.hpp | Switch include to <beman/execution.hpp> |
| include/beman/execution/detail/set_value.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/set_stopped.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/set_error.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/sender_adaptor_closure.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/scheduler_tag.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/promise_env.hpp | Switch include to <beman/execution.hpp> |
| include/beman/execution/detail/just.hpp | Doxygen \headerfile + example names updated |
| include/beman/execution/detail/handle.hpp | Switch include to <beman/execution.hpp> |
| include/beman/execution/detail/fwd_env.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/forwarding_query.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/forward_like.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/exit_scope_sender.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/exit_scope_sender_of_t.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/exit_scope_sender_in.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/error_types_of.hpp | Switch include to <beman/execution.hpp> |
| include/beman/execution/detail/error_types_of_t.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/env_type.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/env_promise.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/env_of_t.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/enter_scope_sender.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/enter_scope_sender_in.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/emplace_from.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/default_impls.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/decays_to.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/decayed_typeof.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/decayed_tuple.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/decayed_same_as.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/connect.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/connect_result_t.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/connect_awaitable.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/connect_all.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/connect_all_result.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/completion.hpp | Switch include to <beman/execution.hpp> |
| include/beman/execution/detail/completion_tag.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/completion_signatures.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/completion_signatures_of_t.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/completion_signatures_for.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/completion_signature.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/common.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/class_type.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/child_type.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/check_type_alias_exist.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/callable.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/call_result_t.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/basic_state.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/basic_sender.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/basic_receiver.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/basic_operation.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/await_suspend_result.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/await_result_type.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/as_except_ptr.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/as_awaitable.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/apply_sender.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/almost_scheduler.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution/detail/allocator_aware_move.hpp | Doxygen \headerfile updated to <beman/execution.hpp> |
| include/beman/execution.hpp | New umbrella header for execution |
| examples/when_all_cancel.cpp | Switch includes to <beman/execution.hpp> + <beman/stop_token.hpp>; rename banner |
| examples/suspend_never.cpp | Switch include to <beman/execution.hpp> |
| examples/stopping.cpp | Switch includes to <beman/execution.hpp> + <beman/stop_token.hpp> |
| examples/stop_token.cpp | Switch includes to <beman/execution.hpp> + <beman/stop_token.hpp> |
| examples/stackoverflow.cpp | Switch include to <beman/execution.hpp> |
| examples/sender_demo.cpp | Switch include to <beman/execution.hpp>; rename banner |
| examples/playground.cpp | Switch include to <beman/execution.hpp> |
| examples/modules_and_header.cpp | Rename banner to underscore style |
| examples/just_stopped.cpp | Switch include to <beman/execution.hpp> |
| examples/intro_timer.hpp | Rename banner to underscore style |
| examples/intro_5_consumer.cpp | Switch include to <beman/execution.hpp>; rename banner |
| examples/intro_2_hello_async.cpp | Switch include to <beman/execution.hpp>; update local includes + doc path |
| examples/intro_1_hello_world.cpp | Switch include to <beman/execution.hpp>; update doc path |
| examples/inspect.cpp | Switch include to <beman/execution.hpp> |
| examples/doc_just.cpp | Switch include to <beman/execution.hpp>; rename banner |
| examples/doc_just_stopped.cpp | Switch include to <beman/execution.hpp>; rename banner |
| examples/doc_just_error.cpp | Switch include to <beman/execution.hpp>; rename banner |
| examples/CMakeLists.txt | Update example target names to underscore style |
| examples/allocator.cpp | Switch include to <beman/execution.hpp> |
| docs/tutorial.mds | Update include snippets and referenced helper filenames |
| docs/modules.md | Update documentation include path |
| docs/intro_examples.md | Update example filenames and include snippet |
| docs/code/tst.hpp | Rename includes to underscore helper headers |
| docs/code/tst_timer.hpp | Rename banner + includes to underscore helper header |
| docs/code/tst_sync_wait.hpp | Rename banner + includes to underscore helper header |
| docs/code/tst_repeat_effect_until.hpp | Rename banner + includes to underscore helper header |
| docs/code/tst_config.hpp | Rename banner + include <beman/execution.hpp> |
| docs/code/tst_basic_timer.cpp | Rename banner + include <beman/execution.hpp> |
| .pre-commit-config.yaml | Enable beman-tidy --require-all |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+245
to
249
| * <pre example="doc_just_error.cpp"> | ||
| * #include <beman/execution.hpp> | ||
| * #include <system_error> | ||
| * #include <cassert> | ||
| * namespace ex = beman::execution; |
Comment on lines
+4
to
+9
| #ifndef INCLUDED_INCLUDE_BEMAN_STOP_TOKEN | ||
| #define INCLUDED_INCLUDE_BEMAN_STOP_TOKEN | ||
|
|
||
| #include <beman/execution/stop_token.hpp> | ||
|
|
||
| #endif |
| [`beman::execution`](https://github.com/bemanproject/execution) are | ||
| used. The used names are set up via | ||
| [`docs/code/tst-config.hpp`](https://github.com/bemanproject/execution/files/docs/code/tst-config.hpp). | ||
| [`docs/code/tst_config.hpp`](https://github.com/bemanproject/execution/files/docs/code/tst_config.hpp). |
| <!-- markdownlint-disable line-length --> | ||
| [](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#the-beman-library-maturity-model) | ||
|  [](https://coveralls.io/github/bemanproject/execution?branch=main) | ||
| [](https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#the-beman-library-maturity-model)[](https://coveralls.io/github/bemanproject/execution?branch=main)[](https://godbolt.org/z/9nfa3rTTK) |
| @@ -1,4 +1,4 @@ | |||
| // include/beman/execution/stop_token.hpp -*-C++-*- | |||
| // include/beman/stop_token.hpp -*-C++-*- | |||
| @@ -1,4 +1,4 @@ | |||
| // include/beman/execution/execution.hpp -*-C++-*- | |||
| // include/beman/execution.hpp -*-C++-*- | |||
This file contains hidden or 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
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.
Issue: bemanproject/beman-tidy#255