Skip to content

Commit 52ddb7e

Browse files
committed
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'
2 parents e9d488c + bdf107d commit 52ddb7e

16 files changed

+31
-34
lines changed

Documentation/DocBook/Makefile

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66
# To add a new book the only step required is to add the book to the
77
# list of DOCBOOKS.
88

9-
ifeq ($(IGNORE_DOCBOOKS),)
10-
119
DOCBOOKS := z8530book.xml device-drivers.xml \
1210
kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
1311
writing_usb_driver.xml networking.xml \
@@ -19,6 +17,14 @@ DOCBOOKS := z8530book.xml device-drivers.xml \
1917
tracepoint.xml w1.xml \
2018
writing_musb_glue_layer.xml crypto-API.xml iio.xml
2119

20+
ifeq ($(DOCBOOKS),)
21+
22+
# Skip DocBook build if the user explicitly requested no DOCBOOKS.
23+
.DEFAULT:
24+
@echo " SKIP DocBook $@ target (DOCBOOKS=\"\" specified)."
25+
26+
else
27+
2228
###
2329
# The build process is as follows (targets):
2430
# (xmldocs) [by docproc]
@@ -214,16 +220,7 @@ silent_gen_xml = :
214220
-e "s/>/\\>/g"; \
215221
echo "</programlisting>") > $@
216222

217-
else
218-
219-
htmldocs:
220-
pdfdocs:
221-
psdocs:
222-
xmldocs:
223-
installmandocs:
224-
225-
endif # IGNORE_DOCBOOKS
226-
223+
endif # DOCBOOKS=""
227224

228225
###
229226
# Help targets as used by the top-level makefile
@@ -240,7 +237,7 @@ dochelp:
240237
@echo ' make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
241238
@echo ' valid values for DOCBOOKS are: $(DOCBOOKS)'
242239
@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"
244241
@echo ' This is useful to generate only the ReST docs (Sphinx)'
245242

246243

Documentation/Makefile.sphinx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,12 @@ installmandocs:
6767
cleandocs:
6868
$(Q)rm -rf $(BUILDDIR)
6969

70+
endif # HAVE_SPHINX
71+
7072
dochelp:
7173
@echo ' Linux kernel internal documentation in different formats (Sphinx):'
7274
@echo ' htmldocs - HTML'
7375
@echo ' pdfdocs - PDF'
7476
@echo ' epubdocs - EPUB'
7577
@echo ' xmldocs - XML'
7678
@echo ' cleandocs - clean all generated files'
77-
78-
endif # HAVE_SPHINX

Documentation/cgroup-v1/cgroups.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
-------
33

44
Written by Paul Menage <[email protected]> based on
5-
Documentation/cgroups/cpusets.txt
5+
Documentation/cgroup-v1/cpusets.txt
66

77
Original copyright statements from cpusets.txt:
88
Portions Copyright (C) 2004 BULL SA.
@@ -72,7 +72,7 @@ On their own, the only use for cgroups is for simple job
7272
tracking. The intention is that other subsystems hook into the generic
7373
cgroup support to provide new attributes for cgroups, such as
7474
accounting/limiting the resources which processes in a cgroup can
75-
access. For example, cpusets (see Documentation/cgroups/cpusets.txt) allow
75+
access. For example, cpusets (see Documentation/cgroup-v1/cpusets.txt) allow
7676
you to associate a set of CPUs and a set of memory nodes with the
7777
tasks in each cgroup.
7878

Documentation/cgroup-v1/cpusets.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ hooks, beyond what is already present, required to manage dynamic
4848
job placement on large systems.
4949

5050
Cpusets use the generic cgroup subsystem described in
51-
Documentation/cgroups/cgroups.txt.
51+
Documentation/cgroup-v1/cgroups.txt.
5252

5353
Requests by a task, using the sched_setaffinity(2) system call to
5454
include CPUs in its CPU affinity mask, and using the mbind(2) and

Documentation/cgroup-v1/memcg_test.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Because VM is getting complex (one of reasons is memcg...), memcg's behavior
66
is complex. This is a document for memcg's internal behavior.
77
Please note that implementation details can be changed.
88

9-
(*) Topics on API should be in Documentation/cgroups/memory.txt)
9+
(*) Topics on API should be in Documentation/cgroup-v1/memory.txt)
1010

1111
0. How to record usage ?
1212
2 objects are used.
@@ -256,7 +256,7 @@ Under below explanation, we assume CONFIG_MEM_RES_CTRL_SWAP=y.
256256

257257
You can see charges have been moved by reading *.usage_in_bytes or
258258
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
260260
written to move_charge_at_immigrate.
261261

262262
9.10 Memory thresholds

Documentation/filesystems/tmpfs.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ A memory policy with a valid NodeList will be saved, as specified, for
9898
use at file creation time. When a task allocates a file in the file
9999
system, the mount option memory policy will be applied with a NodeList,
100100
if 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
102102
below. If the resulting NodeLists is the empty set, the effective memory
103103
policy for the file will revert to "default" policy.
104104

Documentation/kernel-parameters.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3589,7 +3589,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
35893589

35903590
relax_domain_level=
35913591
[KNL, SMP] Set scheduler's default relax_domain_level.
3592-
See Documentation/cgroups/cpusets.txt.
3592+
See Documentation/cgroup-v1/cpusets.txt.
35933593

35943594
relative_sleep_states=
35953595
[SUSPEND] Use sleep state labeling where the deepest
@@ -3918,7 +3918,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
39183918
swapaccount=[0|1]
39193919
[KNL] Enable accounting of swap in memory resource
39203920
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)
39223922

39233923
swiotlb= [ARM,IA-64,PPC,MIPS,X86]
39243924
Format: { <int> | force }

Documentation/kernel-per-CPU-kthreads.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ REFERENCES
1010

1111
o Documentation/IRQ-affinity.txt: Binding interrupts to sets of CPUs.
1212

13-
o Documentation/cgroups: Using cgroups to bind tasks to sets of CPUs.
13+
o Documentation/cgroup-v1: Using cgroups to bind tasks to sets of CPUs.
1414

1515
o man taskset: Using the taskset command to bind tasks to sets
1616
of CPUs.

Documentation/scheduler/sched-deadline.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ CONTENTS
431431

432432
-deadline tasks cannot have an affinity mask smaller that the entire
433433
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).
435435

436436
5.1 SCHED_DEADLINE and cpusets HOWTO
437437
------------------------------------

Documentation/scheduler/sched-design-CFS.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ SCHED_BATCH) tasks.
215215

216216
These options need CONFIG_CGROUPS to be defined, and let the administrator
217217
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.
219219

220220
When CONFIG_FAIR_GROUP_SCHED is defined, a "cpu.shares" file is created for each
221221
group created using the pseudo filesystem. See example steps below to create

Documentation/scheduler/sched-rt-group.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ This uses the cgroup virtual file system and "<cgroup>/cpu.rt_runtime_us"
133133
to control the CPU time reserved for each control group.
134134

135135
For more information on working with control groups, you should read
136-
Documentation/cgroups/cgroups.txt as well.
136+
Documentation/cgroup-v1/cgroups.txt as well.
137137

138138
Group settings are checked against the following limits in order to keep the
139139
configuration schedulable:

Documentation/vm/numa

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ nodes. Each emulated node will manage a fraction of the underlying cells'
6363
physical memory. NUMA emluation is useful for testing NUMA kernel and
6464
application features on non-NUMA platforms, and as a sort of memory resource
6565
management mechanism when used together with cpusets.
66-
[see Documentation/cgroups/cpusets.txt]
66+
[see Documentation/cgroup-v1/cpusets.txt]
6767

6868
For each node with memory, Linux constructs an independent memory management
6969
subsystem, complete with its own free page lists, in-use page lists, usage
@@ -113,7 +113,7 @@ allocation behavior using Linux NUMA memory policy.
113113

114114
System administrators can restrict the CPUs and nodes' memories that a non-
115115
privileged user can specify in the scheduling or NUMA commands and functions
116-
using control groups and CPUsets. [see Documentation/cgroups/cpusets.txt]
116+
using control groups and CPUsets. [see Documentation/cgroup-v1/cpusets.txt]
117117

118118
On architectures that do not hide memoryless nodes, Linux will include only
119119
zones [nodes] with memory in the zonelists. This means that for a memoryless

Documentation/vm/numa_memory_policy.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ document attempts to describe the concepts and APIs of the 2.6 memory policy
99
support.
1010

1111
Memory policies should not be confused with cpusets
12-
(Documentation/cgroups/cpusets.txt)
12+
(Documentation/cgroup-v1/cpusets.txt)
1313
which is an administrative mechanism for restricting the nodes from which
1414
memory may be allocated by a set of processes. Memory policies are a
1515
programming interface that a NUMA-aware application can take advantage of. When

Documentation/vm/page_migration

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ locations.
3838
Larger installations usually partition the system using cpusets into
3939
sections of nodes. Paul Jackson has equipped cpusets with the ability to
4040
move pages when a task is moved to another cpuset (See
41-
Documentation/cgroups/cpusets.txt).
41+
Documentation/cgroup-v1/cpusets.txt).
4242
Cpusets allows the automation of process locality. If a task is moved to
4343
a new cpuset then also all its pages are moved with it so that the
4444
performance of the process does not sink dramatically. Also the pages

Documentation/vm/unevictable-lru.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ MEMORY CONTROL GROUP INTERACTION
122122
--------------------------------
123123

124124
The unevictable LRU facility interacts with the memory control group [aka
125-
memory controller; see Documentation/cgroups/memory.txt] by extending the
125+
memory controller; see Documentation/cgroup-v1/memory.txt] by extending the
126126
lru_list enum.
127127

128128
The memory controller data structure automatically gets a per-zone unevictable

Documentation/x86/x86_64/fake-numa-for-cpusets

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ assign them to cpusets and their attached tasks. This is a way of limiting the
88
amount of system memory that are available to a certain class of tasks.
99

1010
For more information on the features of cpusets, see
11-
Documentation/cgroups/cpusets.txt.
11+
Documentation/cgroup-v1/cpusets.txt.
1212
There are a number of different configurations you can use for your needs. For
1313
more information on the numa=fake command line option and its various ways of
1414
configuring 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:
3333
On node 3 totalpages: 131072
3434

3535
Now following the instructions for mounting the cpusets filesystem from
36-
Documentation/cgroups/cpusets.txt, you can assign fake nodes (i.e. contiguous memory
36+
Documentation/cgroup-v1/cpusets.txt, you can assign fake nodes (i.e. contiguous memory
3737
address spaces) to individual cpusets:
3838

3939
[root@xroads /]# mkdir exampleset

0 commit comments

Comments
 (0)