summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLinus Torvalds <torvalds@linux-foundation.org>2016-08-07 10:23:17 -0400
committerLinus Torvalds <torvalds@linux-foundation.org>2016-08-07 10:23:17 -0400
commit52ddb7e9dd735c1a10722c58d3e069af4d3e6df2 (patch)
tree10746baee8fd439130ab78e6caaadc609a7920d7
parente9d488c3114acb6a0a93e99c02f9cd1d656f46c7 (diff)
parentbdf107d87eb8ce1d1313fee40f3de1a1029a3eca (diff)
Merge tag 'doc-4.8-fixes' of git://git.lwn.net/linux
Pull documentation fixes from Jonathan Corbet: "Three fixes for the docs build, including removing an annoying warning on 'make help' if sphinx isn't present" * tag 'doc-4.8-fixes' of git://git.lwn.net/linux: DocBook: use DOCBOOKS="" to ignore DocBooks instead of IGNORE_DOCBOOKS=1 Documenation: update cgroup's document path Documentation/sphinx: do not warn about missing tools in 'make help'
-rw-r--r--Documentation/DocBook/Makefile23
-rw-r--r--Documentation/Makefile.sphinx4
-rw-r--r--Documentation/cgroup-v1/cgroups.txt4
-rw-r--r--Documentation/cgroup-v1/cpusets.txt2
-rw-r--r--Documentation/cgroup-v1/memcg_test.txt4
-rw-r--r--Documentation/filesystems/tmpfs.txt2
-rw-r--r--Documentation/kernel-parameters.txt4
-rw-r--r--Documentation/kernel-per-CPU-kthreads.txt2
-rw-r--r--Documentation/scheduler/sched-deadline.txt2
-rw-r--r--Documentation/scheduler/sched-design-CFS.txt2
-rw-r--r--Documentation/scheduler/sched-rt-group.txt2
-rw-r--r--Documentation/vm/numa4
-rw-r--r--Documentation/vm/numa_memory_policy.txt2
-rw-r--r--Documentation/vm/page_migration2
-rw-r--r--Documentation/vm/unevictable-lru.txt2
-rw-r--r--Documentation/x86/x86_64/fake-numa-for-cpusets4
16 files changed, 31 insertions, 34 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index c481df33ef21..64460a897f56 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -6,8 +6,6 @@
6# To add a new book the only step required is to add the book to the 6# To add a new book the only step required is to add the book to the
7# list of DOCBOOKS. 7# list of DOCBOOKS.
8 8
9ifeq ($(IGNORE_DOCBOOKS),)
10
11DOCBOOKS := z8530book.xml device-drivers.xml \ 9DOCBOOKS := z8530book.xml device-drivers.xml \
12 kernel-hacking.xml kernel-locking.xml deviceiobook.xml \ 10 kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
13 writing_usb_driver.xml networking.xml \ 11 writing_usb_driver.xml networking.xml \
@@ -19,6 +17,14 @@ DOCBOOKS := z8530book.xml device-drivers.xml \
19 tracepoint.xml w1.xml \ 17 tracepoint.xml w1.xml \
20 writing_musb_glue_layer.xml crypto-API.xml iio.xml 18 writing_musb_glue_layer.xml crypto-API.xml iio.xml
21 19
20ifeq ($(DOCBOOKS),)
21
22# Skip DocBook build if the user explicitly requested no DOCBOOKS.
23.DEFAULT:
24 @echo " SKIP DocBook $@ target (DOCBOOKS=\"\" specified)."
25
26else
27
22### 28###
23# The build process is as follows (targets): 29# The build process is as follows (targets):
24# (xmldocs) [by docproc] 30# (xmldocs) [by docproc]
@@ -214,16 +220,7 @@ silent_gen_xml = :
214 -e "s/>/\\&gt;/g"; \ 220 -e "s/>/\\&gt;/g"; \
215 echo "</programlisting>") > $@ 221 echo "</programlisting>") > $@
216 222
217else 223endif # DOCBOOKS=""
218
219htmldocs:
220pdfdocs:
221psdocs:
222xmldocs:
223installmandocs:
224
225endif # IGNORE_DOCBOOKS
226
227 224
228### 225###
229# Help targets as used by the top-level makefile 226# Help targets as used by the top-level makefile
@@ -240,7 +237,7 @@ dochelp:
240 @echo ' make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml' 237 @echo ' make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
241 @echo ' valid values for DOCBOOKS are: $(DOCBOOKS)' 238 @echo ' valid values for DOCBOOKS are: $(DOCBOOKS)'
242 @echo 239 @echo
243 @echo " make IGNORE_DOCBOOKS=1 [target] Don't generate docs from Docbook" 240 @echo " make DOCBOOKS=\"\" [target] Don't generate docs from Docbook"
244 @echo ' This is useful to generate only the ReST docs (Sphinx)' 241 @echo ' This is useful to generate only the ReST docs (Sphinx)'
245 242
246 243
diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
index b10b6c598ae2..857f1e273418 100644
--- a/Documentation/Makefile.sphinx
+++ b/Documentation/Makefile.sphinx
@@ -67,6 +67,8 @@ installmandocs:
67cleandocs: 67cleandocs:
68 $(Q)rm -rf $(BUILDDIR) 68 $(Q)rm -rf $(BUILDDIR)
69 69
70endif # HAVE_SPHINX
71
70dochelp: 72dochelp:
71 @echo ' Linux kernel internal documentation in different formats (Sphinx):' 73 @echo ' Linux kernel internal documentation in different formats (Sphinx):'
72 @echo ' htmldocs - HTML' 74 @echo ' htmldocs - HTML'
@@ -74,5 +76,3 @@ dochelp:
74 @echo ' epubdocs - EPUB' 76 @echo ' epubdocs - EPUB'
75 @echo ' xmldocs - XML' 77 @echo ' xmldocs - XML'
76 @echo ' cleandocs - clean all generated files' 78 @echo ' cleandocs - clean all generated files'
77
78endif # HAVE_SPHINX
diff --git a/Documentation/cgroup-v1/cgroups.txt b/Documentation/cgroup-v1/cgroups.txt
index 947e6fe31ef9..308e5ff7207a 100644
--- a/Documentation/cgroup-v1/cgroups.txt
+++ b/Documentation/cgroup-v1/cgroups.txt
@@ -2,7 +2,7 @@
2 ------- 2 -------
3 3
4Written by Paul Menage <menage@google.com> based on 4Written by Paul Menage <menage@google.com> based on
5Documentation/cgroups/cpusets.txt 5Documentation/cgroup-v1/cpusets.txt
6 6
7Original copyright statements from cpusets.txt: 7Original copyright statements from cpusets.txt:
8Portions Copyright (C) 2004 BULL SA. 8Portions Copyright (C) 2004 BULL SA.
@@ -72,7 +72,7 @@ On their own, the only use for cgroups is for simple job
72tracking. The intention is that other subsystems hook into the generic 72tracking. The intention is that other subsystems hook into the generic
73cgroup support to provide new attributes for cgroups, such as 73cgroup support to provide new attributes for cgroups, such as
74accounting/limiting the resources which processes in a cgroup can 74accounting/limiting the resources which processes in a cgroup can
75access. For example, cpusets (see Documentation/cgroups/cpusets.txt) allow 75access. For example, cpusets (see Documentation/cgroup-v1/cpusets.txt) allow
76you to associate a set of CPUs and a set of memory nodes with the 76you to associate a set of CPUs and a set of memory nodes with the
77tasks in each cgroup. 77tasks in each cgroup.
78 78
diff --git a/Documentation/cgroup-v1/cpusets.txt b/Documentation/cgroup-v1/cpusets.txt
index e5cdcd445615..e5ac5da86682 100644
--- a/Documentation/cgroup-v1/cpusets.txt
+++ b/Documentation/cgroup-v1/cpusets.txt
@@ -48,7 +48,7 @@ hooks, beyond what is already present, required to manage dynamic
48job placement on large systems. 48job placement on large systems.
49 49
50Cpusets use the generic cgroup subsystem described in 50Cpusets use the generic cgroup subsystem described in
51Documentation/cgroups/cgroups.txt. 51Documentation/cgroup-v1/cgroups.txt.
52 52
53Requests by a task, using the sched_setaffinity(2) system call to 53Requests by a task, using the sched_setaffinity(2) system call to
54include CPUs in its CPU affinity mask, and using the mbind(2) and 54include CPUs in its CPU affinity mask, and using the mbind(2) and
diff --git a/Documentation/cgroup-v1/memcg_test.txt b/Documentation/cgroup-v1/memcg_test.txt
index 78a8c2963b38..5c7f310f32bb 100644
--- a/Documentation/cgroup-v1/memcg_test.txt
+++ b/Documentation/cgroup-v1/memcg_test.txt
@@ -6,7 +6,7 @@ Because VM is getting complex (one of reasons is memcg...), memcg's behavior
6is complex. This is a document for memcg's internal behavior. 6is complex. This is a document for memcg's internal behavior.
7Please note that implementation details can be changed. 7Please note that implementation details can be changed.
8 8
9(*) Topics on API should be in Documentation/cgroups/memory.txt) 9(*) Topics on API should be in Documentation/cgroup-v1/memory.txt)
10 10
110. How to record usage ? 110. How to record usage ?
12 2 objects are used. 12 2 objects are used.
@@ -256,7 +256,7 @@ Under below explanation, we assume CONFIG_MEM_RES_CTRL_SWAP=y.
256 256
257 You can see charges have been moved by reading *.usage_in_bytes or 257 You can see charges have been moved by reading *.usage_in_bytes or
258 memory.stat of both A and B. 258 memory.stat of both A and B.
259 See 8.2 of Documentation/cgroups/memory.txt to see what value should be 259 See 8.2 of Documentation/cgroup-v1/memory.txt to see what value should be
260 written to move_charge_at_immigrate. 260 written to move_charge_at_immigrate.
261 261
262 9.10 Memory thresholds 262 9.10 Memory thresholds
diff --git a/Documentation/filesystems/tmpfs.txt b/Documentation/filesystems/tmpfs.txt
index d9c11d25bf02..a85355cf85f4 100644
--- a/Documentation/filesystems/tmpfs.txt
+++ b/Documentation/filesystems/tmpfs.txt
@@ -98,7 +98,7 @@ A memory policy with a valid NodeList will be saved, as specified, for
98use at file creation time. When a task allocates a file in the file 98use at file creation time. When a task allocates a file in the file
99system, the mount option memory policy will be applied with a NodeList, 99system, the mount option memory policy will be applied with a NodeList,
100if any, modified by the calling task's cpuset constraints 100if any, modified by the calling task's cpuset constraints
101[See Documentation/cgroups/cpusets.txt] and any optional flags, listed 101[See Documentation/cgroup-v1/cpusets.txt] and any optional flags, listed
102below. If the resulting NodeLists is the empty set, the effective memory 102below. If the resulting NodeLists is the empty set, the effective memory
103policy for the file will revert to "default" policy. 103policy for the file will revert to "default" policy.
104 104
diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
index eb0a0582d912..46c030a49186 100644
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -3589,7 +3589,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
3589 3589
3590 relax_domain_level= 3590 relax_domain_level=
3591 [KNL, SMP] Set scheduler's default relax_domain_level. 3591 [KNL, SMP] Set scheduler's default relax_domain_level.
3592 See Documentation/cgroups/cpusets.txt. 3592 See Documentation/cgroup-v1/cpusets.txt.
3593 3593
3594 relative_sleep_states= 3594 relative_sleep_states=
3595 [SUSPEND] Use sleep state labeling where the deepest 3595 [SUSPEND] Use sleep state labeling where the deepest
@@ -3918,7 +3918,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
3918 swapaccount=[0|1] 3918 swapaccount=[0|1]
3919 [KNL] Enable accounting of swap in memory resource 3919 [KNL] Enable accounting of swap in memory resource
3920 controller if no parameter or 1 is given or disable 3920 controller if no parameter or 1 is given or disable
3921 it if 0 is given (See Documentation/cgroups/memory.txt) 3921 it if 0 is given (See Documentation/cgroup-v1/memory.txt)
3922 3922
3923 swiotlb= [ARM,IA-64,PPC,MIPS,X86] 3923 swiotlb= [ARM,IA-64,PPC,MIPS,X86]
3924 Format: { <int> | force } 3924 Format: { <int> | force }
diff --git a/Documentation/kernel-per-CPU-kthreads.txt b/Documentation/kernel-per-CPU-kthreads.txt
index edec3a3e648d..bbc3a8b8cff4 100644
--- a/Documentation/kernel-per-CPU-kthreads.txt
+++ b/Documentation/kernel-per-CPU-kthreads.txt
@@ -10,7 +10,7 @@ REFERENCES
10 10
11o Documentation/IRQ-affinity.txt: Binding interrupts to sets of CPUs. 11o Documentation/IRQ-affinity.txt: Binding interrupts to sets of CPUs.
12 12
13o Documentation/cgroups: Using cgroups to bind tasks to sets of CPUs. 13o Documentation/cgroup-v1: Using cgroups to bind tasks to sets of CPUs.
14 14
15o man taskset: Using the taskset command to bind tasks to sets 15o man taskset: Using the taskset command to bind tasks to sets
16 of CPUs. 16 of CPUs.
diff --git a/Documentation/scheduler/sched-deadline.txt b/Documentation/scheduler/sched-deadline.txt
index e114513a2731..53a2fe1ae8b8 100644
--- a/Documentation/scheduler/sched-deadline.txt
+++ b/Documentation/scheduler/sched-deadline.txt
@@ -431,7 +431,7 @@ CONTENTS
431 431
432 -deadline tasks cannot have an affinity mask smaller that the entire 432 -deadline tasks cannot have an affinity mask smaller that the entire
433 root_domain they are created on. However, affinities can be specified 433 root_domain they are created on. However, affinities can be specified
434 through the cpuset facility (Documentation/cgroups/cpusets.txt). 434 through the cpuset facility (Documentation/cgroup-v1/cpusets.txt).
435 435
4365.1 SCHED_DEADLINE and cpusets HOWTO 4365.1 SCHED_DEADLINE and cpusets HOWTO
437------------------------------------ 437------------------------------------
diff --git a/Documentation/scheduler/sched-design-CFS.txt b/Documentation/scheduler/sched-design-CFS.txt
index f14f49304222..edd861c94c1b 100644
--- a/Documentation/scheduler/sched-design-CFS.txt
+++ b/Documentation/scheduler/sched-design-CFS.txt
@@ -215,7 +215,7 @@ SCHED_BATCH) tasks.
215 215
216 These options need CONFIG_CGROUPS to be defined, and let the administrator 216 These options need CONFIG_CGROUPS to be defined, and let the administrator
217 create arbitrary groups of tasks, using the "cgroup" pseudo filesystem. See 217 create arbitrary groups of tasks, using the "cgroup" pseudo filesystem. See
218 Documentation/cgroups/cgroups.txt for more information about this filesystem. 218 Documentation/cgroup-v1/cgroups.txt for more information about this filesystem.
219 219
220When CONFIG_FAIR_GROUP_SCHED is defined, a "cpu.shares" file is created for each 220When CONFIG_FAIR_GROUP_SCHED is defined, a "cpu.shares" file is created for each
221group created using the pseudo filesystem. See example steps below to create 221group created using the pseudo filesystem. See example steps below to create
diff --git a/Documentation/scheduler/sched-rt-group.txt b/Documentation/scheduler/sched-rt-group.txt
index 71b54d549987..a03f0d944fe6 100644
--- a/Documentation/scheduler/sched-rt-group.txt
+++ b/Documentation/scheduler/sched-rt-group.txt
@@ -133,7 +133,7 @@ This uses the cgroup virtual file system and "<cgroup>/cpu.rt_runtime_us"
133to control the CPU time reserved for each control group. 133to control the CPU time reserved for each control group.
134 134
135For more information on working with control groups, you should read 135For more information on working with control groups, you should read
136Documentation/cgroups/cgroups.txt as well. 136Documentation/cgroup-v1/cgroups.txt as well.
137 137
138Group settings are checked against the following limits in order to keep the 138Group settings are checked against the following limits in order to keep the
139configuration schedulable: 139configuration schedulable:
diff --git a/Documentation/vm/numa b/Documentation/vm/numa
index ade01274212d..e0b58c0e6b49 100644
--- a/Documentation/vm/numa
+++ b/Documentation/vm/numa
@@ -63,7 +63,7 @@ nodes. Each emulated node will manage a fraction of the underlying cells'
63physical memory. NUMA emluation is useful for testing NUMA kernel and 63physical memory. NUMA emluation is useful for testing NUMA kernel and
64application features on non-NUMA platforms, and as a sort of memory resource 64application features on non-NUMA platforms, and as a sort of memory resource
65management mechanism when used together with cpusets. 65management mechanism when used together with cpusets.
66[see Documentation/cgroups/cpusets.txt] 66[see Documentation/cgroup-v1/cpusets.txt]
67 67
68For each node with memory, Linux constructs an independent memory management 68For each node with memory, Linux constructs an independent memory management
69subsystem, complete with its own free page lists, in-use page lists, usage 69subsystem, complete with its own free page lists, in-use page lists, usage
@@ -113,7 +113,7 @@ allocation behavior using Linux NUMA memory policy.
113 113
114System administrators can restrict the CPUs and nodes' memories that a non- 114System administrators can restrict the CPUs and nodes' memories that a non-
115privileged user can specify in the scheduling or NUMA commands and functions 115privileged user can specify in the scheduling or NUMA commands and functions
116using control groups and CPUsets. [see Documentation/cgroups/cpusets.txt] 116using control groups and CPUsets. [see Documentation/cgroup-v1/cpusets.txt]
117 117
118On architectures that do not hide memoryless nodes, Linux will include only 118On architectures that do not hide memoryless nodes, Linux will include only
119zones [nodes] with memory in the zonelists. This means that for a memoryless 119zones [nodes] with memory in the zonelists. This means that for a memoryless
diff --git a/Documentation/vm/numa_memory_policy.txt b/Documentation/vm/numa_memory_policy.txt
index badb0507608f..622b927816e7 100644
--- a/Documentation/vm/numa_memory_policy.txt
+++ b/Documentation/vm/numa_memory_policy.txt
@@ -9,7 +9,7 @@ document attempts to describe the concepts and APIs of the 2.6 memory policy
9support. 9support.
10 10
11Memory policies should not be confused with cpusets 11Memory policies should not be confused with cpusets
12(Documentation/cgroups/cpusets.txt) 12(Documentation/cgroup-v1/cpusets.txt)
13which is an administrative mechanism for restricting the nodes from which 13which is an administrative mechanism for restricting the nodes from which
14memory may be allocated by a set of processes. Memory policies are a 14memory may be allocated by a set of processes. Memory policies are a
15programming interface that a NUMA-aware application can take advantage of. When 15programming interface that a NUMA-aware application can take advantage of. When
diff --git a/Documentation/vm/page_migration b/Documentation/vm/page_migration
index 94bd9c11c4e0..0478ae2ad44a 100644
--- a/Documentation/vm/page_migration
+++ b/Documentation/vm/page_migration
@@ -38,7 +38,7 @@ locations.
38Larger installations usually partition the system using cpusets into 38Larger installations usually partition the system using cpusets into
39sections of nodes. Paul Jackson has equipped cpusets with the ability to 39sections of nodes. Paul Jackson has equipped cpusets with the ability to
40move pages when a task is moved to another cpuset (See 40move pages when a task is moved to another cpuset (See
41Documentation/cgroups/cpusets.txt). 41Documentation/cgroup-v1/cpusets.txt).
42Cpusets allows the automation of process locality. If a task is moved to 42Cpusets allows the automation of process locality. If a task is moved to
43a new cpuset then also all its pages are moved with it so that the 43a new cpuset then also all its pages are moved with it so that the
44performance of the process does not sink dramatically. Also the pages 44performance of the process does not sink dramatically. Also the pages
diff --git a/Documentation/vm/unevictable-lru.txt b/Documentation/vm/unevictable-lru.txt
index 0026a8d33fc0..e14718572476 100644
--- a/Documentation/vm/unevictable-lru.txt
+++ b/Documentation/vm/unevictable-lru.txt
@@ -122,7 +122,7 @@ MEMORY CONTROL GROUP INTERACTION
122-------------------------------- 122--------------------------------
123 123
124The unevictable LRU facility interacts with the memory control group [aka 124The unevictable LRU facility interacts with the memory control group [aka
125memory controller; see Documentation/cgroups/memory.txt] by extending the 125memory controller; see Documentation/cgroup-v1/memory.txt] by extending the
126lru_list enum. 126lru_list enum.
127 127
128The memory controller data structure automatically gets a per-zone unevictable 128The memory controller data structure automatically gets a per-zone unevictable
diff --git a/Documentation/x86/x86_64/fake-numa-for-cpusets b/Documentation/x86/x86_64/fake-numa-for-cpusets
index 0f11d9becb0b..4b09f18831f8 100644
--- a/Documentation/x86/x86_64/fake-numa-for-cpusets
+++ b/Documentation/x86/x86_64/fake-numa-for-cpusets
@@ -8,7 +8,7 @@ assign them to cpusets and their attached tasks. This is a way of limiting the
8amount of system memory that are available to a certain class of tasks. 8amount of system memory that are available to a certain class of tasks.
9 9
10For more information on the features of cpusets, see 10For more information on the features of cpusets, see
11Documentation/cgroups/cpusets.txt. 11Documentation/cgroup-v1/cpusets.txt.
12There are a number of different configurations you can use for your needs. For 12There are a number of different configurations you can use for your needs. For
13more information on the numa=fake command line option and its various ways of 13more information on the numa=fake command line option and its various ways of
14configuring fake nodes, see Documentation/x86/x86_64/boot-options.txt. 14configuring fake nodes, see Documentation/x86/x86_64/boot-options.txt.
@@ -33,7 +33,7 @@ A machine may be split as follows with "numa=fake=4*512," as reported by dmesg:
33 On node 3 totalpages: 131072 33 On node 3 totalpages: 131072
34 34
35Now following the instructions for mounting the cpusets filesystem from 35Now following the instructions for mounting the cpusets filesystem from
36Documentation/cgroups/cpusets.txt, you can assign fake nodes (i.e. contiguous memory 36Documentation/cgroup-v1/cpusets.txt, you can assign fake nodes (i.e. contiguous memory
37address spaces) to individual cpusets: 37address spaces) to individual cpusets:
38 38
39 [root@xroads /]# mkdir exampleset 39 [root@xroads /]# mkdir exampleset