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".

mchehab@s-opensource.com committed 9 years ago

Commit 0e056eb1 parent 40bf19a9 files · +36 −26Browse files

Unified · Split

9 files

block/genhd.c +4 −3
drivers/pci/irq.c +1 −1
include/linux/clk.h +2 −2
ipc/util.c +7 −5
lib/string.c +1 −1
mm/filemap.c +10 −8
mm/page_alloc.c +2 −1
mm/vmalloc.c +1 −1
security/security.c +8 −4

block/genhd.c+4−3

@@ -271,16 +271,17 @@ void blkdev_show(struct seq_file *seqf, off_t offset) · 270 unmodified lines
271	271	/**
272	272	* register_blkdev - register a new block device
273	273	*
274		− * @major: the requested major device number [1..255]. If @major=0, try to
	274	+ * @major: the requested major device number [1..255]. If @major = 0, try to
275	275	* allocate any unused major number.
276	276	* @name: the name of the new block device as a zero terminated string
277	277	*
278	278	* The @name must be unique within the system.
279	279	*
280		− * The return value depends on the @major input parameter.
	280	+ * The return value depends on the @major input parameter:
	281	+ *
281	282	* - if a major device number was requested in range [1..255] then the
282	283	* function returns zero on success, or a negative error code
283		− * - if any unused major number was requested with @major=0 parameter
	284	+ * - if any unused major number was requested with @major = 0 parameter
284	285	* then the return value is the allocated major number in range
285	286	* [1..255] or a negative error code otherwise
286	287	*/

drivers/pci/irq.c+1−1

@@ -31,7 +31,7 @@ static void pci_note_irq_problem(struct pci_dev pdev, const char reason) · 30 unmodified lines
31	31	* driver).
32	32	*
33	33	* Returns:
34		− * a suggestion for fixing it (although the driver is not required to
	34	+ * a suggestion for fixing it (although the driver is not required to
35	35	* act on this).
36	36	*/
37	37	enum pci_lost_interrupt_reason pci_lost_interrupt(struct pci_dev *pdev)

include/linux/clk.h+2−2

@@ -132,8 +132,8 @@ int clk_get_phase(struct clk *clk); · 131 unmodified lines
132	132	* @q: clk compared against p
133	133	*
134	134	* Returns true if the two struct clk pointers both point to the same hardware
135		− * clock node. Put differently, returns true if struct clk p and struct clk q
136		− * share the same struct clk_core object.
	135	+ * clock node. Put differently, returns true if @p and @q
	136	+ * share the same &struct clk_core object.
137	137	*
138	138	* Returns false otherwise. Note that two NULL clks are treated as matching.
139	139	*/

ipc/util.c+7−5

@@ -474,7 +474,7 @@ void ipc_rcu_free(struct rcu_head *head) · 473 unmodified lines
474	474	* Check user, group, other permissions for access
475	475	* to ipc resources. return 0 if allowed
476	476	*
477		− * @flag will most probably be 0 or S_...UGO from <linux/stat.h>
	477	+ * @flag will most probably be 0 or ``S_...UGO`` from <linux/stat.h>
478	478	*/
479	479	int ipcperms(struct ipc_namespace ns, struct kern_ipc_perm ipcp, short flag)
480	480	{
@@ -672,10 +672,12 @@ int ipc_update_perm(struct ipc64_perm in, struct kern_ipc_perm out) · 191 unmodified lines
672	672	*
673	673	* This function does some common audit and permissions check for some IPC_XXX
674	674	* cmd and is called from semctl_down, shmctl_down and msgctl_down.
675		− * It must be called without any lock held and
676		− * - retrieves the ipc with the given id in the given table.
677		− * - performs some audit and permission check, depending on the given cmd
678		− * - returns a pointer to the ipc object or otherwise, the corresponding error.
	675	+ * It must be called without any lock held and:
	676	+ *
	677	+ * - retrieves the ipc with the given id in the given table.
	678	+ * - performs some audit and permission check, depending on the given cmd
	679	+ * - returns a pointer to the ipc object or otherwise, the corresponding
	680	+ * error.
679	681	*
680	682	* Call holding the both the rwsem and the rcu read lock.
681	683	*/

lib/string.c+1−1

@@ -131,7 +131,7 @@ EXPORT_SYMBOL(strncpy); · 130 unmodified lines
131	131	* @src: Where to copy the string from
132	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	135	* NUL-terminated string that fits in the buffer (unless,
136	136	* of course, the buffer size is zero). It does not pad
137	137	* out the result like strncpy() does.

mm/filemap.c+10−8

@@ -519,7 +519,7 @@ EXPORT_SYMBOL(filemap_write_and_wait); · 518 unmodified lines
519	519	*
520	520	* Write out and wait upon file offsets lstart->lend, inclusive.
521	521	*
522		− * Note that `lend' is inclusive (describes the last byte to be written) so
	522	+ * Note that @lend is inclusive (describes the last byte to be written) so
523	523	* that this function can be used to write to the very end-of-file (end = -1).
524	524	*/
525	525	int filemap_write_and_wait_range(struct address_space *mapping,
@@ -1277,12 +1277,14 @@ EXPORT_SYMBOL(find_lock_entry); · 751 unmodified lines
1277	1277	*
1278	1278	* PCG flags modify how the page is returned.
1279	1279	*
1280		− * FGP_ACCESSED: the page will be marked accessed
1281		− * FGP_LOCK: Page is return locked
1282		− * FGP_CREAT: If page is not present then a new page is allocated using
1283		− * @gfp_mask and added to the page cache and the VM's LRU
1284		− * list. The page is returned locked and with an increased
1285		− * refcount. Otherwise, %NULL is returned.
	1280	+ * @fgp_flags can be:
	1281	+ *
	1282	+ * - FGP_ACCESSED: the page will be marked accessed
	1283	+ * - FGP_LOCK: Page is return locked
	1284	+ * - FGP_CREAT: If page is not present then a new page is allocated using
	1285	+ * @gfp_mask and added to the page cache and the VM's LRU
	1286	+ * list. The page is returned locked and with an increased
	1287	+ * refcount. Otherwise, NULL is returned.
1286	1288	*
1287	1289	* If FGP_LOCK or FGP_CREAT are specified then the function may sleep even
1288	1290	* if the GFP flags specified for FGP_CREAT are atomic.
@@ -3001,7 +3003,7 @@ EXPORT_SYMBOL(generic_file_write_iter); · 1712 unmodified lines
3001	3003	* @gfp_mask: memory allocation flags (and I/O mode)
3002	3004	*
3003	3005	* The address_space is to try to release any data against the page
3004		− * (presumably at page->private). If the release was successful, return `1'.
	3006	+ * (presumably at page->private). If the release was successful, return '1'.
3005	3007	* Otherwise return zero.
3006	3008	*
3007	3009	* This may also be called if PG_fscache is set on a page, indicating that the

mm/page_alloc.c+2−1

@@ -4242,7 +4242,8 @@ EXPORT_SYMBOL(free_pages_exact); · 4241 unmodified lines
4242	4242	* nr_free_zone_pages() counts the number of counts pages which are beyond the
4243	4243	* high watermark within all zones at or below a given zone index. For each
4244	4244	* zone, the number of pages is calculated as:
4245		− * managed_pages - high_pages
	4245	+ *
	4246	+ * nr_free_zone_pages = managed_pages - high_pages
4246	4247	*/
4247	4248	static unsigned long nr_free_zone_pages(int offset)
4248	4249	{

mm/vmalloc.c+1−1

@@ -1540,7 +1540,7 @@ void vfree_atomic(const void *addr) · 1539 unmodified lines
1540	1540	* have CONFIG_ARCH_HAVE_NMI_SAFE_CMPXCHG, but making the calling
1541	1541	* conventions for vfree() arch-depenedent would be a really bad idea)
1542	1542	*
1543		− * NOTE: assumes that the object at *addr has a size >= sizeof(llist_node)
	1543	+ * NOTE: assumes that the object at @addr has a size >= sizeof(llist_node)
1544	1544	*/
1545	1545	void vfree(const void *addr)
1546	1546	{

security/security.c+8−4

@@ -103,10 +103,14 @@ static int lsm_append(char new, char *result) · 102 unmodified lines
103	103	* to avoid security registration races. This method may also be used
104	104	* to check if your LSM is currently loaded during kernel initialization.
105	105	*
106		− * Return true if:
107		− * -The passed LSM is the one chosen by user at boot time,
108		− * -or the passed LSM is configured as the default and the user did not
109		− * choose an alternate LSM at boot time.
	106	+ * Returns:
	107	+ *
	108	+ * true if:
	109	+ *
	110	+ * - The passed LSM is the one chosen by user at boot time,
	111	+ * - or the passed LSM is configured as the default and the user did not
	112	+ * choose an alternate LSM at boot time.
	113	+ *
110	114	* Otherwise, return false.
111	115	*/
112	116	int __init security_module_enable(const char *module)