diff mbox

doc: users-guide: fix function highlighting

Message ID 1452014163-27121-1-git-send-email-mike.holmes@linaro.org
State Accepted
Commit 15e594c9ae9e07851cb311f61bf1e17162df4c3d
Headers show

Commit Message

Mike Holmes Jan. 5, 2016, 5:16 p.m. UTC
Use "*" for function highlighting and promote crypto to its own section
from a subsection of queues

Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
 doc/users-guide/users-guide.adoc | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Comments

Bill Fischofer Jan. 5, 2016, 5:31 p.m. UTC | #1
On Tue, Jan 5, 2016 at 11:16 AM, Mike Holmes <mike.holmes@linaro.org> wrote:

> Use "*" for function highlighting and promote crypto to its own section

> from a subsection of queues

>

> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>

>


Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>



> ---

>  doc/users-guide/users-guide.adoc | 10 +++++-----

>  1 file changed, 5 insertions(+), 5 deletions(-)

>

> diff --git a/doc/users-guide/users-guide.adoc

> b/doc/users-guide/users-guide.adoc

> index 8bc8521..e65f836 100644

> --- a/doc/users-guide/users-guide.adoc

> +++ b/doc/users-guide/users-guide.adoc

> @@ -754,9 +754,9 @@ on ordered queues. Multiple events are processed in

> parallel and the use of

>  ordered queues ensures that they will be placed on +dest_q+ in the same

> order

>  as they originated.  While processing in parallel, the use of ordered

> locks

>  enables critical sections to be processed in order within the overall

> parallel

> -flow. When a thread arrives at the _odp_schedule_order_lock()_ call, it

> waits

> +flow. When a thread arrives at the *odp_schedule_order_lock()* call, it

> waits

>  until the locking order for this lock for all prior events has been

> resolved

> -and then enters the critical section. The _odp_schedule_order_unlock()_

> call

> +and then enters the critical section. The *odp_schedule_order_unlock()*

> call

>  releases the critical section and allows the next order to enter it.

>

>  === Queue Scheduling Summary

> @@ -765,14 +765,14 @@ NOTE: Both ordered and parallel queues improve

> throughput over atomic queues

>  due to parallel event processing, but require that the application take

>  steps to ensure context data synchronization if needed.

>

> -=== Cryptographic services

> +== Cryptographic services

>

>  ODP provides support for cryptographic operations required by various

> security

>  protocols (e.g. IPSec). To apply a cryptographic operation to a packet a

> session

>  must be created first. Packets processed by a session share the same

> cryptographic

>  parameters like algorithms, keys, initialization vectors. A session is

> created with

> -odp_crypto_session_create() call. After session creation a cryptographic

> operation

> -can be applied to a packet using odp_crypto_operation() call.

> +*odp_crypto_session_create()* call. After session creation a

> cryptographic operation

> +can be applied to a packet using *odp_crypto_operation()* call.

>  Depending on the session type - synchronous or asynchronous the operation

> returns

>  when the operation completed or after the request has been submitted. In

> the

>  asynchronous case an operation completion event will be enqueued on the

> session

> --

> 2.5.0

>

> _______________________________________________

> lng-odp mailing list

> lng-odp@lists.linaro.org

> https://lists.linaro.org/mailman/listinfo/lng-odp

>
Mike Holmes Jan. 7, 2016, 4:25 p.m. UTC | #2
Merged.

On 5 January 2016 at 12:31, Bill Fischofer <bill.fischofer@linaro.org>
wrote:

>

>

> On Tue, Jan 5, 2016 at 11:16 AM, Mike Holmes <mike.holmes@linaro.org>

> wrote:

>

>> Use "*" for function highlighting and promote crypto to its own section

>> from a subsection of queues

>>

>> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>

>>

>

> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>

>

>

>> ---

>>  doc/users-guide/users-guide.adoc | 10 +++++-----

>>  1 file changed, 5 insertions(+), 5 deletions(-)

>>

>> diff --git a/doc/users-guide/users-guide.adoc

>> b/doc/users-guide/users-guide.adoc

>> index 8bc8521..e65f836 100644

>> --- a/doc/users-guide/users-guide.adoc

>> +++ b/doc/users-guide/users-guide.adoc

>> @@ -754,9 +754,9 @@ on ordered queues. Multiple events are processed in

>> parallel and the use of

>>  ordered queues ensures that they will be placed on +dest_q+ in the same

>> order

>>  as they originated.  While processing in parallel, the use of ordered

>> locks

>>  enables critical sections to be processed in order within the overall

>> parallel

>> -flow. When a thread arrives at the _odp_schedule_order_lock()_ call, it

>> waits

>> +flow. When a thread arrives at the *odp_schedule_order_lock()* call, it

>> waits

>>  until the locking order for this lock for all prior events has been

>> resolved

>> -and then enters the critical section. The _odp_schedule_order_unlock()_

>> call

>> +and then enters the critical section. The *odp_schedule_order_unlock()*

>> call

>>  releases the critical section and allows the next order to enter it.

>>

>>  === Queue Scheduling Summary

>> @@ -765,14 +765,14 @@ NOTE: Both ordered and parallel queues improve

>> throughput over atomic queues

>>  due to parallel event processing, but require that the application take

>>  steps to ensure context data synchronization if needed.

>>

>> -=== Cryptographic services

>> +== Cryptographic services

>>

>>  ODP provides support for cryptographic operations required by various

>> security

>>  protocols (e.g. IPSec). To apply a cryptographic operation to a packet a

>> session

>>  must be created first. Packets processed by a session share the same

>> cryptographic

>>  parameters like algorithms, keys, initialization vectors. A session is

>> created with

>> -odp_crypto_session_create() call. After session creation a cryptographic

>> operation

>> -can be applied to a packet using odp_crypto_operation() call.

>> +*odp_crypto_session_create()* call. After session creation a

>> cryptographic operation

>> +can be applied to a packet using *odp_crypto_operation()* call.

>>  Depending on the session type - synchronous or asynchronous the

>> operation returns

>>  when the operation completed or after the request has been submitted. In

>> the

>>  asynchronous case an operation completion event will be enqueued on the

>> session

>> --

>> 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 mbox

Patch

diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc
index 8bc8521..e65f836 100644
--- a/doc/users-guide/users-guide.adoc
+++ b/doc/users-guide/users-guide.adoc
@@ -754,9 +754,9 @@  on ordered queues. Multiple events are processed in parallel and the use of
 ordered queues ensures that they will be placed on +dest_q+ in the same order
 as they originated.  While processing in parallel, the use of ordered locks
 enables critical sections to be processed in order within the overall parallel
-flow. When a thread arrives at the _odp_schedule_order_lock()_ call, it waits
+flow. When a thread arrives at the *odp_schedule_order_lock()* call, it waits
 until the locking order for this lock for all prior events has been resolved
-and then enters the critical section. The _odp_schedule_order_unlock()_ call
+and then enters the critical section. The *odp_schedule_order_unlock()* call
 releases the critical section and allows the next order to enter it.
 
 === Queue Scheduling Summary
@@ -765,14 +765,14 @@  NOTE: Both ordered and parallel queues improve throughput over atomic queues
 due to parallel event processing, but require that the application take
 steps to ensure context data synchronization if needed.
 
-=== Cryptographic services
+== Cryptographic services
 
 ODP provides support for cryptographic operations required by various security
 protocols (e.g. IPSec). To apply a cryptographic operation to a packet a session
 must be created first. Packets processed by a session share the same cryptographic
 parameters like algorithms, keys, initialization vectors. A session is created with
-odp_crypto_session_create() call. After session creation a cryptographic operation
-can be applied to a packet using odp_crypto_operation() call.
+*odp_crypto_session_create()* call. After session creation a cryptographic operation
+can be applied to a packet using *odp_crypto_operation()* call.
 Depending on the session type - synchronous or asynchronous the operation returns
 when the operation completed or after the request has been submitted. In the
 asynchronous case an operation completion event will be enqueued on the session