Commit 0e056eb5 authored by mchehab@s-opensource.com's avatar mchehab@s-opensource.com Committed by Jonathan Corbet
Browse files

kernel-api.rst: fix a series of errors when parsing C files 



./lib/string.c:134: WARNING: Inline emphasis start-string without end-string.
./mm/filemap.c:522: WARNING: Inline interpreted text or phrase reference start-string without end-string.
./mm/filemap.c:1283: ERROR: Unexpected indentation.
./mm/filemap.c:3003: WARNING: Inline interpreted text or phrase reference start-string without end-string.
./mm/vmalloc.c:1544: WARNING: Inline emphasis start-string without end-string.
./mm/page_alloc.c:4245: ERROR: Unexpected indentation.
./ipc/util.c:676: ERROR: Unexpected indentation.
./drivers/pci/irq.c:35: WARNING: Block quote ends without a blank line; unexpected unindent.
./security/security.c:109: ERROR: Unexpected indentation.
./security/security.c:110: WARNING: Definition list ends without a blank line; unexpected unindent.
./block/genhd.c:275: WARNING: Inline strong start-string without end-string.
./block/genhd.c:283: WARNING: Inline strong start-string without end-string.
./include/linux/clk.h:134: WARNING: Inline emphasis start-string without end-string.
./include/linux/clk.h:134: WARNING: Inline emphasis start-string without end-string.
./ipc/util.c:477: ERROR: Unknown target name: "s".

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Acked-by: default avatarBjorn Helgaas <bhelgaas@google.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 40bf19a8

block/genhd.c

+4 −3
Original line number Diff line number Diff line
@@ -277,7 +277,8 @@ void blkdev_show(struct seq_file *seqf, off_t offset) 
 *

 * The @name must be unique within the system.

 *

 * The return value depends on the @major input parameter.

 * The return value depends on the @major input parameter:

 *

 *  - if a major device number was requested in range [1..255] then the

 *    function returns zero on success, or a negative error code

 *  - if any unused major number was requested with @major = 0 parameter

include/linux/clk.h

+2 −2
Original line number Diff line number Diff line
@@ -132,8 +132,8 @@ int clk_get_phase(struct clk *clk); 
 * @q: clk compared against p

 *

 * Returns true if the two struct clk pointers both point to the same hardware

 * clock node. Put differently, returns true if struct clk *p and struct clk *q

 * share the same struct clk_core object.

 * clock node. Put differently, returns true if @p and @q

 * share the same &struct clk_core object.

 *

 * Returns false otherwise. Note that two NULL clks are treated as matching.

 */

ipc/util.c

+7 −5
Original line number Diff line number Diff line
@@ -474,7 +474,7 @@ void ipc_rcu_free(struct rcu_head *head) 
 * Check user, group, other permissions for access

 * to ipc resources. return 0 if allowed

 *

 * @flag will most probably be 0 or S_...UGO from <linux/stat.h>

 * @flag will most probably be 0 or ``S_...UGO`` from <linux/stat.h>

 */

int ipcperms(struct ipc_namespace *ns, struct kern_ipc_perm *ipcp, short flag)

{
@@ -672,10 +672,12 @@ int ipc_update_perm(struct ipc64_perm *in, struct kern_ipc_perm *out) 
 *

 * This function does some common audit and permissions check for some IPC_XXX

 * cmd and is called from semctl_down, shmctl_down and msgctl_down.

 * It must be called without any lock held and

 * It must be called without any lock held and:

 *

 *   - retrieves the ipc with the given id in the given table.

 *   - performs some audit and permission check, depending on the given cmd

 *  - returns a pointer to the ipc object or otherwise, the corresponding error.

 *   - returns a pointer to the ipc object or otherwise, the corresponding

 *     error.

 *

 * Call holding the both the rwsem and the rcu read lock.

 */

lib/string.c

+1 −1
Original line number Diff line number Diff line
@@ -131,7 +131,7 @@ EXPORT_SYMBOL(strncpy); 
 * @src: Where to copy the string from

 * @size: size of destination buffer

 *

 * Compatible with *BSD: the result is always a valid

 * Compatible with ``*BSD``: the result is always a valid

 * NUL-terminated string that fits in the buffer (unless,

 * of course, the buffer size is zero). It does not pad

 * out the result like strncpy() does.

mm/filemap.c

+10 −8
Original line number Diff line number Diff line
@@ -519,7 +519,7 @@ EXPORT_SYMBOL(filemap_write_and_wait); 
 *

 * Write out and wait upon file offsets lstart->lend, inclusive.

 *

 * Note that `lend' is inclusive (describes the last byte to be written) so

 * Note that @lend is inclusive (describes the last byte to be written) so

 * that this function can be used to write to the very end-of-file (end = -1).

 */

int filemap_write_and_wait_range(struct address_space *mapping,
@@ -1277,12 +1277,14 @@ EXPORT_SYMBOL(find_lock_entry); 
 *

 * PCG flags modify how the page is returned.

 *

 * FGP_ACCESSED: the page will be marked accessed

 * FGP_LOCK: Page is return locked

 * FGP_CREAT: If page is not present then a new page is allocated using

 * @fgp_flags can be:

 *

 * - FGP_ACCESSED: the page will be marked accessed

 * - FGP_LOCK: Page is return locked

 * - FGP_CREAT: If page is not present then a new page is allocated using

 *   @gfp_mask and added to the page cache and the VM's LRU

 *   list. The page is returned locked and with an increased

 *		refcount. Otherwise, %NULL is returned.

 *   refcount. Otherwise, NULL is returned.

 *

 * If FGP_LOCK or FGP_CREAT are specified then the function may sleep even

 * if the GFP flags specified for FGP_CREAT are atomic.
@@ -3001,7 +3003,7 @@ EXPORT_SYMBOL(generic_file_write_iter); 
 * @gfp_mask: memory allocation flags (and I/O mode)

 *

 * The address_space is to try to release any data against the page

 * (presumably at page->private).  If the release was successful, return `1'.

 * (presumably at page->private).  If the release was successful, return '1'.

 * Otherwise return zero.

 *

 * This may also be called if PG_fscache is set on a page, indicating that the

CRA Git | Maintained and supported by SUSTech CRA and CCSE