Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[PATCH v2] api: queue: clarify odp_queue_param_t default value specification #1916

Merged
merged 1 commit into from
Oct 20, 2023
Merged

[PATCH v2] api: queue: clarify odp_queue_param_t default value specification #1916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions include/odp/api/spec/queue.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,11 @@ extern "C" {
/**
* Queue create
*
* Create a queue according to the queue parameters. Queue type is specified by
* queue parameter 'type'. Use odp_queue_param_init() to initialize parameters
* into their default values. Default values are also used when 'param' pointer
* is NULL. The default queue type is ODP_QUEUE_TYPE_PLAIN. The use of queue
* name is optional. Unique names are not required. However, odp_queue_lookup()
* returns only a single matching queue.
* Create a queue according to the queue parameters. The use of queue name is
* optional. Unique names are not required. However, odp_queue_lookup() returns
* only a single matching queue. Use odp_queue_param_init() to initialize
* parameters into their default values. Default values are also used when
* 'param' pointer is NULL.
*
* @param name Name of the queue or NULL. Maximum string length is
* ODP_QUEUE_NAME_LEN.
Expand Down
4 changes: 2 additions & 2 deletions include/odp/api/spec/queue_types.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ typedef struct odp_queue_param_t {
/** Queue type
*
* Valid values for other parameters in this structure depend on
* the queue type. */
* the queue type. The default value is ODP_QUEUE_TYPE_PLAIN. */
odp_queue_type_t type;

/** Enqueue mode
Expand Down Expand Up @@ -288,7 +288,7 @@ typedef struct odp_queue_param_t {
* The queue must be able to store at minimum this many events
* simultaneously. The value must not exceed 'max_size' queue
* capability. The value of zero means implementation specific
* default size. */
* default size. The default value is 0. */
uint32_t size;

} odp_queue_param_t;
Expand Down