Commit Graph

560543 Commits

Author SHA1 Message Date
Manuel Pégourié-Gonnard 9a2885e662 Documentation: fix typo in CodingStyle
Simple typo: "it" for "is".

Signed-off-by: Manuel Pégourié-Gonnard <mpg@elzevir.fr>
Cc: Trivial Patch Monkey <trivial@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-01-11 18:18:16 -07:00
Robert Elliott b03539665d init, Documentation: Remove ramdisk_blocksize mentions
The brd driver has never supported the ramdisk_blocksize kernel
parameter that was in the rd driver it replaced, so remove
mention of this parameter from comments and Documentation.

Commit 9db5579be4 ("rewrite rd") replaced rd with brd, keeping
a brd_blocksize variable in struct brd_device but never using it.

Commit a2cba2913c ("brd: get rid of unused members from struct
brd_device") removed the unused variable.

Commit f5abc8e758 ("Documentation/blockdev/ramdisk.txt: updates")
removed mentions of ramdisk_blocksize from that file.

Signed-off-by: Robert Elliott <elliott@hpe.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-12-26 05:22:00 -07:00
Markus Elfring 563c17cb20 Documentation-getdelays: Apply a recommendation from "checkpatch.pl" in main()
The script "checkpatch.pl" pointed out that assignments should usually
not be performed within condition checks.
Thus move the assignment for the variable "nl_sd" to a separate statement.

Signed-off-by: Markus Elfring <elfring@users.sourceforge.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-12-24 07:22:32 -07:00
SeongJae Park b6e14040c8 Documentation: HOWTO: update versions from 3.x to 4.x
Versions in HOWTO was updated to 4.x by commit
e4144fe5d4 ("docs: update HOWTO for 3.x ->
4.x versioning") but not applied to Korean translation. This commit
apply the change.

Signed-off-by: SeongJae Park <sj38.park@gmail.com>
Acked-by: Minchan Kim <minchan@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-12-24 07:12:23 -07:00
SeongJae Park 403a970cd3 Documentation: remove outdated references from translations
Outdated link to linux-next wiki was removed by commit
ace80793d1 ("Documentation: remove
outdated references to the linux-next wiki"). However, the change was
not applied to translations. This commit apply the change to
translations.

Signed-off-by: SeongJae Park <sj38.park@gmail.com>
Acked-by: Minchan Kim <minchan@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-12-24 07:11:58 -07:00
Masanari Iida 7acccdbc4d Doc: treewide: Fix grammar "a" to "an"
This patch fix some grammar mistake.

Signed-off-by: Masanari Iida <standby24x7@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-12-10 11:36:40 -07:00
Soren Brinkmann aa13a960fc Documentation: cpu-hotplug: Fix sysfs mount instructions
The instructions for mounting sysfs are inconsistent in instructing to
create the directory '/sysfs' but then mounting sysfs to /sys.
Also, indentation is slightly off.

Signed-off-by: Soren Brinkmann <soren.brinkmann@xilinx.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-12-10 11:35:30 -07:00
Stefan Tatschner aecd89e855 can-doc: Add hint about getting timestamps
This patch adds a hint about how to get timestamps of received
CAN frames with ioctl(2). This hint has been applied to the
former SocketCAN Documentation, but it got lost during mainlining
the first bits and pieces to linux kernel.

Signed-off-by: Stefan Tatschner <rumpelsepp@sevenbyte.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-12-10 11:29:11 -07:00
Libor Pechacek bcebb4cc20 Fix CFQ I/O scheduler parameter name in documentation
As seen in block/cfq-iosched.c, the parameter name is low_latency.

Signed-off-by: Libor Pechacek <lpechacek@suse.cz>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-12-10 11:26:24 -07:00
Tom Hebb 51af896be3 Documentation: arm: remove dead links from Marvell Berlin docs
The BG2 and BG2Q are no longer listed on Marvell's site, so the links in
the README go nowhere. The BG2Q's product brief has also been removed.

Signed-off-by: Thomas Hebb <tommyhebb@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-12-10 11:24:26 -07:00
Doug Smythies 1d12554f0a Documentation: HOWTO: update code cross reference link
The source code cross reference link does not work.
Update the link to a site that works.

Signed-off-by: Doug Smythies <dsmythies@telus.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-12-10 11:19:35 -07:00
Masanari Iida 42efcb5da5 Doc: Docbook/iio: Fix typo in iio.tmpl
This patch fix a spelling typo in iio.tmpl.

Signed-off-by: Masanari Iida <standby24x7@gmail.com>
Acked-by: Daniel Baluta <daniel.baluta@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-11-20 17:09:05 -07:00
Mauro Carvalho Chehab e237b65794 DocBook: make index.html generation less verbose by default
When make htmldocs is called on non-verbose mode, it will still be
verbose with index.html generation for no good reason, printing:

	rm -rf Documentation/DocBook/index.html; echo '<h1>Linux Kernel HTML Documentation</h1>' >> Documentation/DocBook/index.html && echo '<h2>Kernel Version: 4.4.0-rc1</h2>' >> Documentation/DocBook/index.html && cat Documentation/DocBook/iio.html >> Documentation/DocBook/index.html

Instead, use the standard non-verbose mode, using:

	  HTML    Documentation/DocBook/index.html

if not called with V=1.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-11-20 17:04:43 -07:00
Mauro Carvalho Chehab 212775516e DocBook: Cleanup: remove an unused $(call) line
There's no build_images function to call. So remove it.

This is just a cleanup patch, with doesn't affect the build.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-11-20 17:04:36 -07:00
Mauro Carvalho Chehab e57f0796d6 DocBook: Add a help message for DOCBOOKS env var
Sometimes, it is needed to compile only a subset of the possible
DocBooks. This is supported by the building system, but it is not
docummented. Add a documentation for it.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-11-20 17:04:26 -07:00
Richard Weinberger f902493a68 stable_kernel_rules.txt: Remove extra space after Cc:
Fixes the checkpatch.pl warning:
"WARNING: Use a single space after Cc:"

Very lazy hackers just copy&paste the stable tag from this
document. As it contains an extra space, checkpatch.pl will
not like the resulting patch...

Signed-off-by: Richard Weinberger <richard@nod.at>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-11-20 16:54:57 -07:00
Masanari Iida d53a7b8ff6 Doc: ioctl: Fix typos in Documentation/ioctl
This patch fix some spelling typos in Documentation/ioctl.

Signed-off-by: Masanari Iida <standby24x7@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-11-20 16:52:50 -07:00
Masanari Iida 547d4c1078 Doc: gpio: Fix typos in Documentation/gpio
This patch fix some spelling typos found in Documentation/gpio.

Signed-off-by: Masanari Iida <standby24x7@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-11-20 16:51:16 -07:00
Tom Hebb 32d79b023a Documentation: arm: remove hyphen from BG2Q in Marvell Berlin docs
The chip's design name isn't hyphenated anywhere else, and none of the
other names in the same document are hyphenated.

Signed-off-by: Thomas Hebb <tommyhebb@gmail.com>
Acked-by: Sebastian Hesselbarth <sebastian.hesselbarth@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-11-20 16:46:59 -07:00
Tom Hebb 4cbbf01961 Documentation: arm: add Marvell Armada 1500 Mini Plus to SoC list
Add known information about the Marvell BG2CDP SoC that's used in
the Google Chromecast 2015 and Kinoma HD devices.

Signed-off-by: Thomas Hebb <tommyhebb@gmail.com>
Acked-by: Sebastian Hesselbarth <sebastian.hesselbarth@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-11-20 16:46:24 -07:00
Tom Hebb 787a40325a Documentation: arm: update homepage URLs for Marvell Berlin SoCs
Marvell has renamed their Berlin family from "Digital Entertainment" to
"Multimedia Solutions." There aren't proper redirects set up for
device-specific pages, so update the URLs accordingly.

Signed-off-by: Thomas Hebb <tommyhebb@gmail.com>
Acked-by: Sebastian Hesselbarth <sebastian.hesselbarth@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-11-20 16:45:46 -07:00
Conchúr Navid b22b5a9ef5 kernel-doc: Fix parsing of DECLARE_BITMAP in struct
Some documented structures in the kernel use DECLARE_BITMAP to create
arrays of unsigned longs to store information using the bitmap functions.
These have to be replaced with a parsable version for kernel-doc.

For example a simple input like

    /**
     * struct something - some test
     * @members: active members
     */
    struct something {
    	DECLARE_BITMAP(members, MAX_MEMBERS);
    };

resulted in parsing warnings like

    warning: No description found for parameter 'MAX_MEMBERS)'
    warning: Excess struct/union/enum/typedef member 'members' description in 'something'

Signed-off-by: Conchúr Navid <conchur@web.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-11-20 16:14:10 -07:00
Conchúr Navid 4468e21eed kernel-doc: Strip #ifdef/#endif in enums
Some enumerations in the kernel headers use #ifdef to reduce their size
based on the the configuration. These lines have to be stripped to avoid
parsing problems.

For example a simple input like

    /**
     * enum flags - test flags
     * @flag1: first flag
     * @flag2: second flag
     */
    enum flags {
    	flag1 = BIT(0),
    #ifdef SECOND_FLAG
    	flag2 = BIT(1),
    #endif
    };

resulted in parsing warnings like

    warning: Enum value '#ifdef SECOND_FLAG;flag2 = BIT(1)' not described in enum 'flags'
    warning: Enum value '#endif;' not described in enum 'flags'

Signed-off-by: Conchúr Navid <conchur@web.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-11-20 16:13:48 -07:00
Conchúr Navid 8a9260aa96 kernel-doc: Fix stripping of #define in enums
The regex to strip single line #define's in enumerations depends on the
fact that the defines are still stored on separate lines. But the
surrounding code already removed newlines and replaced them with
semicolons.

For example a simple input like

    /**
     * enum flags - test flags
     * @flag1: first flag
     * @flag2: second flag
     * @flag3: third flag
     * @flag4: fourth flag
     */
    enum flags {
    	flag1 = BIT(0),
    	flag2 = BIT(1),
    #define flags_small (flag1 | flag2)
    	flag3 = BIT(2),
    	flag4 = BIT(3),
    #define flags_big (flag2 | flag3)
    };

resulted in parsing warnings like

    warning: Enum value '#define flags_small (flag1 | flag2);flag3 = BIT(2)' not described in enum 'flags'
    warning: Enum value '#define flags_big (flag2 | flag3);' not described in enum 'flags'

Signed-off-by: Conchúr Navid <conchur@web.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2015-11-20 16:13:33 -07:00
Linus Torvalds 8005c49d9a Linux 4.4-rc1 2015-11-15 17:00:27 -08:00