| Message ID | 1452015273-5137-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | Accepted |
| Commit | db3656ee41116c40e98c95381f229217b91ef70d |
| Headers | show |
This seems like a good change. On Tue, Jan 5, 2016 at 11:34 AM, Mike Holmes <mike.holmes@linaro.org> wrote: > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> > --- > doc/glossary.adoc | 18 ++++++++++++++++++ > doc/implementers-guide/implementers-guide.adoc | 2 ++ > doc/users-guide/users-guide.adoc | 19 +------------------ > 3 files changed, 21 insertions(+), 18 deletions(-) > create mode 100644 doc/glossary.adoc > > diff --git a/doc/glossary.adoc b/doc/glossary.adoc > new file mode 100644 > index 0000000..8e514ee > --- /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 8964b0c..725eda5 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 8bc8521..2f477ca 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[] > -- > 2.5.0 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp >
Merged. On 5 January 2016 at 13:26, Bill Fischofer <bill.fischofer@linaro.org> wrote: > This seems like a good change. > > On Tue, Jan 5, 2016 at 11:34 AM, Mike Holmes <mike.holmes@linaro.org> > wrote: > >> Signed-off-by: Mike Holmes <mike.holmes@linaro.org> >> > > Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> > > >> --- >> doc/glossary.adoc | 18 ++++++++++++++++++ >> doc/implementers-guide/implementers-guide.adoc | 2 ++ >> doc/users-guide/users-guide.adoc | 19 +------------------ >> 3 files changed, 21 insertions(+), 18 deletions(-) >> create mode 100644 doc/glossary.adoc >> >> diff --git a/doc/glossary.adoc b/doc/glossary.adoc >> new file mode 100644 >> index 0000000..8e514ee >> --- /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 8964b0c..725eda5 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 8bc8521..2f477ca 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[] >> -- >> 2.5.0 >> >> _______________________________________________ >> lng-odp mailing list >> lng-odp@lists.linaro.org >> https://lists.linaro.org/mailman/listinfo/lng-odp >> > > -- Mike Holmes Technical Manager - Linaro Networking Group Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs
diff --git a/doc/glossary.adoc b/doc/glossary.adoc new file mode 100644 index 0000000..8e514ee --- /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 8964b0c..725eda5 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 8bc8521..2f477ca 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[]
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- doc/glossary.adoc | 18 ++++++++++++++++++ doc/implementers-guide/implementers-guide.adoc | 2 ++ doc/users-guide/users-guide.adoc | 19 +------------------ 3 files changed, 21 insertions(+), 18 deletions(-) create mode 100644 doc/glossary.adoc