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

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

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

Pull documentation update from Jonathan Corbet:
 "A reasonably busy cycle for documentation this time around. There is a
  new guide for user-space API documents, rather sparsely populated at
  the moment, but it's a start. Markus improved the infrastructure for
  converting diagrams. Mauro has converted much of the USB documentation
  over to RST. Plus the usual set of fixes, improvements, and tweaks.

  There's a bit more than the usual amount of reaching out of
  Documentation/ to fix comments elsewhere in the tree; I have acks for
  those where I could get them"

* tag 'docs-4.12' of git://git.lwn.net/linux: (74 commits)
  docs: Fix a couple typos
  docs: Fix a spelling error in vfio-mediated-device.txt
  docs: Fix a spelling error in ioctl-number.txt
  MAINTAINERS: update file entry for HSI subsystem
  Documentation: allow installing man pages to a user defined directory
  Doc/PM: Sync with intel_powerclamp code behavior
  zr364xx.rst: usb/devices is now at /sys/kernel/debug/
  usb.rst: move documentation from proc_usb_info.txt to USB ReST book
  convert philips.txt to ReST and add to media docs
  docs-rst: usb: update old usbfs-related documentation
  arm: Documentation: update a path name
  docs: process/4.Coding.rst: Fix a couple of document refs
  docs-rst: fix usb cross-references
  usb: gadget.h: be consistent at kernel doc macros
  usb: composite.h: fix two warnings when building docs
  usb: get rid of some ReST doc build errors
  usb.rst: get rid of some Sphinx errors
  usb/URB.txt: convert to ReST and update it
  usb/persist.txt: convert to ReST and add to driver-api book
  usb/hotplug.txt: convert to ReST and add to driver-api book
  ...
parents ceb198bb 9bb0e9cb

Documentation/ABI/stable/sysfs-bus-usb

+1 −1
Original line number Diff line number Diff line
@@ -9,7 +9,7 @@ Description: 
		hubs this facility is always enabled and their device

		directories will not contain this file.



		For more information, see Documentation/usb/persist.txt.

		For more information, see Documentation/driver-api/usb/persist.rst.



What:		/sys/bus/usb/devices/.../power/autosuspend

Date:		March 2007

Documentation/ABI/stable/vdso

+2 −1
Original line number Diff line number Diff line
@@ -16,7 +16,8 @@ The vDSO uses symbol versioning; whenever you request a symbol from the 
vDSO, specify the version you are expecting.



Programs that dynamically link to glibc will use the vDSO automatically.

Otherwise, you can use the reference parser in Documentation/vDSO/parse_vdso.c.

Otherwise, you can use the reference parser in

tools/testing/selftests/vDSO/parse_vdso.c.



Unless otherwise noted, the set of symbols with any given version and the

ABI of those symbols is considered stable.  It may vary across architectures,

Documentation/ABI/testing/sysfs-bus-pci

+1 −1
Original line number Diff line number Diff line
@@ -299,5 +299,5 @@ What: /sys/bus/pci/devices/.../revision 
Date:		November 2016

Contact:	Emil Velikov <emil.l.velikov@gmail.com>

Description:

		This file contains the revision field of the the PCI device.

		This file contains the revision field of the PCI device.

		The value comes from device config space. The file is read only.

Documentation/DocBook/Makefile

+13 −9
Original line number Diff line number Diff line
@@ -8,12 +8,11 @@ 


DOCBOOKS := z8530book.xml  \

	    kernel-hacking.xml kernel-locking.xml \

	    writing_usb_driver.xml networking.xml \

	    kernel-api.xml filesystems.xml lsm.xml kgdb.xml \

	    gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \

	    genericirq.xml s390-drivers.xml scsi.xml \

	    sh.xml w1.xml \

	    writing_musb_glue_layer.xml

	    networking.xml \

	    filesystems.xml lsm.xml kgdb.xml \

	    libata.xml mtdnand.xml librs.xml rapidio.xml \

	    s390-drivers.xml scsi.xml \

	    sh.xml w1.xml



ifeq ($(DOCBOOKS),)
@@ -62,11 +61,14 @@ MAN := $(patsubst %.xml, %.9, $(BOOKS)) 
mandocs: $(MAN)

	find $(obj)/man -name '*.9' | xargs gzip -nf



# Default location for installed man pages

export INSTALL_MAN_PATH = $(objtree)/usr



installmandocs: mandocs

	mkdir -p /usr/local/man/man9/

	mkdir -p $(INSTALL_MAN_PATH)/man/man9/

	find $(obj)/man -name '*.9.gz' -printf '%h %f\n' | \

		sort -k 2 -k 1 | uniq -f 1 | sed -e 's: :/:' | \

		xargs install -m 644 -t /usr/local/man/man9/

		xargs install -m 644 -t $(INSTALL_MAN_PATH)/man/man9/



# no-op for the DocBook toolchain

epubdocs:
@@ -238,7 +240,9 @@ dochelp: 
	@echo  '  psdocs          - Postscript'

	@echo  '  xmldocs         - XML DocBook'

	@echo  '  mandocs         - man pages'

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

	@echo  '  installmandocs  - install man pages generated by mandocs to INSTALL_MAN_PATH'; \

	 echo  '                    (default: $(INSTALL_MAN_PATH))'; \

	 echo  ''

	@echo  '  cleandocs       - clean all generated DocBook files'

	@echo

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

Documentation/DocBook/gadget.tmpl

deleted100644 → 0
+0 −793

File deleted.

Preview size limit exceeded, changes collapsed.