From patchwork Tue Jan 5 17:34:33 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 59202 Delivered-To: patch@linaro.org Received: by 10.112.130.2 with SMTP id oa2csp6100670lbb; Tue, 5 Jan 2016 09:34:51 -0800 (PST) X-Received: by 10.140.106.37 with SMTP id d34mr127103272qgf.77.1452015291504; Tue, 05 Jan 2016 09:34:51 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id y124si69607045qka.2.2016.01.05.09.34.51; Tue, 05 Jan 2016 09:34:51 -0800 (PST) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dkim=neutral (body hash did not verify) header.i=@linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 064AE6178A; Tue, 5 Jan 2016 17:34:51 +0000 (UTC) Authentication-Results: lists.linaro.org; dkim=fail reason="verification failed; unprotected key" header.d=linaro.org header.i=@linaro.org header.b=TawTn8G6; dkim-adsp=none (unprotected policy); dkim-atps=neutral X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-2.5 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, T_DKIM_INVALID, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 6543C6172A; Tue, 5 Jan 2016 17:34:43 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id ADA2961745; Tue, 5 Jan 2016 17:34:40 +0000 (UTC) Received: from mail-qk0-f178.google.com (mail-qk0-f178.google.com [209.85.220.178]) by lists.linaro.org (Postfix) with ESMTPS id 9A00D615CC for ; Tue, 5 Jan 2016 17:34:39 +0000 (UTC) Received: by mail-qk0-f178.google.com with SMTP id n135so143315561qka.2 for ; Tue, 05 Jan 2016 09:34:39 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id; bh=U3VBa8lnyVlWAqsw+uoYrPZEGB/W9IySXq+I5f79eFA=; b=TawTn8G6HNl0dj2lJkkSTeeepB/b162K9sBoae/A13rOHw/UZhbGv9XBueCHkWkg2s g8zW2er6rNaUapFAe4hFTxTn5Mx/WcaHPtcv4iIiisxoEN/cJdaorKTXGNa16Ud7gDlP 7V8KmR48LRWp/dFxGS/VNdh0P3S8x/8wOysZM= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=U3VBa8lnyVlWAqsw+uoYrPZEGB/W9IySXq+I5f79eFA=; b=C1aFazS1ShFyEaOkPpryj2StNiyr/Gh1AzuqkLUOYX+rcwkY9DN6ZfEUctL2EZwOjR SLGTGb+f6yrTEGXOZQkxx3EWvWVWGvJ1IGAi2NxWAyeY7hHHxGnUlyKmulVyeDXSIw/z ULe41UyKzibkDThzfQ63YgKuL/OZtfmToR/uENJm90A20YO6Rr4Rr2YaQHyaodoP1Wr1 b++M1Rn1Ef+Jku6AQnFC9zPe1HB3/t8qCEKWaVawuJA58eBsITbr8svk7yxfrIyw5rmz kRrKx6xESwcZX3lwqnBAA+2Nlr25TLshJEPSVdwAbBCmiXz13DepXAQpPQwJLFExHiTv RjXA== X-Gm-Message-State: ALoCoQlV+orAWnLhVt5IPR6s1S9xwXPVsWP/KM9pgz3DHbaxxzQc4Rw9Y5f/lMdGekej2GRHjpU8Jqk0W4TUkrkhCQdO5+26dw== X-Received: by 10.55.73.68 with SMTP id w65mr616876qka.68.1452015279389; Tue, 05 Jan 2016 09:34:39 -0800 (PST) Received: from localhost.localdomain (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by smtp.gmail.com with ESMTPSA id x76sm42219251qhb.48.2016.01.05.09.34.38 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 05 Jan 2016 09:34:39 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Tue, 5 Jan 2016 12:34:33 -0500 Message-Id: <1452015273-5137-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.5.0 X-Topics: patch Subject: [lng-odp] [PATCH] doc: factor out the glossary X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Signed-off-by: Mike Holmes Reviewed-by: Bill Fischofer --- 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[]