Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: add IRQ documentation at the core-api book

There are 4 IRQ documentation files under Documentation/*.txt.

Move them into a new directory (core-api/irq) and add a new
index file for it.

While here, use a title markup for the Debugging section of the
irq-domain.rst file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/2da7485c3718e1442e6b4c2dd66857b776e8899b.1588345503.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
e00b0ab8 a74e2a22

+22 -9
Documentation/IRQ-affinity.txt Documentation/core-api/irq/irq-affinity.rst
+2 -1
Documentation/IRQ-domain.txt Documentation/core-api/irq/irq-domain.rst
··· 263 263 Hierarchy irq_domain is in no way x86 specific, and is heavily used to 264 264 support other architectures, such as ARM, ARM64 etc. 265 265 266 - === Debugging === 266 + Debugging 267 + ========= 267 268 268 269 Most of the internals of the IRQ subsystem are exposed in debugfs by 269 270 turning CONFIG_GENERIC_IRQ_DEBUGFS on.
Documentation/IRQ.txt Documentation/core-api/irq/concepts.rst
+1 -1
Documentation/admin-guide/hw-vuln/l1tf.rst
··· 268 268 /proc/irq/$NR/smp_affinity[_list] files. Limited documentation is 269 269 available at: 270 270 271 - https://www.kernel.org/doc/Documentation/IRQ-affinity.txt 271 + https://www.kernel.org/doc/Documentation/core-api/irq/irq-affinity.rst 272 272 273 273 .. _smt_control: 274 274
+1 -1
Documentation/admin-guide/kernel-per-CPU-kthreads.rst
··· 10 10 References 11 11 ========== 12 12 13 - - Documentation/IRQ-affinity.txt: Binding interrupts to sets of CPUs. 13 + - Documentation/core-api/irq/irq-affinity.rst: Binding interrupts to sets of CPUs. 14 14 15 15 - Documentation/admin-guide/cgroup-v1: Using cgroups to bind tasks to sets of CPUs. 16 16
+1
Documentation/core-api/index.rst
··· 52 52 53 53 atomic_ops 54 54 refcount-vs-atomic 55 + irq/index 55 56 local_ops 56 57 padata 57 58 ../RCU/index
+11
Documentation/core-api/irq/index.rst
··· 1 + ==== 2 + IRQs 3 + ==== 4 + 5 + .. toctree:: 6 + :maxdepth: 1 7 + 8 + concepts 9 + irq-affinity 10 + irq-domain 11 + irqflags-tracing
+1 -1
Documentation/ia64/irq-redir.rst
··· 7 7 8 8 By writing to /proc/irq/IRQ#/smp_affinity the interrupt routing can be 9 9 controlled. The behavior on IA64 platforms is slightly different from 10 - that described in Documentation/IRQ-affinity.txt for i386 systems. 10 + that described in Documentation/core-api/irq/irq-affinity.rst for i386 systems. 11 11 12 12 Because of the usage of SAPIC mode and physical destination mode the 13 13 IRQ target is one particular CPU and cannot be a mask of several
Documentation/irqflags-tracing.txt Documentation/core-api/irq/irqflags-tracing.rst
+2 -2
Documentation/networking/scaling.rst
··· 81 81 an IRQ may be handled on any CPU. Because a non-negligible part of packet 82 82 processing takes place in receive interrupt handling, it is advantageous 83 83 to spread receive interrupts between CPUs. To manually adjust the IRQ 84 - affinity of each interrupt see Documentation/IRQ-affinity.txt. Some systems 84 + affinity of each interrupt see Documentation/core-api/irq/irq-affinity.rst. Some systems 85 85 will be running irqbalance, a daemon that dynamically optimizes IRQ 86 86 assignments and as a result may override any manual settings. 87 87 ··· 160 160 161 161 This file implements a bitmap of CPUs. RPS is disabled when it is zero 162 162 (the default), in which case packets are processed on the interrupting 163 - CPU. Documentation/IRQ-affinity.txt explains how CPUs are assigned to 163 + CPU. Documentation/core-api/irq/irq-affinity.rst explains how CPUs are assigned to 164 164 the bitmap. 165 165 166 166
+2 -2
Documentation/translations/zh_CN/IRQ.txt
··· 1 - Chinese translated version of Documentation/IRQ.txt 1 + Chinese translated version of Documentation/core-api/irq/index.rst 2 2 3 3 If you have any comment or update to the content, please contact the 4 4 original document maintainer directly. However, if you have a problem ··· 9 9 Maintainer: Eric W. Biederman <ebiederman@xmission.com> 10 10 Chinese maintainer: Fu Wei <tekkamanninja@gmail.com> 11 11 --------------------------------------------------------------------- 12 - Documentation/IRQ.txt 的中文翻译 12 + Documentation/core-api/irq/index.rst 的中文翻译 13 13 14 14 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 15 15 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻
+1 -1
MAINTAINERS
··· 8952 8952 M: Marc Zyngier <maz@kernel.org> 8953 8953 S: Maintained 8954 8954 T: git git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip.git irq/core 8955 - F: Documentation/IRQ-domain.txt 8955 + F: Documentation/core-api/irq/irq-domain.rst 8956 8956 F: include/linux/irqdomain.h 8957 8957 F: kernel/irq/irqdomain.c 8958 8958 F: kernel/irq/msi.c