Fix some typos in the documentation

This commit is contained in:
Ronan Keryell
2021-02-19 13:48:28 -08:00
parent be1aa44e50
commit 81495e0883
3 changed files with 6 additions and 6 deletions
+3 -3
View File
@@ -252,7 +252,7 @@ This class implements __algo__; if the local ready-queue runs out of ready fiber
from other schedulers.[br]
The victim scheduler (from which a ready fiber is stolen) is selected at random.
[note Worker-threads are stored in a static variable, dynamically adding/removing worker threads is not supported.]
[note Worker-threads are stored in a static variable, dynamically adding/removing worker threads is not supported, neither having different worker thread realms at the same time.]
#include <boost/fiber/algo/work_stealing.hpp>
@@ -313,7 +313,7 @@ fiber scheduler).]]
[[Returns:] [the fiber at the head of the ready queue, or `nullptr` if the
queue is empty.]]
[[Throws:] [Nothing.]]
[[Note:] [Placing ready fibers onto the tail of the sahred queue, and returning them
[[Note:] [Placing ready fibers onto the tail of the shared queue, and returning them
from the head of that queue, shares the thread between ready fibers in
round-robin fashion.]]
]
@@ -362,7 +362,7 @@ This class implements __algo__, scheduling fibers in round-robin fashion.
Ready fibers are shared between all instances (running on different threads)
of shared_work, thus the work is distributed equally over all threads.
[note Worker-threads are stored in a static variable, dynamically adding/removing worker threads is not supported.]
[note Worker-threads are stored in a static variable, dynamically adding/removing worker threads is not supported, neither having different worker thread realms at the same time.]
#include <boost/fiber/algo/shared_work.hpp>
+1 -1
View File
@@ -90,7 +90,7 @@ private:
// sleep-queue contains context' which have been called
// scheduler::wait_until()
sleep_queue_type sleep_queue_{};
// worker-queue contains all context' mananged by this scheduler
// worker-queue contains all context' managed by this scheduler
// except main-context and dispatcher-context
// unlink happens on destruction of a context
worker_queue_type worker_queue_{};
+2 -2
View File
@@ -72,7 +72,7 @@ scheduler::sleep2ready_() noexcept {
sleep_queue_type::iterator e = sleep_queue_.end();
for ( sleep_queue_type::iterator i = sleep_queue_.begin(); i != e;) {
context * ctx = & ( * i);
// dipatcher context must never be pushed to sleep-queue
// dispatcher context must never be pushed to sleep-queue
BOOST_ASSERT( ! ctx->is_context( type::dispatcher_context) );
BOOST_ASSERT( main_ctx_ == ctx || ctx->worker_is_linked() );
BOOST_ASSERT( ! ctx->ready_is_linked() );
@@ -321,7 +321,7 @@ scheduler::has_ready_fibers() const noexcept {
void
scheduler::set_algo( algo::algorithm::ptr_t algo) noexcept {
// move remaining cotnext in current scheduler to new one
// move remaining context in current scheduler to new one
while ( algo_->has_ready_fibers() ) {
algo->awakened( algo_->pick_next() );
}