summaryrefslogtreecommitdiff
path: root/rts/Task.h
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2019-12-01 11:44:28 -0500
committerBen Gamari <ben@smart-cactus.org>2020-10-24 20:59:39 -0400
commitb3ce6acaae1b386aeca6649738cf286ad71ed5cd (patch)
tree1939584ecd175a90795439fc0a3ee2e2587cc108 /rts/Task.h
parent65136c134d1b6e2f2c5d7193fade3c99a8cb81c4 (diff)
downloadhaskell-b3ce6acaae1b386aeca6649738cf286ad71ed5cd.tar.gz
rts/Task: Make comments proper Notes
Diffstat (limited to 'rts/Task.h')
-rw-r--r--rts/Task.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/rts/Task.h b/rts/Task.h
index 17bcbe2da4..cf12ca232c 100644
--- a/rts/Task.h
+++ b/rts/Task.h
@@ -16,8 +16,8 @@
#include "BeginPrivate.h"
/*
- Definition of a Task
- --------------------
+ Note [Definition of a Task]
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
A task is an OSThread that runs Haskell code. Every OSThread that
runs inside the RTS, whether as a worker created by the RTS or via
@@ -33,8 +33,8 @@
Haskell code simultaneously. A task relinquishes its Capability
when it is asked to evaluate an external (C) call.
- Ownership of Task
- -----------------
+ Note [Ownership of Task]
+ ~~~~~~~~~~~~~~~~~~~~~~~~
Task ownership is a little tricky. The default situation is that
the Task is an OS-thread-local structure that is owned by the OS