Skip to content

Commit c58d405

Browse files
torvaldstorvalds
committed
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 ...
2 parents ceb198b + 9bb0e9c commit c58d405

File tree

132 files changed

+6111
-5417
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

132 files changed

+6111
-5417
lines changed

‎Documentation/ABI/stable/sysfs-bus-usb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Description:
99
hubs this facility is always enabled and their device
1010
directories will not contain this file.
1111

12-
For more information, see Documentation/usb/persist.txt.
12+
For more information, see Documentation/driver-api/usb/persist.rst.
1313

1414
What: /sys/bus/usb/devices/.../power/autosuspend
1515
Date: March 2007

‎Documentation/ABI/stable/vdso‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ The vDSO uses symbol versioning; whenever you request a symbol from the
1616
vDSO, specify the version you are expecting.
1717

1818
Programs that dynamically link to glibc will use the vDSO automatically.
19-
Otherwise, you can use the reference parser in Documentation/vDSO/parse_vdso.c.
19+
Otherwise, you can use the reference parser in
20+
tools/testing/selftests/vDSO/parse_vdso.c.
2021

2122
Unless otherwise noted, the set of symbols with any given version and the
2223
ABI of those symbols is considered stable. It may vary across architectures,

‎Documentation/ABI/testing/sysfs-bus-pci‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,5 +299,5 @@ What: /sys/bus/pci/devices/.../revision
299299
Date: November 2016
300300
Contact: Emil Velikov <[email protected]>
301301
Description:
302-
This file contains the revision field of the the PCI device.
302+
This file contains the revision field of the PCI device.
303303
The value comes from device config space. The file is read only.

‎Documentation/DocBook/Makefile‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,11 @@
88

99
DOCBOOKS := z8530book.xml \
1010
kernel-hacking.xml kernel-locking.xml \
11-
writing_usb_driver.xml networking.xml \
12-
kernel-api.xml filesystems.xml lsm.xml kgdb.xml \
13-
gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
14-
genericirq.xml s390-drivers.xml scsi.xml \
15-
sh.xml w1.xml \
16-
writing_musb_glue_layer.xml
11+
networking.xml \
12+
filesystems.xml lsm.xml kgdb.xml \
13+
libata.xml mtdnand.xml librs.xml rapidio.xml \
14+
s390-drivers.xml scsi.xml \
15+
sh.xml w1.xml
1716

1817
ifeq ($(DOCBOOKS),)
1918

@@ -62,11 +61,14 @@ MAN := $(patsubst %.xml, %.9, $(BOOKS))
6261
mandocs: $(MAN)
6362
find $(obj)/man -name '*.9' | xargs gzip -nf
6463

64+
# Default location for installed man pages
65+
export INSTALL_MAN_PATH = $(objtree)/usr
66+
6567
installmandocs: mandocs
66-
mkdir -p /usr/local/man/man9/
68+
mkdir -p $(INSTALL_MAN_PATH)/man/man9/
6769
find $(obj)/man -name '*.9.gz' -printf '%h %f\n' | \
6870
sort -k 2 -k 1 | uniq -f 1 | sed -e 's: :/:' | \
69-
xargs install -m 644 -t /usr/local/man/man9/
71+
xargs install -m 644 -t $(INSTALL_MAN_PATH)/man/man9/
7072

7173
# no-op for the DocBook toolchain
7274
epubdocs:
@@ -238,7 +240,9 @@ dochelp:
238240
@echo ' psdocs - Postscript'
239241
@echo ' xmldocs - XML DocBook'
240242
@echo ' mandocs - man pages'
241-
@echo ' installmandocs - install man pages generated by mandocs'
243+
@echo ' installmandocs - install man pages generated by mandocs to INSTALL_MAN_PATH'; \
244+
echo ' (default: $(INSTALL_MAN_PATH))'; \
245+
echo ''
242246
@echo ' cleandocs - clean all generated DocBook files'
243247
@echo
244248
@echo ' make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'

0 commit comments

Comments
 (0)