Documentation: Document ARM's user_debug parameter
diff mbox

Message ID 1311556514-24728-1-git-send-email-sboyd@codeaurora.org
State New, archived
Headers show

Commit Message

Stephen Boyd July 25, 2011, 1:15 a.m. UTC
Usually kernel parameters are documented in kernel-parameters.txt
but user_debug is only documented in the Kconfig. Document the
option and point to the Kconfig help text for more info.

Signed-off-by: Stephen Boyd <sboyd@codeaurora.org>
Cc: Russell King <linux@arm.linux.org.uk>
---
 Documentation/kernel-parameters.txt |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)

Comments

Randy Dunlap July 25, 2011, 9:29 p.m. UTC | #1
On Sun, 24 Jul 2011 18:15:14 -0700 Stephen Boyd wrote:

> Usually kernel parameters are documented in kernel-parameters.txt
> but user_debug is only documented in the Kconfig. Document the
> option and point to the Kconfig help text for more info.
> 
> Signed-off-by: Stephen Boyd <sboyd@codeaurora.org>
> Cc: Russell King <linux@arm.linux.org.uk>

Is this a superset of 'print_fatal_signals'?

Applied, thanks.

> ---
>  Documentation/kernel-parameters.txt |   10 ++++++++++
>  1 files changed, 10 insertions(+), 0 deletions(-)
> 
> diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
> index aa47be7..8186adc 100644
> --- a/Documentation/kernel-parameters.txt
> +++ b/Documentation/kernel-parameters.txt
> @@ -2612,6 +2612,16 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
>  					medium is write-protected).
>  			Example: quirks=0419:aaf5:rl,0421:0433:rc
>  
> +	user_debug=	[KNL,ARM]
> +			Format: <int>
> +			See arch/arm/Kconfig.debug help text.
> +				 1 - undefined instruction events
> +				 2 - system calls
> +				 4 - invalid data aborts
> +				 8 - SIGSEGV faults
> +				16 - SIGBUS faults
> +			Example: user_debug=31
> +
>  	userpte=
>  			[X86] Flags controlling user PTE allocations.
>  
> -- 
> Sent by an employee of the Qualcomm Innovation Center, Inc.
> The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum.

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
tip-bot for Dave Martin July 26, 2011, 8:57 a.m. UTC | #2
On Mon, Jul 25, 2011 at 02:29:24PM -0700, Randy Dunlap wrote:
> On Sun, 24 Jul 2011 18:15:14 -0700 Stephen Boyd wrote:
> 
> > Usually kernel parameters are documented in kernel-parameters.txt
> > but user_debug is only documented in the Kconfig. Document the
> > option and point to the Kconfig help text for more info.
> > 
> > Signed-off-by: Stephen Boyd <sboyd@codeaurora.org>
> > Cc: Russell King <linux@arm.linux.org.uk>
> 
> Is this a superset of 'print_fatal_signals'?
> 
> Applied, thanks.
> 
> > ---
> >  Documentation/kernel-parameters.txt |   10 ++++++++++
> >  1 files changed, 10 insertions(+), 0 deletions(-)
> > 
> > diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
> > index aa47be7..8186adc 100644
> > --- a/Documentation/kernel-parameters.txt
> > +++ b/Documentation/kernel-parameters.txt
> > @@ -2612,6 +2612,16 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
> >  					medium is write-protected).
> >  			Example: quirks=0419:aaf5:rl,0421:0433:rc
> >  
> > +	user_debug=	[KNL,ARM]
> > +			Format: <int>
> > +			See arch/arm/Kconfig.debug help text.
> > +				 1 - undefined instruction events
> > +				 2 - system calls

linux$ git grep UDBG_SYSCALL -- arch/arm/
include/asm/system.h:#define UDBG_SYSCALL       (1 << 1)
kernel/traps.c: if (user_debug & UDBG_SYSCALL) {
kernel/traps.c: if (user_debug & UDBG_SYSCALL) {

Looking at kernel/traps.c, it looks like only undefined or obsolete
syscalls are logged.  It could be worth clarifying this in the wording,
both here and in arch/arm/Kconfig.debug.

Cheers
---Dave

> > +				 4 - invalid data aborts
> > +				 8 - SIGSEGV faults
> > +				16 - SIGBUS faults
> > +			Example: user_debug=31
> > +
> >  	userpte=
> >  			[X86] Flags controlling user PTE allocations.
> >  
> > -- 
> > Sent by an employee of the Qualcomm Innovation Center, Inc.
> > The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum.
> 
> ---
> ~Randy
> *** Remember to use Documentation/SubmitChecklist when testing your code ***
> 
> _______________________________________________
> linux-arm-kernel mailing list
> linux-arm-kernel@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

Patch
diff mbox

diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
index aa47be7..8186adc 100644
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -2612,6 +2612,16 @@  bytes respectively. Such letter suffixes can also be entirely omitted.
 					medium is write-protected).
 			Example: quirks=0419:aaf5:rl,0421:0433:rc
 
+	user_debug=	[KNL,ARM]
+			Format: <int>
+			See arch/arm/Kconfig.debug help text.
+				 1 - undefined instruction events
+				 2 - system calls
+				 4 - invalid data aborts
+				 8 - SIGSEGV faults
+				16 - SIGBUS faults
+			Example: user_debug=31
+
 	userpte=
 			[X86] Flags controlling user PTE allocations.