On Sun, 16 Oct 2016, Silvio Fricke <[email protected]> wrote:
> Only formating changes.
>
> Signed-off-by: Silvio Fricke <[email protected]>
> ---
> include/linux/workqueue.h | 22 +++++++++++++---------
> 1 file changed, 13 insertions(+), 9 deletions(-)
>
> diff --git a/include/linux/workqueue.h b/include/linux/workqueue.h
> index fc6e221..8455869 100644
> --- a/include/linux/workqueue.h
> +++ b/include/linux/workqueue.h
> @@ -119,18 +119,22 @@ struct delayed_work {
> int cpu;
> };
>
> -/*
> - * A struct for workqueue attributes. This can be used to change
> - * attributes of an unbound workqueue.
> +/**
> + * struct workqueue_attrs - A struct for workqueue attributes.
> + * @nice: nice level
> + * @cpumask: allowed CPUs
> + * @no_numa: disable NUMA affinity
> + *
A blank line here will stop param/field processing, and the following
section will become part of the function description, not part of the
param description. I think; didn't actually run the tools.
If you want to do longer field descriptions for structs, you can do them
inline in the struct. See below.
> + * 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.
> *
> - * Unlike other fields, ->no_numa isn't a property of a worker_pool. It
> - * only modifies how apply_workqueue_attrs() select pools and thus doesn't
> - * participate in pool hash calculations or equality comparisons.
> + * This can be used to change attributes of an unbound workqueue.
> */
> struct workqueue_attrs {
> - int nice; /* nice level */
> - cpumask_var_t cpumask; /* allowed CPUs */
> - bool no_numa; /* disable NUMA affinity */
> + int nice;
> + cpumask_var_t cpumask;
You could do:
/**
* @no_numa: bla bla
*
* long description that'll be part of the field description
*/
> + bool no_numa;
HTH,
Jani.
> };
>
> static inline struct delayed_work *to_delayed_work(struct work_struct *work)
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
