1. 01 5月, 2009 1 次提交
  2. 12 2月, 2009 1 次提交
    • R
      kernel-doc: fix syscall wrapper processing · b4870bc5
      Randy Dunlap 提交于
      Fix kernel-doc processing of SYSCALL wrappers.
      
      The SYSCALL wrapper patches played havoc with kernel-doc for
      syscalls.  Syscalls that were scanned for DocBook processing
      reported warnings like this one, for sys_tgkill:
      
      Warning(kernel/signal.c:2285): No description found for parameter 'tgkill'
      Warning(kernel/signal.c:2285): No description found for parameter 'pid_t'
      Warning(kernel/signal.c:2285): No description found for parameter 'int'
      
      because the macro parameters all "look like" function parameters,
      although they are not:
      
      /**
       *  sys_tgkill - send signal to one specific thread
       *  @tgid: the thread group ID of the thread
       *  @pid: the PID of the thread
       *  @sig: signal to be sent
       *
       *  This syscall also checks the @tgid and returns -ESRCH even if the PID
       *  exists but it's not belonging to the target process anymore. This
       *  method solves the problem of threads exiting and PIDs getting reused.
       */
      SYSCALL_DEFINE3(tgkill, pid_t, tgid, pid_t, pid, int, sig)
      {
      ...
      
      This patch special-cases the handling SYSCALL_DEFINE* function
      prototypes by expanding them to
      	long sys_foobar(type1 arg1, type1 arg2, ...)
      Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
      Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
      Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>
      b4870bc5
  3. 20 12月, 2008 1 次提交
  4. 02 12月, 2008 1 次提交
  5. 27 10月, 2008 1 次提交
  6. 23 9月, 2008 1 次提交
  7. 06 8月, 2008 1 次提交
  8. 26 7月, 2008 1 次提交
    • R
      kernel-doc: handle/strip __init · 74fc5c65
      Randy Dunlap 提交于
      Handle __init in functions with kernel-doc notation by stripping the
      __init away from the output doc.  This is already being done for
      "__devinit".  This patch fixes these kernel-doc error/aborts:
      
      Error(linux-next-20080619//drivers/usb/gadget/config.c:132): cannot understand prototype: 'struct usb_descriptor_header **__init usb_copy_descriptors(struct usb_descriptor_header **src) '
      Error(linux-next-20080619//drivers/usb/gadget/config.c:182): cannot understand prototype: 'struct usb_endpoint_descriptor *__init usb_find_endpoint( 	struct usb_descriptor_header **src, 	struct usb_descriptor_header **copy, 	struct usb_endpoint_descriptor *match ) '
      Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
      Cc: David Brownell <dbrownell@users.sourceforge.net>
      Signed-off-by: NSam Ravnborg <sam@ravnborg.org>
      74fc5c65
  9. 20 5月, 2008 1 次提交
  10. 28 4月, 2008 2 次提交
  11. 14 3月, 2008 1 次提交
  12. 24 2月, 2008 1 次提交
    • R
      kernel-doc: fix function-pointer-parameter parsing · 00d62961
      Richard Kennedy 提交于
      When running "make htmldocs" I'm seeing some non-fatal perl errors caused
      by trying to parse the callback function definitions in blk-core.c.
      
      The errors are "Use of uninitialized value in concatenation (.)..."
      in combination with:
      Warning(linux-2.6.25-rc2/block/blk-core.c:1877): No description found for parameter ''
      
      The function pointers are defined without a * i.e.
      int (drv_callback)(struct request *)
      
      The compiler is happy with them, but kernel-doc isn't.
      
      This patch teaches create_parameterlist in kernel-doc to parse this type of
      function pointer definition, but is it the right way to fix the problem ?
      The problem only seems to occur in blk-core.c.
      
      However with the patch applied, kernel-doc finds the correct parameter
      description for the callback in blk_end_request_callback, which is doesn't
      normally.
      
      I thought it would be a bit odd to change to code to use the more normal
      form of function pointers just to get the documentation to work, so I fixed
      kernel-doc instead - even though this is teaching it to understand code
      that might go away (The comment for blk_end_request_callback says that it
      should not be used and will removed at some point).
      Signed-off-by: NRichard Kennedy <richard@rsk.demon.co.uk>
      Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
      Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
      Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>
      00d62961
  13. 15 2月, 2008 1 次提交
  14. 08 2月, 2008 3 次提交
  15. 29 1月, 2008 4 次提交
  16. 17 10月, 2007 1 次提交
    • R
      kernel-doc: fix doc blocks and html · 6b5b55f6
      Randy Dunlap 提交于
      Johannes Berg reports (Thanks!) that &struct names are not highlighted in
      html output format when they are inside a DOC: block.
      
      DOC: blocks were not escaped thru xml_escape() like other kernel-doc
      comments were.  Fixed that.
      
      However, that left a problem with <p> ($blankline_html) being processed
      thru xml_escape(), converting it to &lt;p&gt;, which isn't good for the
      generated html output (the <p> should remain unchanged), so this patch also
      introduces the notion of "local" kernel-doc meta-characters
      ('\\\\mnemonic:'), which are converted to html just before writing the
      stream to its output file.
      
      Please report any problems that you (anyone) see in "highlighting" in any
      output mode (text, man, html, xml).
      
      Also update copyright to include me.
      Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
      Cc: Johannes Berg <johannes@sipsolutions.net>
      Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
      Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>
      6b5b55f6
  17. 20 7月, 2007 3 次提交
  18. 10 5月, 2007 1 次提交
  19. 09 5月, 2007 4 次提交
    • B
      kill warnings when building mandocs · 53f049fa
      Borislav Petkov 提交于
      This patch shuts warnings of the sort:
      
      make -C /mnt/samsung_200/sam/kernel/trees/21-rc6/build \
      	KBUILD_SRC=/mnt/samsung_200/sam/kernel/trees/21-rc6 \
      	KBUILD_EXTMOD="" -f /mnt/samsung_200/sam/kernel/trees/21-rc6/Makefile mandocs
      make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=scripts/basic
      make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=Documentation/DocBook mandocs
        SRCTREE=/mnt/samsung_200/sam/kernel/trees/21-rc6/ /mnt/samsung_200/sam/kernel/trees/21-rc6/build/scripts/basic/docproc doc /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/wanbook.tmpl >Documentation/DocBook/wanbook.xml
        if grep -q refentry Documentation/DocBook/wanbook.xml; then xmlto man -m /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/stylesheet.xsl -o Documentation/DocBook/man Documentation/DocBook/wanbook.xml ; gzip -f Documentation/DocBook/man/*.9; fi
      Note: meta version: No productnumber or alternative     sppp_close
      Note: meta version: No refmiscinfo@class=version        sppp_close
      Note: Writing sppp_close.9
      Note: meta version: No productnumber or alternative     sppp_open
      Note: meta version: No refmiscinfo@class=version        sppp_open
      
      by adding a RefMiscInfo xml tag in the form of the current kernel version
      to the function, struct and enum definitions in files included by
      kernel-doc when building 'mandocs'.  However, the version string appears
      truncated on the manpage due to some constraints in the xml DTD for the man
      header, I believe, for the troff output is truncated too.
      Signed-off-by: NBorislav Petkov <bbpetkov@yahoo.de>
      Cc: "Randy.Dunlap" <rdunlap@xenotime.net>
      Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
      Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>
      53f049fa
    • R
      kernel-doc: html mode struct highlights · 3eb014a1
      Randy Dunlap 提交于
      Johannes Berg reported that struct names are not highlighted
      (bold, italic, etc.) in html kernel-doc output.  (Also not in
      text-mode output, but I don't see that changing.)
      
      This patch adds the following:
      - highlight struct names in html output mode
      - highlight environment var. names in html output mode
      - indent struct fields in the original struct layout
      Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
      Cc: Johannes Berg <johannes@sipsolutions.net>
      Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
      Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>
      3eb014a1
    • B
      kernel-doc: handle arrays with arithmetic expressions as initializers · 884f2810
      Borislav Petkov 提交于
      In a different approach here's a patch that handles the special case of
      composite arithmetic expressions in array size initializers.  With it,
      prior to pushing the split strings on the @first_arg array, I split the
      keywords before the array name as before and then keep the array name along
      with the subscript expression as a single whole element which gets pushed
      last.  In this manner, kernel-doc produces correct output without removing
      whitespaces which makes the array subscripts unreadable in the docs.
      Signed-off-by: NBorislav Petkov <bbpetkov@yahoo.de>
      Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
      Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
      Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>
      884f2810
    • R
      scripts: kernel-doc whitespace cleanup · 3c308798
      Randy Dunlap 提交于
      Whitespace cleanup only:  convert some series of spaces to tabs.
      Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
      Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
      Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>
      3c308798
  20. 02 3月, 2007 1 次提交
  21. 21 2月, 2007 1 次提交
  22. 12 2月, 2007 5 次提交
  23. 23 12月, 2006 1 次提交
  24. 08 12月, 2006 1 次提交
  25. 12 10月, 2006 1 次提交
    • R
      [PATCH] kernel-doc: make parameter description indentation uniform · 27205744
      Randy Dunlap 提交于
      - In parameter descriptions, strip all whitespace between the parameter
        name (e.g., @len) and its description so that the description is
        indented uniformly in text and man page modes.  Previously, spaces
        or tabs (which are used for cleaner source code viewing) affected
        the produced output in a negative way.
      
      Before (man mode):
             to            Destination address, in user space.
             from        Source address, in kernel space.
             n              Number of bytes to copy.
      
      After (man mode):
             to          Destination address, in user space.
             from        Source address, in kernel space.
             n           Number of bytes to copy.
      
      - Fix/clarify a few function description comments.
      Signed-off-by: NRandy Dunlap <rdunlap@xenotime.net>
      Signed-off-by: NAndrew Morton <akpm@osdl.org>
      Signed-off-by: NLinus Torvalds <torvalds@osdl.org>
      27205744