mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH v2 02/29] IRQ-affinity.txt: standardize document format
Date: Sat, 17 Jun 2017 12:26:30 -0300	[thread overview]
Message-ID: <3cca7deeb1f4ce69c5b9ad47e5384afb97086f07.1497713210.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <2932e5ece623ed990b6c3b80174df270278dc314.1497713210.git.mchehab@s-opensource.com>
In-Reply-To: <2932e5ece623ed990b6c3b80174df270278dc314.1497713210.git.mchehab@s-opensource.com>

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:

- Add a title for the document;
- mark literal blocks as such;
- use a bulleted list for changelog.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/IRQ-affinity.txt | 77 ++++++++++++++++++++++--------------------
 1 file changed, 41 insertions(+), 36 deletions(-)

diff --git a/Documentation/IRQ-affinity.txt b/Documentation/IRQ-affinity.txt
index 01a675175a36..29da5000836a 100644
--- a/Documentation/IRQ-affinity.txt
+++ b/Documentation/IRQ-affinity.txt
@@ -1,8 +1,11 @@
-ChangeLog:
-	Started by Ingo Molnar <mingo@redhat.com>
-	Update by Max Krasnyansky <maxk@qualcomm.com>
-
+================
 SMP IRQ affinity
+================
+
+ChangeLog:
+	- Started by Ingo Molnar <mingo@redhat.com>
+	- Update by Max Krasnyansky <maxk@qualcomm.com>
+
 
 /proc/irq/IRQ#/smp_affinity and /proc/irq/IRQ#/smp_affinity_list specify
 which target CPUs are permitted for a given IRQ source.  It's a bitmask
@@ -16,50 +19,52 @@ will be set to the default mask. It can then be changed as described above.
 Default mask is 0xffffffff.
 
 Here is an example of restricting IRQ44 (eth1) to CPU0-3 then restricting
-it to CPU4-7 (this is an 8-CPU SMP box):
+it to CPU4-7 (this is an 8-CPU SMP box)::
 
-[root@moon 44]# cd /proc/irq/44
-[root@moon 44]# cat smp_affinity
-ffffffff
+	[root@moon 44]# cd /proc/irq/44
+	[root@moon 44]# cat smp_affinity
+	ffffffff
 
-[root@moon 44]# echo 0f > smp_affinity
-[root@moon 44]# cat smp_affinity
-0000000f
-[root@moon 44]# ping -f h
-PING hell (195.4.7.3): 56 data bytes
-...
---- hell ping statistics ---
-6029 packets transmitted, 6027 packets received, 0% packet loss
-round-trip min/avg/max = 0.1/0.1/0.4 ms
-[root@moon 44]# cat /proc/interrupts | grep 'CPU\|44:'
-           CPU0       CPU1       CPU2       CPU3      CPU4       CPU5        CPU6       CPU7
- 44:       1068       1785       1785       1783         0          0           0         0    IO-APIC-level  eth1
+	[root@moon 44]# echo 0f > smp_affinity
+	[root@moon 44]# cat smp_affinity
+	0000000f
+	[root@moon 44]# ping -f h
+	PING hell (195.4.7.3): 56 data bytes
+	...
+	--- hell ping statistics ---
+	6029 packets transmitted, 6027 packets received, 0% packet loss
+	round-trip min/avg/max = 0.1/0.1/0.4 ms
+	[root@moon 44]# cat /proc/interrupts | grep 'CPU\|44:'
+		CPU0       CPU1       CPU2       CPU3      CPU4       CPU5        CPU6       CPU7
+	44:       1068       1785       1785       1783         0          0           0         0    IO-APIC-level  eth1
 
 As can be seen from the line above IRQ44 was delivered only to the first four
 processors (0-3).
 Now lets restrict that IRQ to CPU(4-7).
 
-[root@moon 44]# echo f0 > smp_affinity
-[root@moon 44]# cat smp_affinity
-000000f0
-[root@moon 44]# ping -f h
-PING hell (195.4.7.3): 56 data bytes
-..
---- hell ping statistics ---
-2779 packets transmitted, 2777 packets received, 0% packet loss
-round-trip min/avg/max = 0.1/0.5/585.4 ms
-[root@moon 44]# cat /proc/interrupts |  'CPU\|44:'
-           CPU0       CPU1       CPU2       CPU3      CPU4       CPU5        CPU6       CPU7
- 44:       1068       1785       1785       1783      1784       1069        1070       1069   IO-APIC-level  eth1
+::
+
+	[root@moon 44]# echo f0 > smp_affinity
+	[root@moon 44]# cat smp_affinity
+	000000f0
+	[root@moon 44]# ping -f h
+	PING hell (195.4.7.3): 56 data bytes
+	..
+	--- hell ping statistics ---
+	2779 packets transmitted, 2777 packets received, 0% packet loss
+	round-trip min/avg/max = 0.1/0.5/585.4 ms
+	[root@moon 44]# cat /proc/interrupts |  'CPU\|44:'
+		CPU0       CPU1       CPU2       CPU3      CPU4       CPU5        CPU6       CPU7
+	44:       1068       1785       1785       1783      1784       1069        1070       1069   IO-APIC-level  eth1
 
 This time around IRQ44 was delivered only to the last four processors.
 i.e counters for the CPU0-3 did not change.
 
-Here is an example of limiting that same irq (44) to cpus 1024 to 1031:
+Here is an example of limiting that same irq (44) to cpus 1024 to 1031::
 
-[root@moon 44]# echo 1024-1031 > smp_affinity_list
-[root@moon 44]# cat smp_affinity_list
-1024-1031
+	[root@moon 44]# echo 1024-1031 > smp_affinity_list
+	[root@moon 44]# cat smp_affinity_list
+	1024-1031
 
 Note that to do this with a bitmask would require 32 bitmasks of zero
 to follow the pertinent one.
-- 
2.9.4

  reply	other threads:[~2017-06-17 15:37 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-06-17 15:26 [PATCH v2 01/29] IPMI.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` Mauro Carvalho Chehab [this message]
2017-06-17 15:26 ` [PATCH v2 03/29] IRQ-domain.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 04/29] irqflags-tracing.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 05/29] IRQ.txt: add a markup for its title Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 06/29] isapnp.txt: promote title level Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 07/29] isa.txt: standardize document format Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 08/29] kernel-per-CPU-kthreads.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 09/29] kobject.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 10/29] kprobes.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 11/29] kref.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 12/29] kselftest.rst: do some adjustments after ReST conversion Mauro Carvalho Chehab
2017-06-23 14:04   ` Shuah Khan
2017-06-23 21:32     ` Mauro Carvalho Chehab
2017-06-24  0:47       ` Shuah Khan
2017-06-25 19:35         ` Jonathan Corbet
2017-06-26 16:30           ` Shuah Khan
2017-06-17 15:26 ` [PATCH v2 13/29] ldm.txt: standardize document format Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 14/29] lockup-watchdogs.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 15/29] lzo.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 16/29] mailbox.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 17/29] memory-barriers.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 18/29] memory-barriers.txt: use literals for variables Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 19/29] memory-hotplug.txt: standardize document format Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 20/29] men-chameleon-bus.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 21/29] nommu-mmap.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 22/29] nommu-mmap.txt: don't use all upper case on titles Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 23/29] ntb.txt: standardize document format Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 24/29] numastat.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 25/29] padata.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 26/29] parport-lowlevel.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 27/29] percpu-rw-semaphore.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 28/29] phy.txt: " Mauro Carvalho Chehab
2017-06-17 15:26 ` [PATCH v2 29/29] pi-futex.txt: " Mauro Carvalho Chehab
2017-06-17 15:46 ` [PATCH v2 01/29] IPMI.txt: " Corey Minyard

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=3cca7deeb1f4ce69c5b9ad47e5384afb97086f07.1497713210.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®