aboutsummaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorLinus Torvalds2017-05-02 12:21:17 -0500
committerLinus Torvalds2017-05-02 12:21:17 -0500
commitc58d4055c054fc6dc72f1be8bc71bd6fff209e48 (patch)
tree56527e28fc65d74d6d5e8397c502ccc87a9ec99b /lib
parentceb198bb007b84ead867e87a71ffe715c4412b15 (diff)
parent9bb0e9cb04c82d6bf0e72f3207307d621083b801 (diff)
downloadkernel-c58d4055c054fc6dc72f1be8bc71bd6fff209e48.tar.gz
kernel-c58d4055c054fc6dc72f1be8bc71bd6fff209e48.tar.xz
kernel-c58d4055c054fc6dc72f1be8bc71bd6fff209e48.zip
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 ...
Diffstat (limited to 'lib')
-rw-r--r--lib/Kconfig.debug9
-rw-r--r--lib/bitmap.c28
-rw-r--r--lib/string.c2
-rw-r--r--lib/vsprintf.c6
4 files changed, 26 insertions, 19 deletions
diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug
index 2598a32d2db1..e2a617e09ab7 100644
--- a/lib/Kconfig.debug
+++ b/lib/Kconfig.debug
@@ -130,7 +130,8 @@ config DYNAMIC_DEBUG
130 nullarbor:~ # echo -n 'func svc_process -p' > 130 nullarbor:~ # echo -n 'func svc_process -p' >
131 <debugfs>/dynamic_debug/control 131 <debugfs>/dynamic_debug/control
132 132
133 See Documentation/dynamic-debug-howto.txt for additional information. 133 See Documentation/admin-guide/dynamic-debug-howto.rst for additional
134 information.
134 135
135endmenu # "printk and dmesg options" 136endmenu # "printk and dmesg options"
136 137
@@ -404,8 +405,8 @@ config MAGIC_SYSRQ
404 by pressing various keys while holding SysRq (Alt+PrintScreen). It 405 by pressing various keys while holding SysRq (Alt+PrintScreen). It
405 also works on a serial console (on PC hardware at least), if you 406 also works on a serial console (on PC hardware at least), if you
406 send a BREAK and then within 5 seconds a command keypress. The 407 send a BREAK and then within 5 seconds a command keypress. The
407 keys are documented in <file:Documentation/sysrq.txt>. Don't say Y 408 keys are documented in <file:Documentation/admin-guide/sysrq.rst>.
408 unless you really know what this hack does. 409 Don't say Y unless you really know what this hack does.
409 410
410config MAGIC_SYSRQ_DEFAULT_ENABLE 411config MAGIC_SYSRQ_DEFAULT_ENABLE
411 hex "Enable magic SysRq key functions by default" 412 hex "Enable magic SysRq key functions by default"
@@ -414,7 +415,7 @@ config MAGIC_SYSRQ_DEFAULT_ENABLE
414 help 415 help
415 Specifies which SysRq key functions are enabled by default. 416 Specifies which SysRq key functions are enabled by default.
416 This may be set to 1 or 0 to enable or disable them all, or 417 This may be set to 1 or 0 to enable or disable them all, or
417 to a bitmask as described in Documentation/sysrq.txt. 418 to a bitmask as described in Documentation/admin-guide/sysrq.rst.
418 419
419config MAGIC_SYSRQ_SERIAL 420config MAGIC_SYSRQ_SERIAL
420 bool "Enable magic SysRq key over serial" 421 bool "Enable magic SysRq key over serial"
diff --git a/lib/bitmap.c b/lib/bitmap.c
index 0b66f0e5eb6b..08c6ef3a2b6f 100644
--- a/lib/bitmap.c
+++ b/lib/bitmap.c
@@ -502,11 +502,11 @@ EXPORT_SYMBOL(bitmap_print_to_pagebuf);
502 * Syntax: range:used_size/group_size 502 * Syntax: range:used_size/group_size
503 * Example: 0-1023:2/256 ==> 0,1,256,257,512,513,768,769 503 * Example: 0-1023:2/256 ==> 0,1,256,257,512,513,768,769
504 * 504 *
505 * Returns 0 on success, -errno on invalid input strings. 505 * Returns: 0 on success, -errno on invalid input strings. Error values:
506 * Error values: 506 *
507 * %-EINVAL: second number in range smaller than first 507 * - ``-EINVAL``: second number in range smaller than first
508 * %-EINVAL: invalid character in string 508 * - ``-EINVAL``: invalid character in string
509 * %-ERANGE: bit number specified too large for mask 509 * - ``-ERANGE``: bit number specified too large for mask
510 */ 510 */
511static int __bitmap_parselist(const char *buf, unsigned int buflen, 511static int __bitmap_parselist(const char *buf, unsigned int buflen,
512 int is_user, unsigned long *maskp, 512 int is_user, unsigned long *maskp,
@@ -864,14 +864,16 @@ EXPORT_SYMBOL(bitmap_bitremap);
864 * 11 was set in @orig had no affect on @dst. 864 * 11 was set in @orig had no affect on @dst.
865 * 865 *
866 * Example [2] for bitmap_fold() + bitmap_onto(): 866 * Example [2] for bitmap_fold() + bitmap_onto():
867 * Let's say @relmap has these ten bits set: 867 * Let's say @relmap has these ten bits set::
868 *
868 * 40 41 42 43 45 48 53 61 74 95 869 * 40 41 42 43 45 48 53 61 74 95
870 *
869 * (for the curious, that's 40 plus the first ten terms of the 871 * (for the curious, that's 40 plus the first ten terms of the
870 * Fibonacci sequence.) 872 * Fibonacci sequence.)
871 * 873 *
872 * Further lets say we use the following code, invoking 874 * Further lets say we use the following code, invoking
873 * bitmap_fold() then bitmap_onto, as suggested above to 875 * bitmap_fold() then bitmap_onto, as suggested above to
874 * avoid the possibility of an empty @dst result: 876 * avoid the possibility of an empty @dst result::
875 * 877 *
876 * unsigned long *tmp; // a temporary bitmap's bits 878 * unsigned long *tmp; // a temporary bitmap's bits
877 * 879 *
@@ -882,22 +884,26 @@ EXPORT_SYMBOL(bitmap_bitremap);
882 * various @orig's. I list the zero-based positions of each set bit. 884 * various @orig's. I list the zero-based positions of each set bit.
883 * The tmp column shows the intermediate result, as computed by 885 * The tmp column shows the intermediate result, as computed by
884 * using bitmap_fold() to fold the @orig bitmap modulo ten 886 * using bitmap_fold() to fold the @orig bitmap modulo ten
885 * (the weight of @relmap). 887 * (the weight of @relmap):
886 * 888 *
889 * =============== ============== =================
887 * @orig tmp @dst 890 * @orig tmp @dst
888 * 0 0 40 891 * 0 0 40
889 * 1 1 41 892 * 1 1 41
890 * 9 9 95 893 * 9 9 95
891 * 10 0 40 (*) 894 * 10 0 40 [#f1]_
892 * 1 3 5 7 1 3 5 7 41 43 48 61 895 * 1 3 5 7 1 3 5 7 41 43 48 61
893 * 0 1 2 3 4 0 1 2 3 4 40 41 42 43 45 896 * 0 1 2 3 4 0 1 2 3 4 40 41 42 43 45
894 * 0 9 18 27 0 9 8 7 40 61 74 95 897 * 0 9 18 27 0 9 8 7 40 61 74 95
895 * 0 10 20 30 0 40 898 * 0 10 20 30 0 40
896 * 0 11 22 33 0 1 2 3 40 41 42 43 899 * 0 11 22 33 0 1 2 3 40 41 42 43
897 * 0 12 24 36 0 2 4 6 40 42 45 53 900 * 0 12 24 36 0 2 4 6 40 42 45 53
898 * 78 102 211 1 2 8 41 42 74 (*) 901 * 78 102 211 1 2 8 41 42 74 [#f1]_
902 * =============== ============== =================
903 *
904 * .. [#f1]
899 * 905 *
900 * (*) For these marked lines, if we hadn't first done bitmap_fold() 906 * For these marked lines, if we hadn't first done bitmap_fold()
901 * into tmp, then the @dst result would have been empty. 907 * into tmp, then the @dst result would have been empty.
902 * 908 *
903 * If either of @orig or @relmap is empty (no set bits), then @dst 909 * If either of @orig or @relmap is empty (no set bits), then @dst
diff --git a/lib/string.c b/lib/string.c
index ed83562a53ae..b5c9a1168d3a 100644
--- a/lib/string.c
+++ b/lib/string.c
@@ -131,7 +131,7 @@ EXPORT_SYMBOL(strncpy);
131 * @src: Where to copy the string from 131 * @src: Where to copy the string from
132 * @size: size of destination buffer 132 * @size: size of destination buffer
133 * 133 *
134 * Compatible with *BSD: the result is always a valid 134 * Compatible with ``*BSD``: the result is always a valid
135 * NUL-terminated string that fits in the buffer (unless, 135 * NUL-terminated string that fits in the buffer (unless,
136 * of course, the buffer size is zero). It does not pad 136 * of course, the buffer size is zero). It does not pad
137 * out the result like strncpy() does. 137 * out the result like strncpy() does.
diff --git a/lib/vsprintf.c b/lib/vsprintf.c
index e3bf4e0f10b5..176641cc549d 100644
--- a/lib/vsprintf.c
+++ b/lib/vsprintf.c
@@ -1954,13 +1954,13 @@ set_precision(struct printf_spec *spec, int prec)
1954 * This function generally follows C99 vsnprintf, but has some 1954 * This function generally follows C99 vsnprintf, but has some
1955 * extensions and a few limitations: 1955 * extensions and a few limitations:
1956 * 1956 *
1957 * %n is unsupported 1957 * - ``%n`` is unsupported
1958 * %p* is handled by pointer() 1958 * - ``%p*`` is handled by pointer()
1959 * 1959 *
1960 * See pointer() or Documentation/printk-formats.txt for more 1960 * See pointer() or Documentation/printk-formats.txt for more
1961 * extensive description. 1961 * extensive description.
1962 * 1962 *
1963 * ** Please update the documentation in both places when making changes ** 1963 * **Please update the documentation in both places when making changes**
1964 * 1964 *
1965 * The return value is the number of characters which would 1965 * The return value is the number of characters which would
1966 * be generated for the given input, excluding the trailing 1966 * be generated for the given input, excluding the trailing