[PATCH] arm64: Move TIF_* documentation to individual definitions

[PATCH] arm64: Move TIF_* documentation to individual definitions

[Geert Uytterhoeven]

Some TIF_* flags are documented in the comment block at the top, some
next to their definitions, some in both places.

Move all documentation to the individual definitions for consistency,
and for easy lookup.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
The alternative is to move all of them to the comment block, and using
linuxdoc style.

 arch/arm64/include/asm/thread_info.h | 24 ++++++++----------------
 1 file changed, 8 insertions(+), 16 deletions(-)

diff --git a/arch/arm64/include/asm/thread_info.h b/arch/arm64/include/asm/thread_info.h
index 180b34ec59650a9b..cb3eb1ccccc4116b 100644
--- a/arch/arm64/include/asm/thread_info.h
+++ b/arch/arm64/include/asm/thread_info.h
@@ -60,28 +60,20 @@ void arch_release_task_struct(struct task_struct *tsk);
 #endif
 
 /*
- * thread information flags:
- *  TIF_SYSCALL_TRACE	- syscall trace active
- *  TIF_SYSCALL_TRACEPOINT - syscall tracepoint for ftrace
- *  TIF_SYSCALL_AUDIT	- syscall auditing
- *  TIF_SECCOMP		- syscall secure computing
- *  TIF_SYSCALL_EMU     - syscall emulation active
- *  TIF_SIGPENDING	- signal pending
- *  TIF_NEED_RESCHED	- rescheduling necessary
- *  TIF_NOTIFY_RESUME	- callback before returning to user
+ * thread information flags
  */
-#define TIF_SIGPENDING		0
-#define TIF_NEED_RESCHED	1
+#define TIF_SIGPENDING		0	/* signal pending */
+#define TIF_NEED_RESCHED	1	/* rescheduling necessary */
 #define TIF_NOTIFY_RESUME	2	/* callback before returning to user */
 #define TIF_FOREIGN_FPSTATE	3	/* CPU's FP state is not current's */
 #define TIF_UPROBE		4	/* uprobe breakpoint or singlestep */
 #define TIF_FSCHECK		5	/* Check FS is USER_DS on return */
 #define TIF_NOHZ		7
-#define TIF_SYSCALL_TRACE	8
-#define TIF_SYSCALL_AUDIT	9
-#define TIF_SYSCALL_TRACEPOINT	10
-#define TIF_SECCOMP		11
-#define TIF_SYSCALL_EMU		12
+#define TIF_SYSCALL_TRACE	8	/* syscall trace active */
+#define TIF_SYSCALL_AUDIT	9	/* syscall auditing */
+#define TIF_SYSCALL_TRACEPOINT	10	/* syscall tracepoint for ftrace */
+#define TIF_SECCOMP		11	/* syscall secure computing */
+#define TIF_SYSCALL_EMU		12	/* syscall emulation active */
 #define TIF_MEMDIE		18	/* is terminating due to OOM killer */
 #define TIF_FREEZE		19
 #define TIF_RESTORE_SIGMASK	20
-- 
2.17.1

Re: [PATCH] arm64: Move TIF_* documentation to individual definitions

[Mark Rutland]

On Wed, Jul 31, 2019 at 03:35:20PM +0200, Geert Uytterhoeven wrote:
> Some TIF_* flags are documented in the comment block at the top, some
> next to their definitions, some in both places.
> 
> Move all documentation to the individual definitions for consistency,
> and for easy lookup.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
> The alternative is to move all of them to the comment block, and using
> linuxdoc style.
> 
>  arch/arm64/include/asm/thread_info.h | 24 ++++++++----------------
>  1 file changed, 8 insertions(+), 16 deletions(-)
> 
> diff --git a/arch/arm64/include/asm/thread_info.h b/arch/arm64/include/asm/thread_info.h
> index 180b34ec59650a9b..cb3eb1ccccc4116b 100644
> --- a/arch/arm64/include/asm/thread_info.h
> +++ b/arch/arm64/include/asm/thread_info.h
> @@ -60,28 +60,20 @@ void arch_release_task_struct(struct task_struct *tsk);
>  #endif
>  
>  /*
> - * thread information flags:
> - *  TIF_SYSCALL_TRACE	- syscall trace active
> - *  TIF_SYSCALL_TRACEPOINT - syscall tracepoint for ftrace
> - *  TIF_SYSCALL_AUDIT	- syscall auditing
> - *  TIF_SECCOMP		- syscall secure computing
> - *  TIF_SYSCALL_EMU     - syscall emulation active
> - *  TIF_SIGPENDING	- signal pending
> - *  TIF_NEED_RESCHED	- rescheduling necessary
> - *  TIF_NOTIFY_RESUME	- callback before returning to user
> + * thread information flags
>   */

We can probably just get rid of the this comment block at this point. :)

> -#define TIF_SIGPENDING		0
> -#define TIF_NEED_RESCHED	1
> +#define TIF_SIGPENDING		0	/* signal pending */
> +#define TIF_NEED_RESCHED	1	/* rescheduling necessary */
>  #define TIF_NOTIFY_RESUME	2	/* callback before returning to user */
>  #define TIF_FOREIGN_FPSTATE	3	/* CPU's FP state is not current's */
>  #define TIF_UPROBE		4	/* uprobe breakpoint or singlestep */
>  #define TIF_FSCHECK		5	/* Check FS is USER_DS on return */
>  #define TIF_NOHZ		7
> -#define TIF_SYSCALL_TRACE	8
> -#define TIF_SYSCALL_AUDIT	9
> -#define TIF_SYSCALL_TRACEPOINT	10
> -#define TIF_SECCOMP		11
> -#define TIF_SYSCALL_EMU		12
> +#define TIF_SYSCALL_TRACE	8	/* syscall trace active */
> +#define TIF_SYSCALL_AUDIT	9	/* syscall auditing */
> +#define TIF_SYSCALL_TRACEPOINT	10	/* syscall tracepoint for ftrace */
> +#define TIF_SECCOMP		11	/* syscall secure computing */
> +#define TIF_SYSCALL_EMU		12	/* syscall emulation active */
>  #define TIF_MEMDIE		18	/* is terminating due to OOM killer */
>  #define TIF_FREEZE		19
>  #define TIF_RESTORE_SIGMASK	20

FWIW this looks sane to me, so:

Acked-by: Mark Rutland <mark.rutland@arm.com>

Mark.

> -- 
> 2.17.1
> 

Re: [PATCH] arm64: Move TIF_* documentation to individual definitions

[Will Deacon]

On Wed, Jul 31, 2019 at 03:35:20PM +0200, Geert Uytterhoeven wrote:
> Some TIF_* flags are documented in the comment block at the top, some
> next to their definitions, some in both places.
> 
> Move all documentation to the individual definitions for consistency,
> and for easy lookup.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
> The alternative is to move all of them to the comment block, and using
> linuxdoc style.
> 
>  arch/arm64/include/asm/thread_info.h | 24 ++++++++----------------
>  1 file changed, 8 insertions(+), 16 deletions(-)

Queued for 5.4, with Mark's Ack.

Will