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

 /**
  * register_blkdev - register a new block device
  *
- * @major: the requested major device number [1..255]. If @major=0, try to
+ * @major: the requested major device number [1..255]. If @major = 0, try to
  *         allocate any unused major number.
  * @name: the name of the new block device as a zero terminated string
  *
  * 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
+ *  - if any unused major number was requested with @major = 0 parameter
  *    then the return value is the allocated major number in range
  *    [1..255] or a negative error code otherwise
  */

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	* driver).	31	* driver).
32	*	32	*
33	* Returns:	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	* act on this).	35	* act on this).
36	*/	36	*/
37	enum pci_lost_interrupt_reason pci_lost_interrupt(struct pci_dev *pdev)	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	* @q: clk compared against p	132	* @q: clk compared against p
133	*	133	*
134	* Returns true if the two struct clk pointers both point to the same hardware	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	135	* clock node. Put differently, returns true if @p and @q
136	* share the same struct clk_core object.	136	* share the same &struct clk_core object.
137	*	137	*
138	* Returns false otherwise. Note that two NULL clks are treated as matching.	138	* Returns false otherwise. Note that two NULL clks are treated as matching.
139	*/	139	*/

ipc/util.c+7−5

  * 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)
 {
  *
  * 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
+ *   - retrieves the ipc with the given id in the given table.
- *  - returns a pointer to the ipc object or otherwise, the corresponding error.
+ *   - performs some audit and permission check, depending on the given cmd
+ *   - 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

@@ -131,7 +131,7 @@ EXPORT_SYMBOL(strncpy); · 130 unmodified lines
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.

mm/filemap.c+10−8

  *
  * 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,
  *
  * PCG flags modify how the page is returned.
  *
- * FGP_ACCESSED: the page will be marked accessed
+ * @fgp_flags can be:
- * FGP_LOCK: Page is return locked
+ *
- * FGP_CREAT: If page is not present then a new page is allocated using
+ * - FGP_ACCESSED: the page will be marked accessed
- *		@gfp_mask and added to the page cache and the VM's LRU
+ * - FGP_LOCK: Page is return locked
- *		list. The page is returned locked and with an increased
+ * - FGP_CREAT: If page is not present then a new page is allocated using
- *		refcount. Otherwise, %NULL is returned.
+ *   @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.
  *
  * If FGP_LOCK or FGP_CREAT are specified then the function may sleep even
  * if the GFP flags specified for FGP_CREAT are atomic.
  * @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

mm/page_alloc.c+2−1

  * nr_free_zone_pages() counts the number of counts pages which are beyond the
  * high watermark within all zones at or below a given zone index.  For each
  * zone, the number of pages is calculated as:
- *     managed_pages - high_pages
+ *
+ *     nr_free_zone_pages = managed_pages - high_pages
  */
 static unsigned long nr_free_zone_pages(int offset)
 {

mm/vmalloc.c+1−1

@@ -1540,7 +1540,7 @@ void vfree_atomic(const void *addr) · 1539 unmodified lines
1540	* have CONFIG_ARCH_HAVE_NMI_SAFE_CMPXCHG, but making the calling	1540	* have CONFIG_ARCH_HAVE_NMI_SAFE_CMPXCHG, but making the calling
1541	* conventions for vfree() arch-depenedent would be a really bad idea)	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	void vfree(const void *addr)	1545	void vfree(const void *addr)
1546	{	1546	{

security/security.c+8−4

  * to avoid security registration races. This method may also be used
  * to check if your LSM is currently loaded during kernel initialization.
  *
- * Return true if:
+ * Returns:
- *	-The passed LSM is the one chosen by user at boot time,
+ *
- *	-or the passed LSM is configured as the default and the user did not
+ * true if:
- *	 choose an alternate LSM at boot time.
+ *
+ * - The passed LSM is the one chosen by user at boot time,
+ * - or the passed LSM is configured as the default and the user did not
+ *   choose an alternate LSM at boot time.
+ *
  * Otherwise, return false.
  */
 int __init security_module_enable(const char *module)