Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 52ddb7e9 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

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'
parents e9d488c3 bdf107d8
Loading
Loading
Loading
Loading
+10 −13
Original line number Original line Diff line number Diff line
@@ -6,8 +6,6 @@
# To add a new book the only step required is to add the book to the
# To add a new book the only step required is to add the book to the
# list of DOCBOOKS.
# list of DOCBOOKS.


ifeq ($(IGNORE_DOCBOOKS),)

DOCBOOKS := z8530book.xml device-drivers.xml \
DOCBOOKS := z8530book.xml device-drivers.xml \
	    kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
	    kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
	    writing_usb_driver.xml networking.xml \
	    writing_usb_driver.xml networking.xml \
@@ -19,6 +17,14 @@ DOCBOOKS := z8530book.xml device-drivers.xml \
	    tracepoint.xml w1.xml \
	    tracepoint.xml w1.xml \
	    writing_musb_glue_layer.xml crypto-API.xml iio.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):
# The build process is as follows (targets):
#              (xmldocs) [by docproc]
#              (xmldocs) [by docproc]
@@ -214,16 +220,7 @@ silent_gen_xml = :
	       -e "s/>/\\>/g";     \
	       -e "s/>/\\>/g";     \
	   echo "</programlisting>")  > $@
	   echo "</programlisting>")  > $@


else
endif # DOCBOOKS=""

htmldocs:
pdfdocs:
psdocs:
xmldocs:
installmandocs:

endif # IGNORE_DOCBOOKS



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




+2 −2
Original line number Original line Diff line number Diff line
@@ -67,6 +67,8 @@ installmandocs:
cleandocs:
cleandocs:
	$(Q)rm -rf $(BUILDDIR)
	$(Q)rm -rf $(BUILDDIR)


endif # HAVE_SPHINX

dochelp:
dochelp:
	@echo  ' Linux kernel internal documentation in different formats (Sphinx):'
	@echo  ' Linux kernel internal documentation in different formats (Sphinx):'
	@echo  '  htmldocs        - HTML'
	@echo  '  htmldocs        - HTML'
@@ -74,5 +76,3 @@ dochelp:
	@echo  '  epubdocs        - EPUB'
	@echo  '  epubdocs        - EPUB'
	@echo  '  xmldocs         - XML'
	@echo  '  xmldocs         - XML'
	@echo  '  cleandocs       - clean all generated files'
	@echo  '  cleandocs       - clean all generated files'

endif # HAVE_SPHINX
+2 −2
Original line number Original line Diff line number Diff line
@@ -2,7 +2,7 @@
				-------
				-------


Written by Paul Menage <menage@google.com> based on
Written by Paul Menage <menage@google.com> based on
Documentation/cgroups/cpusets.txt
Documentation/cgroup-v1/cpusets.txt


Original copyright statements from cpusets.txt:
Original copyright statements from cpusets.txt:
Portions Copyright (C) 2004 BULL SA.
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
tracking. The intention is that other subsystems hook into the generic
cgroup support to provide new attributes for cgroups, such as
cgroup support to provide new attributes for cgroups, such as
accounting/limiting the resources which processes in a cgroup can
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
you to associate a set of CPUs and a set of memory nodes with the
tasks in each cgroup.
tasks in each cgroup.


+1 −1
Original line number Original line Diff line number Diff line
@@ -48,7 +48,7 @@ hooks, beyond what is already present, required to manage dynamic
job placement on large systems.
job placement on large systems.


Cpusets use the generic cgroup subsystem described in
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
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
include CPUs in its CPU affinity mask, and using the mbind(2) and
+2 −2
Original line number Original line Diff line number Diff line
@@ -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.
is complex. This is a document for memcg's internal behavior.
Please note that implementation details can be changed.
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 ?
0. How to record usage ?
   2 objects are used.
   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
	You can see charges have been moved by reading *.usage_in_bytes or
	memory.stat of both A and B.
	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.
	written to move_charge_at_immigrate.


 9.10 Memory thresholds
 9.10 Memory thresholds
Loading