diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-05-14 15:35:40 -0300 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2017-07-14 13:51:42 -0600 |
| commit | b4282c79204b086276f4278568994f7e1ee449ca (patch) | |
| tree | 4c7b6b4db566b3f503de39295f4258549366fd48 | |
| parent | 1642a1e68a70230c4dd0fb1523e1e886e3f5972a (diff) | |
| download | lwn-b4282c79204b086276f4278568994f7e1ee449ca.tar.gz lwn-b4282c79204b086276f4278568994f7e1ee449ca.zip | |
irqflags-tracing.txt: standardize document format
Each text file under Documentation follows a different
format. Some doesn't even have titles!
Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:
There isn't much to be done here: just mark the document
title as such and add a :Author:.
While here, use upper case at the beginning of a few paragraphs
that start with lower case.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| -rw-r--r-- | Documentation/irqflags-tracing.txt | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/Documentation/irqflags-tracing.txt b/Documentation/irqflags-tracing.txt index f6da05670e16..bdd208259fb3 100644 --- a/Documentation/irqflags-tracing.txt +++ b/Documentation/irqflags-tracing.txt @@ -1,8 +1,10 @@ +======================= IRQ-flags state tracing +======================= -started by Ingo Molnar <mingo@redhat.com> +:Author: started by Ingo Molnar <mingo@redhat.com> -the "irq-flags tracing" feature "traces" hardirq and softirq state, in +The "irq-flags tracing" feature "traces" hardirq and softirq state, in that it gives interested subsystems an opportunity to be notified of every hardirqs-off/hardirqs-on, softirqs-off/softirqs-on event that happens in the kernel. @@ -14,7 +16,7 @@ CONFIG_PROVE_RWSEM_LOCKING will be offered on an architecture - these are locking APIs that are not used in IRQ context. (the one exception for rwsems is worked around) -architecture support for this is certainly not in the "trivial" +Architecture support for this is certainly not in the "trivial" category, because lots of lowlevel assembly code deal with irq-flags state changes. But an architecture can be irq-flags-tracing enabled in a rather straightforward and risk-free manner. @@ -41,7 +43,7 @@ irq-flags-tracing support: excluded from the irq-tracing [and lock validation] mechanism via lockdep_off()/lockdep_on(). -in general there is no risk from having an incomplete irq-flags-tracing +In general there is no risk from having an incomplete irq-flags-tracing implementation in an architecture: lockdep will detect that and will turn itself off. I.e. the lock validator will still be reliable. There should be no crashes due to irq-tracing bugs. (except if the assembly |