aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMike Holmes <mike.holmes@linaro.org>2016-01-05 12:34:33 -0500
committerMike Holmes <mike.holmes@linaro.org>2016-01-07 11:13:14 -0500
commitdb3656ee41116c40e98c95381f229217b91ef70d (patch)
tree44ec54bf00d7742a9009064129ec5c6f9e522513 /doc
parent15e594c9ae9e07851cb311f61bf1e17162df4c3d (diff)
doc: factor out the glossary
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/glossary.adoc18
-rw-r--r--doc/implementers-guide/implementers-guide.adoc2
-rw-r--r--doc/users-guide/users-guide.adoc19
3 files changed, 21 insertions, 18 deletions
diff --git a/doc/glossary.adoc b/doc/glossary.adoc
new file mode 100644
index 000000000..8e514eed2
--- /dev/null
+++ b/doc/glossary.adoc
@@ -0,0 +1,18 @@
+== Glossary
+[glossary]
+worker thread::
+ A worker is a type of ODP thread. It will usually be isolated from
+ the scheduling of any host operating system and is intended for fast-path
+ processing with a low and predictable latency. Worker threads will not
+ generally receive interrupts and will run to completion.
+control thread::
+ A control thread is a type of ODP thread. It will be isolated from the host
+ operating system house keeping tasks but will be scheduled by it and may
+ receive interrupts.
+thread::
+ An ODP thread is a flow of execution that in a Linux environment could be
+ a Linux process or thread.
+event::
+ An event is a notification that can be placed in a queue.
+queue::
+ A communication channel that holds events
diff --git a/doc/implementers-guide/implementers-guide.adoc b/doc/implementers-guide/implementers-guide.adoc
index 8964b0cd0..725eda5d0 100644
--- a/doc/implementers-guide/implementers-guide.adoc
+++ b/doc/implementers-guide/implementers-guide.adoc
@@ -386,3 +386,5 @@ So 'foo_test_a' will be executed and 'foo_test_b' is inactive.
It's expected that early in the development cycle of a new implementation the
inactive list will be quite long, but it should shrink over time as more parts
of the API are implemented.
+
+include::../glossary.adoc[]
diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc
index e65f83658..542b7d17d 100644
--- a/doc/users-guide/users-guide.adoc
+++ b/doc/users-guide/users-guide.adoc
@@ -786,21 +786,4 @@ in-place, when the output packet is the same as the input packet or the output
packet can be a new packet provided by the application or allocated by the
implementation from the session output pool.
-== Glossary
-[glossary]
-worker thread::
- A worker is a type of ODP thread. It will usually be isolated from
- the scheduling of any host operating system and is intended for fast-path
- processing with a low and predictable latency. Worker threads will not
- generally receive interrupts and will run to completion.
-control thread::
- A control threadis a type of ODP thread. It will be isolated from the host
- operating system house keeping tasks but will be scheduled by it and may
- receive interrupts.
-thread::
- An ODP thread is a flow of execution that in a Linux environment could be
- a Linux process or thread.
-event::
- An event is a notification that can be placed in a queue.
-queue::
- A communication channel that holds events
+include::../glossary.adoc[]