1. 19 Nov, 2020 14 commits
  2. 18 Nov, 2020 25 commits
  3. 17 Nov, 2020 1 commit
    • Jakub Kicinski's avatar
      Merge branch 'fix-several-bad-kernel-doc-markups' · 6997faa9
      Jakub Kicinski authored
      Mauro Carvalho Chehab says:
      
      ====================
      Fix several bad kernel-doc markups
      
      Kernel-doc has always be limited to a probably bad documented
      rule:
      
      The kernel-doc markups should appear *imediatelly before* the
      function or data structure that it documents.
      
      On other words, if a C file would contain something like this:
      
      	/**
      	 * foo - function foo
      	 * @args: foo args
      	 */
      	static inline void bar(int args);
      
      	/**
      	 * bar - function bar
      	 * @args: foo args
      	 */
      	static inline void foo(void *args);
      
      The output (in ReST format) will be:
      
      	.. c:function:: void bar (int args)
      
      	   function foo
      
      	**Parameters**
      
      	``int args``
      	  foo args
      
      	.. c:function:: void foo (void *args)
      
      	   function bar
      
      	**Parameters**
      
      	``void *args``
      	  foo args
      
      Which is clearly a wrong result.  Before this changeset,
      not even a warning is produced on such cases.
      
      As placing such markups just before the documented
      data is a common practice, on most cases this is fine.
      
      However, as patches touch things, identifiers may be
      renamed, and people may forget to update the kernel-doc
      markups to follow such changes.
      
      This has been happening for quite a while, as there are
      lots of files with kernel-doc problems.
      
      This series address those issues and add a file at the
      end that will enforce that the identifier will match the
      kernel-doc markup, avoiding this problem from
      keep happening as time goes by.
      ====================
      
      Link: https://lore.kernel.org/r/cover.1605521731.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarJakub Kicinski <kuba@kernel.org>
      6997faa9