Re: [PATCH] context_tracking: Add comments on interface and internals

[Namhyung Kim <namhyung@kernel.org>]

Hi Frederic,

On Wed, 16 Jan 2013 13:32:57 +0100, Frederic Weisbecker wrote:
> This subsystem lacks many explanations on its purpose and
> design. Add these missing comments.
>
> v3: Fix the "hook" based naming as per Ingo's suggestion
[snip]
> +/**
> + * context_tracking_task_switch - context switch the syscall callbacks

To be more kernel-doc-friendly, it'd better adding descriptions for
arguments too:

 @prev: the task that is being switched out
 @next: the task we are going to switch to

Thanks,
Namhyung


> + *
> + * The context tracking uses the syscall slow path to implement its user-kernel
> + * boundaries probes on syscalls. This way it doesn't impact the syscall fast
> + * path on CPUs that don't do context tracking.
> + *
> + * But we need to clear the flag on the previous task because it may later
> + * migrate to some CPU that doesn't do the context tracking. As such the TIF
> + * flag may not be desired there.
> + */
>  void context_tracking_task_switch(struct task_struct *prev,
>  			     struct task_struct *next)
>  {