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

Commit e535d74b authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'docs-4.5' of git://git.lwn.net/linux 

Pull documentation updates from Jon Corbet:
 "A relatively boring cycle in the docs tree.  There's a few kernel-doc
  fixes and various document tweaks.

  One patch reaches out of the documentation subtree to fix a comment in
  init/do_mounts_rd.c.  There didn't seem to be anybody more appropriate
  to take that one, so I accepted it"

* tag 'docs-4.5' of git://git.lwn.net/linux: (29 commits)
  thermal: add description for integral_cutoff unit
  Documentation: update libhugetlbfs site url
  Documentation: Explain pci=conf1,conf2 more verbosely
  DMA-API: fix confusing sentence in Documentation/DMA-API.txt
  Documentation: translations: update linux cross reference link
  Documentation: fix typo in CodingStyle
  init, Documentation: Remove ramdisk_blocksize mentions
  Documentation-getdelays: Apply a recommendation from "checkpatch.pl" in main()
  Documentation: HOWTO: update versions from 3.x to 4.x
  Documentation: remove outdated references from translations
  Doc: treewide: Fix grammar "a" to "an"
  Documentation: cpu-hotplug: Fix sysfs mount instructions
  can-doc: Add hint about getting timestamps
  Fix CFQ I/O scheduler parameter name in documentation
  Documentation: arm: remove dead links from Marvell Berlin docs
  Documentation: HOWTO: update code cross reference link
  Doc: Docbook/iio: Fix typo in iio.tmpl
  DocBook: make index.html generation less verbose by default
  DocBook: Cleanup: remove an unused $(call) line
  DocBook: Add a help message for DOCBOOKS env var
  ...
parents ece62678 ec3fc58b

Documentation/CodingStyle

+1 −1
Original line number Diff line number Diff line
@@ -430,7 +430,7 @@ The rationale for using gotos is: 
		return result;

	}



A common type of bug to be aware of it "one err bugs" which look like this:

A common type of bug to be aware of is "one err bugs" which look like this:



	err:

		kfree(foo->bar);

Documentation/DMA-API.txt

+1 −1
Original line number Diff line number Diff line
@@ -236,7 +236,7 @@ are guaranteed also to be cache line boundaries). 


DMA_TO_DEVICE synchronisation must be done after the last modification

of the memory region by the software and before it is handed off to

the driver.  Once this primitive is used, memory covered by this

the device.  Once this primitive is used, memory covered by this

primitive should be treated as read-only by the device.  If the device

may write to it at any point, it should be DMA_BIDIRECTIONAL (see

below).

Documentation/DocBook/Makefile

+7 −3
Original line number Diff line number Diff line
@@ -50,8 +50,7 @@ pdfdocs: $(PDF) 


HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))

htmldocs: $(HTML)

	$(call build_main_index)

	$(call build_images)

	$(call cmd,build_main_index)

	$(call install_media_images)



MAN := $(patsubst %.xml, %.9, $(BOOKS))
@@ -139,7 +138,8 @@ quiet_cmd_db2pdf = PDF $@ 


index = index.html

main_idx = $(obj)/$(index)

build_main_index = rm -rf $(main_idx); \

quiet_cmd_build_main_index = HTML    $(main_idx)

      cmd_build_main_index = rm -rf $(main_idx); \

		   echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \

		   echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \

		   cat $(HTML) >> $(main_idx)
@@ -227,6 +227,10 @@ dochelp: 
	@echo  '  mandocs         - man pages'

	@echo  '  installmandocs  - install man pages generated by mandocs'

	@echo  '  cleandocs       - clean all generated DocBook files'

	@echo

	@echo  'make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'

	@echo  '  valid values for DOCBOOKS are: $(DOCBOOKS)'





###

# Temporary files left by various tools

Documentation/DocBook/iio.tmpl

+1 −1
Original line number Diff line number Diff line
@@ -458,7 +458,7 @@ 
            .scan_type = {

              .sign = 's',

              .realbits = 12,

              .storgebits = 16,

              .storagebits = 16,

              .shift = 4,

              .endianness = IIO_LE,

            },

Documentation/HOWTO

+1 −1
Original line number Diff line number Diff line
@@ -209,7 +209,7 @@ tools. One such tool that is particularly recommended is the Linux 
Cross-Reference project, which is able to present source code in a

self-referential, indexed webpage format. An excellent up-to-date

repository of the kernel code may be found at:

	http://lxr.linux.no/+trees

	http://lxr.free-electrons.com/





The development process