Merge tag 'doc-4.8-fixes' of git://git.lwn.net/linux
authorLinus Torvalds <torvalds@linux-foundation.org>
Sun, 7 Aug 2016 14:23:17 +0000 (10:23 -0400)
committerLinus Torvalds <torvalds@linux-foundation.org>
Sun, 7 Aug 2016 14:23:17 +0000 (10:23 -0400)
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'

16 files changed:
Documentation/DocBook/Makefile
Documentation/Makefile.sphinx
Documentation/cgroup-v1/cgroups.txt
Documentation/cgroup-v1/cpusets.txt
Documentation/cgroup-v1/memcg_test.txt
Documentation/filesystems/tmpfs.txt
Documentation/kernel-parameters.txt
Documentation/kernel-per-CPU-kthreads.txt
Documentation/scheduler/sched-deadline.txt
Documentation/scheduler/sched-design-CFS.txt
Documentation/scheduler/sched-rt-group.txt
Documentation/vm/numa
Documentation/vm/numa_memory_policy.txt
Documentation/vm/page_migration
Documentation/vm/unevictable-lru.txt
Documentation/x86/x86_64/fake-numa-for-cpusets

index c481df33ef2150f54c84b2e8516881e8d839ef25..64460a897f562d6fde9d2649885ab9c400e0b374 100644 (file)
@@ -6,8 +6,6 @@
 # To add a new book the only step required is to add the book to the
 # list of DOCBOOKS.
 
-ifeq ($(IGNORE_DOCBOOKS),)
-
 DOCBOOKS := z8530book.xml device-drivers.xml \
            kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
            writing_usb_driver.xml networking.xml \
@@ -19,6 +17,14 @@ DOCBOOKS := z8530book.xml device-drivers.xml \
            tracepoint.xml w1.xml \
            writing_musb_glue_layer.xml crypto-API.xml iio.xml
 
+ifeq ($(DOCBOOKS),)
+
+# Skip DocBook build if the user explicitly requested no DOCBOOKS.
+.DEFAULT:
+       @echo "  SKIP    DocBook $@ target (DOCBOOKS=\"\" specified)."
+
+else
+
 ###
 # The build process is as follows (targets):
 #              (xmldocs) [by docproc]
@@ -214,16 +220,7 @@ silent_gen_xml = :
               -e "s/>/\\&gt;/g";     \
           echo "</programlisting>")  > $@
 
-else
-
-htmldocs:
-pdfdocs:
-psdocs:
-xmldocs:
-installmandocs:
-
-endif # IGNORE_DOCBOOKS
-
+endif # DOCBOOKS=""
 
 ###
 # Help targets as used by the top-level makefile
@@ -240,7 +237,7 @@ dochelp:
        @echo  '  make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
        @echo  '  valid values for DOCBOOKS are: $(DOCBOOKS)'
        @echo
-       @echo  "  make IGNORE_DOCBOOKS=1 [target] Don't generate docs from Docbook"
+       @echo  "  make DOCBOOKS=\"\" [target] Don't generate docs from Docbook"
        @echo  '     This is useful to generate only the ReST docs (Sphinx)'
 
 
index b10b6c598ae2c80d74a44222bfdb7558e38033f9..857f1e273418e1a1dffdd23b03b48476f098913b 100644 (file)
@@ -67,6 +67,8 @@ installmandocs:
 cleandocs:
        $(Q)rm -rf $(BUILDDIR)
 
+endif # HAVE_SPHINX
+
 dochelp:
        @echo  ' Linux kernel internal documentation in different formats (Sphinx):'
        @echo  '  htmldocs        - HTML'
@@ -74,5 +76,3 @@ dochelp:
        @echo  '  epubdocs        - EPUB'
        @echo  '  xmldocs         - XML'
        @echo  '  cleandocs       - clean all generated files'
-
-endif # HAVE_SPHINX
index 947e6fe31ef9271f29c3692090f4ab6450519468..308e5ff7207a351e0cf66946bd3e0c4190cd106a 100644 (file)
@@ -2,7 +2,7 @@
                                -------
 
 Written by Paul Menage <menage@google.com> based on
-Documentation/cgroups/cpusets.txt
+Documentation/cgroup-v1/cpusets.txt
 
 Original copyright statements from cpusets.txt:
 Portions Copyright (C) 2004 BULL SA.
@@ -72,7 +72,7 @@ On their own, the only use for cgroups is for simple job
 tracking. The intention is that other subsystems hook into the generic
 cgroup support to provide new attributes for cgroups, such as
 accounting/limiting the resources which processes in a cgroup can
-access. For example, cpusets (see Documentation/cgroups/cpusets.txt) allow
+access. For example, cpusets (see Documentation/cgroup-v1/cpusets.txt) allow
 you to associate a set of CPUs and a set of memory nodes with the
 tasks in each cgroup.
 
index e5cdcd4456153d83e0d88e2d2b06387627667d6b..e5ac5da86682f07ef627a6ebf28fe8ed9f961f99 100644 (file)
@@ -48,7 +48,7 @@ hooks, beyond what is already present, required to manage dynamic
 job placement on large systems.
 
 Cpusets use the generic cgroup subsystem described in
-Documentation/cgroups/cgroups.txt.
+Documentation/cgroup-v1/cgroups.txt.
 
 Requests by a task, using the sched_setaffinity(2) system call to
 include CPUs in its CPU affinity mask, and using the mbind(2) and
index 78a8c2963b38816b152cb07c0f6b82a953b32eaa..5c7f310f32bb9f4d3b92fda7f2b916e4a5339f4f 100644 (file)
@@ -6,7 +6,7 @@ Because VM is getting complex (one of reasons is memcg...), memcg's behavior
 is complex. This is a document for memcg's internal behavior.
 Please note that implementation details can be changed.
 
-(*) Topics on API should be in Documentation/cgroups/memory.txt)
+(*) Topics on API should be in Documentation/cgroup-v1/memory.txt)
 
 0. How to record usage ?
    2 objects are used.
@@ -256,7 +256,7 @@ Under below explanation, we assume CONFIG_MEM_RES_CTRL_SWAP=y.
 
        You can see charges have been moved by reading *.usage_in_bytes or
        memory.stat of both A and B.
-       See 8.2 of Documentation/cgroups/memory.txt to see what value should be
+       See 8.2 of Documentation/cgroup-v1/memory.txt to see what value should be
        written to move_charge_at_immigrate.
 
  9.10 Memory thresholds
index d9c11d25bf02132bebeeceb1b5c2c7e04901d4c7..a85355cf85f449da93c7bd9fc98690344aeba134 100644 (file)
@@ -98,7 +98,7 @@ A memory policy with a valid NodeList will be saved, as specified, for
 use at file creation time.  When a task allocates a file in the file
 system, the mount option memory policy will be applied with a NodeList,
 if any, modified by the calling task's cpuset constraints
-[See Documentation/cgroups/cpusets.txt] and any optional flags, listed
+[See Documentation/cgroup-v1/cpusets.txt] and any optional flags, listed
 below.  If the resulting NodeLists is the empty set, the effective memory
 policy for the file will revert to "default" policy.
 
index eb0a0582d912fdc4dc71f7bf27571a765d10bf15..46c030a49186faabaa588afd2d284975c72c2017 100644 (file)
@@ -3589,7 +3589,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
 
        relax_domain_level=
                        [KNL, SMP] Set scheduler's default relax_domain_level.
-                       See Documentation/cgroups/cpusets.txt.
+                       See Documentation/cgroup-v1/cpusets.txt.
 
        relative_sleep_states=
                        [SUSPEND] Use sleep state labeling where the deepest
@@ -3918,7 +3918,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
        swapaccount=[0|1]
                        [KNL] Enable accounting of swap in memory resource
                        controller if no parameter or 1 is given or disable
-                       it if 0 is given (See Documentation/cgroups/memory.txt)
+                       it if 0 is given (See Documentation/cgroup-v1/memory.txt)
 
        swiotlb=        [ARM,IA-64,PPC,MIPS,X86]
                        Format: { <int> | force }
index edec3a3e648d12eee550f953b6dec87ab58e34f8..bbc3a8b8cff49f5a95cb1a4088d0aa84772a86a3 100644 (file)
@@ -10,7 +10,7 @@ REFERENCES
 
 o      Documentation/IRQ-affinity.txt:  Binding interrupts to sets of CPUs.
 
-o      Documentation/cgroups:  Using cgroups to bind tasks to sets of CPUs.
+o      Documentation/cgroup-v1:  Using cgroups to bind tasks to sets of CPUs.
 
 o      man taskset:  Using the taskset command to bind tasks to sets
        of CPUs.
index e114513a2731dc667071cee0e860d489c80049c0..53a2fe1ae8b8343478a1c3d7c11cba7f3572b15d 100644 (file)
@@ -431,7 +431,7 @@ CONTENTS
 
  -deadline tasks cannot have an affinity mask smaller that the entire
  root_domain they are created on. However, affinities can be specified
- through the cpuset facility (Documentation/cgroups/cpusets.txt).
+ through the cpuset facility (Documentation/cgroup-v1/cpusets.txt).
 
 5.1 SCHED_DEADLINE and cpusets HOWTO
 ------------------------------------
index f14f4930422224a64ea5e6be2575509e17229e12..edd861c94c1bcfd29924aba9c6b5924afeda4880 100644 (file)
@@ -215,7 +215,7 @@ SCHED_BATCH) tasks.
 
    These options need CONFIG_CGROUPS to be defined, and let the administrator
    create arbitrary groups of tasks, using the "cgroup" pseudo filesystem.  See
-   Documentation/cgroups/cgroups.txt for more information about this filesystem.
+   Documentation/cgroup-v1/cgroups.txt for more information about this filesystem.
 
 When CONFIG_FAIR_GROUP_SCHED is defined, a "cpu.shares" file is created for each
 group created using the pseudo filesystem.  See example steps below to create
index 71b54d54998731ebcfe2c451c15066620b384aaa..a03f0d944fe6dad87415588c3554bff04697a745 100644 (file)
@@ -133,7 +133,7 @@ This uses the cgroup virtual file system and "<cgroup>/cpu.rt_runtime_us"
 to control the CPU time reserved for each control group.
 
 For more information on working with control groups, you should read
-Documentation/cgroups/cgroups.txt as well.
+Documentation/cgroup-v1/cgroups.txt as well.
 
 Group settings are checked against the following limits in order to keep the
 configuration schedulable:
index ade01274212d9b4ea8fedfef459d2de670a7ede5..e0b58c0e6b499a81f3d7e93c56b666903071a471 100644 (file)
@@ -63,7 +63,7 @@ nodes.  Each emulated node will manage a fraction of the underlying cells'
 physical memory.  NUMA emluation is useful for testing NUMA kernel and
 application features on non-NUMA platforms, and as a sort of memory resource
 management mechanism when used together with cpusets.
-[see Documentation/cgroups/cpusets.txt]
+[see Documentation/cgroup-v1/cpusets.txt]
 
 For each node with memory, Linux constructs an independent memory management
 subsystem, complete with its own free page lists, in-use page lists, usage
@@ -113,7 +113,7 @@ allocation behavior using Linux NUMA memory policy.
 
 System administrators can restrict the CPUs and nodes' memories that a non-
 privileged user can specify in the scheduling or NUMA commands and functions
-using control groups and CPUsets.  [see Documentation/cgroups/cpusets.txt]
+using control groups and CPUsets.  [see Documentation/cgroup-v1/cpusets.txt]
 
 On architectures that do not hide memoryless nodes, Linux will include only
 zones [nodes] with memory in the zonelists.  This means that for a memoryless
index badb0507608fd188938eef3ee26bc9bee569a38d..622b927816e78147a09ec8dda77ed320a13fe88d 100644 (file)
@@ -9,7 +9,7 @@ document attempts to describe the concepts and APIs of the 2.6 memory policy
 support.
 
 Memory policies should not be confused with cpusets
-(Documentation/cgroups/cpusets.txt)
+(Documentation/cgroup-v1/cpusets.txt)
 which is an administrative mechanism for restricting the nodes from which
 memory may be allocated by a set of processes. Memory policies are a
 programming interface that a NUMA-aware application can take advantage of.  When
index 94bd9c11c4e00cdf750bfeb4a9836f8f3ac9cf2f..0478ae2ad44a388e006fdf7a5b8e75e4b669c09b 100644 (file)
@@ -38,7 +38,7 @@ locations.
 Larger installations usually partition the system using cpusets into
 sections of nodes. Paul Jackson has equipped cpusets with the ability to
 move pages when a task is moved to another cpuset (See
-Documentation/cgroups/cpusets.txt).
+Documentation/cgroup-v1/cpusets.txt).
 Cpusets allows the automation of process locality. If a task is moved to
 a new cpuset then also all its pages are moved with it so that the
 performance of the process does not sink dramatically. Also the pages
index 0026a8d33fc0787bdd26a5ef31763751ecbbe319..e147185724766746d1d05dd21f8938d1b9fa898f 100644 (file)
@@ -122,7 +122,7 @@ MEMORY CONTROL GROUP INTERACTION
 --------------------------------
 
 The unevictable LRU facility interacts with the memory control group [aka
-memory controller; see Documentation/cgroups/memory.txt] by extending the
+memory controller; see Documentation/cgroup-v1/memory.txt] by extending the
 lru_list enum.
 
 The memory controller data structure automatically gets a per-zone unevictable
index 0f11d9becb0b4001657d6ca6b6391f473d3c524e..4b09f18831f831d68b42b57cc45b2b1ffaa0fe2c 100644 (file)
@@ -8,7 +8,7 @@ assign them to cpusets and their attached tasks.  This is a way of limiting the
 amount of system memory that are available to a certain class of tasks.
 
 For more information on the features of cpusets, see
-Documentation/cgroups/cpusets.txt.
+Documentation/cgroup-v1/cpusets.txt.
 There are a number of different configurations you can use for your needs.  For
 more information on the numa=fake command line option and its various ways of
 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:
        On node 3 totalpages: 131072
 
 Now following the instructions for mounting the cpusets filesystem from
-Documentation/cgroups/cpusets.txt, you can assign fake nodes (i.e. contiguous memory
+Documentation/cgroup-v1/cpusets.txt, you can assign fake nodes (i.e. contiguous memory
 address spaces) to individual cpusets:
 
        [root@xroads /]# mkdir exampleset