Merge tag 'docs-for-linus' of git://git.lwn.net/linux
authorLinus Torvalds <torvalds@linux-foundation.org>
Tue, 26 Jul 2016 20:05:11 +0000 (13:05 -0700)
committerLinus Torvalds <torvalds@linux-foundation.org>
Tue, 26 Jul 2016 20:05:11 +0000 (13:05 -0700)
Pull documentation updates from Jonathan Corbet:
 "Some big changes this month, headlined by the addition of a new
  formatted documentation mechanism based on the Sphinx system.

  The objectives here are to make it easier to create better-integrated
  (and more attractive) documents while (eventually) dumping our
  one-of-a-kind, cobbled-together system for something that is widely
  used and maintained by others.  There's a fair amount of information
  what's being done, why, and how to use it in:

    https://lwn.net/Articles/692704/
    https://lwn.net/Articles/692705/

  Closer to home, Documentation/kernel-documentation.rst describes how
  it works.

  For now, the new system exists alongside the old one; you should soon
  see the GPU documentation converted over in the DRM pull and some
  significant media conversion work as well.  Once all the docs have
  been moved over and we're convinced that the rough edges (of which are
  are a few) have been smoothed over, the DocBook-based stuff should go
  away.

  Primary credit is to Jani Nikula for doing the heavy lifting to make
  this stuff actually work; there has also been notable effort from
  Markus Heiser, Daniel Vetter, and Mauro Carvalho Chehab.

  Expect a couple of conflicts on the new index.rst file over the course
  of the merge window; they are trivially resolvable.  That file may be
  a bit of a conflict magnet in the short term, but I don't expect that
  situation to last for any real length of time.

  Beyond that, of course, we have the usual collection of tweaks,
  updates, and typo fixes"

* tag 'docs-for-linus' of git://git.lwn.net/linux: (77 commits)
  doc-rst: kernel-doc: fix handling of address_space tags
  Revert "doc/sphinx: Enable keep_warnings"
  doc-rst: kernel-doc directive, fix state machine reporter
  docs: deprecate kernel-doc-nano-HOWTO.txt
  doc/sphinx: Enable keep_warnings
  Documentation: add watermark_scale_factor to the list of vm systcl file
  kernel-doc: Fix up warning output
  docs: Get rid of some kernel-documentation warnings
  doc-rst: add an option to ignore DocBooks when generating docs
  workqueue: Fix a typo in workqueue.txt
  Doc: ocfs: Fix typo in filesystems/ocfs2-online-filecheck.txt
  Documentation/sphinx: skip build if user requested specific DOCBOOKS
  Documentation: add cleanmediadocs to the documentation targets
  Add .pyc files to .gitignore
  Doc: PM: Fix a typo in intel_powerclamp.txt
  doc-rst: flat-table directive - initial implementation
  Documentation: add meta-documentation for Sphinx and kernel-doc
  Documentation: tiny typo fix in usb/gadget_multi.txt
  Documentation: fix wrong value in md.txt
  bcache: documentation formatting, edited for clarity, stripe alignment notes
  ...

1  2 
Documentation/kernel-parameters.txt
Makefile

index f1fac4d3dc51ee43818b9469649b9728f6f2fa33,a2a662d4da8373e1061950209e1fc9ddf687ecce..724970a25666deed8acd14e57fe03d97e343734b
@@@ -687,14 -687,6 +687,14 @@@ bytes respectively. Such letter suffixe
                        [SPARC64] tick
                        [X86-64] hpet,tsc
  
 +      clocksource.arm_arch_timer.evtstrm=
 +                      [ARM,ARM64]
 +                      Format: <bool>
 +                      Enable/disable the eventstream feature of the ARM
 +                      architected timer so that code using WFE-based polling
 +                      loops can be debugged more effectively on production
 +                      systems.
 +
        clearcpuid=BITNUM [X86]
                        Disable CPUID feature X for the kernel. See
                        arch/x86/include/asm/cpufeatures.h for the valid bit
        js=             [HW,JOY] Analog joystick
                        See Documentation/input/joystick.txt.
  
 -      kaslr/nokaslr   [X86]
 -                      Enable/disable kernel and module base offset ASLR
 -                      (Address Space Layout Randomization) if built into
 -                      the kernel. When CONFIG_HIBERNATION is selected,
 -                      kASLR is disabled by default. When kASLR is enabled,
 -                      hibernation will be disabled.
 +      nokaslr         [KNL]
 +                      When CONFIG_RANDOMIZE_BASE is set, this disables
 +                      kernel and module base offset ASLR (Address Space
 +                      Layout Randomization).
  
        keepinitrd      [HW,ARM]
  
                        timer: [X86] Force use of architectural NMI
                                timer mode (see also oprofile.timer
                                for generic hr timer mode)
 -                              [s390] Force legacy basic mode sampling
 -                                (report cpu_type "timer")
  
        oops=panic      Always panic on oopses. Default is to just kill the
                        process, but there is a small probability of
  
        trace_event=[event-list]
                        [FTRACE] Set and start specified trace events in order
-                       to facilitate early boot debugging.
-                       See also Documentation/trace/events.txt
+                       to facilitate early boot debugging. The event-list is a
+                       comma separated list of trace events to enable. See
+                       also Documentation/trace/events.txt
  
        trace_options=[option-list]
                        [FTRACE] Enable or disable tracer options at boot.
diff --combined Makefile
index e1a5605b01fc5bcc507fb0e8398c42fc5a97f3ea,34bc4e22ec0b70e51fbb6628b3a9335748e0fdb1..6cd4d62cb1c1bbda3f89a2c90e6f5737c8300750
+++ b/Makefile
@@@ -1,7 -1,7 +1,7 @@@
  VERSION = 4
  PATCHLEVEL = 7
  SUBLEVEL = 0
 -EXTRAVERSION = -rc1
 +EXTRAVERSION =
  NAME = Psychotic Stoned Sheep
  
  # *DOCUMENTATION*
@@@ -363,13 -363,11 +363,13 @@@ CHECK           = spars
  
  CHECKFLAGS     := -D__linux__ -Dlinux -D__STDC__ -Dunix -D__unix__ \
                  -Wbitwise -Wno-return-void $(CF)
 +NOSTDINC_FLAGS  =
  CFLAGS_MODULE   =
  AFLAGS_MODULE   =
  LDFLAGS_MODULE  =
  CFLAGS_KERNEL =
  AFLAGS_KERNEL =
 +LDFLAGS_vmlinux =
  CFLAGS_GCOV   = -fprofile-arcs -ftest-coverage -fno-tree-loop-im -Wno-maybe-uninitialized
  CFLAGS_KCOV   = -fsanitize-coverage=trace-pc
  
@@@ -1040,7 -1038,7 +1040,7 @@@ ifdef CONFIG_STACK_VALIDATIO
    ifeq ($(has_libelf),1)
      objtool_target := tools/objtool FORCE
    else
 -    $(warning "Cannot use CONFIG_STACK_VALIDATION, please install libelf-dev or elfutils-libelf-devel")
 +    $(warning "Cannot use CONFIG_STACK_VALIDATION, please install libelf-dev, libelf-devel or elfutils-libelf-devel")
      SKIP_STACK_VALIDATION := 1
      export SKIP_STACK_VALIDATION
    endif
@@@ -1366,6 -1364,8 +1366,8 @@@ help
        @$(MAKE) $(build)=$(package-dir) help
        @echo  ''
        @echo  'Documentation targets:'
+       @$(MAKE) -f $(srctree)/Documentation/Makefile.sphinx dochelp
+       @echo  ''
        @$(MAKE) -f $(srctree)/Documentation/DocBook/Makefile dochelp
        @echo  ''
        @echo  'Architecture specific targets ($(SRCARCH)):'
@@@ -1414,8 -1414,11 +1416,11 @@@ $(help-board-dirs): help-%
  
  # Documentation targets
  # ---------------------------------------------------------------------------
- %docs: scripts_basic FORCE
+ DOC_TARGETS := xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs epubdocs cleandocs cleanmediadocs
+ PHONY += $(DOC_TARGETS)
+ $(DOC_TARGETS): scripts_basic FORCE
        $(Q)$(MAKE) $(build)=scripts build_docproc build_check-lc_ctype
+       $(Q)$(MAKE) $(build)=Documentation -f $(srctree)/Documentation/Makefile.sphinx $@
        $(Q)$(MAKE) $(build)=Documentation/DocBook $@
  
  else # KBUILD_EXTMOD