• Linus Torvalds's avatar
    Merge tag 'docs-for-linus' of git://git.lwn.net/linux · 0f776dc3
    Linus Torvalds authored
    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
      ...
    0f776dc3
kernel-parameters.txt 156 KB