Commit 42412c3a authored by Silvio Fricke's avatar Silvio Fricke Committed by Jonathan Corbet

workqueue: kerneldocify workqueue_attrs

Only formating changes.
Signed-off-by: default avatarSilvio Fricke <silvio.fricke@gmail.com>
Acked-by: default avatarTejun Heo <tj@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent c950a173
...@@ -119,18 +119,30 @@ struct delayed_work { ...@@ -119,18 +119,30 @@ struct delayed_work {
int cpu; int cpu;
}; };
/* /**
* A struct for workqueue attributes. This can be used to change * struct workqueue_attrs - A struct for workqueue attributes.
* attributes of an unbound workqueue.
* *
* Unlike other fields, ->no_numa isn't a property of a worker_pool. It * This can be used to change attributes of an unbound workqueue.
* only modifies how apply_workqueue_attrs() select pools and thus doesn't
* participate in pool hash calculations or equality comparisons.
*/ */
struct workqueue_attrs { struct workqueue_attrs {
int nice; /* nice level */ /**
cpumask_var_t cpumask; /* allowed CPUs */ * @nice: nice level
bool no_numa; /* disable NUMA affinity */ */
int nice;
/**
* @cpumask: allowed CPUs
*/
cpumask_var_t cpumask;
/**
* @no_numa: disable NUMA affinity
*
* Unlike other fields, ``no_numa`` isn't a property of a worker_pool. It
* only modifies how :c:func:`apply_workqueue_attrs` select pools and thus
* doesn't participate in pool hash calculations or equality comparisons.
*/
bool no_numa;
}; };
static inline struct delayed_work *to_delayed_work(struct work_struct *work) static inline struct delayed_work *to_delayed_work(struct work_struct *work)
...@@ -272,7 +284,7 @@ static inline unsigned int work_static(struct work_struct *work) { return 0; } ...@@ -272,7 +284,7 @@ static inline unsigned int work_static(struct work_struct *work) { return 0; }
/* /*
* Workqueue flags and constants. For details, please refer to * Workqueue flags and constants. For details, please refer to
* Documentation/workqueue.txt. * Documentation/core-api/workqueue.rst.
*/ */
enum { enum {
WQ_UNBOUND = 1 << 1, /* not bound to any cpu */ WQ_UNBOUND = 1 << 1, /* not bound to any cpu */
...@@ -370,7 +382,8 @@ __alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active, ...@@ -370,7 +382,8 @@ __alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active,
* @args...: args for @fmt * @args...: args for @fmt
* *
* Allocate a workqueue with the specified parameters. For detailed * Allocate a workqueue with the specified parameters. For detailed
* information on WQ_* flags, please refer to Documentation/workqueue.txt. * information on WQ_* flags, please refer to
* Documentation/core-api/workqueue.rst.
* *
* The __lock_name macro dance is to guarantee that single lock_class_key * The __lock_name macro dance is to guarantee that single lock_class_key
* doesn't end up with different namesm, which isn't allowed by lockdep. * doesn't end up with different namesm, which isn't allowed by lockdep.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment