1. 06 10月, 2012 1 次提交
    • D
      kernel-doc: bugfix - multi-line macros · 65478428
      Daniel Santos 提交于
      Prior to this patch the following code breaks:
      
      /**
       * multiline_example - this breaks kernel-doc
       */
       #define multiline_example( \
      myparam)
      
      Producing this error:
      
      Error(somefile.h:983): cannot understand prototype: 'multiline_example( \ '
      
      This patch fixes the issue by appending all lines ending in a blackslash
      (optionally followed by whitespace), removing the backslash and any
      whitespace after it prior to appending (just like the C pre-processor
      would).
      
      This fixes a break in kerel-doc introduced by the additions to rbtree.h.
      Signed-off-by: NDaniel Santos <daniel.santos@pobox.com>
      Cc: Randy Dunlap <rdunlap@xenotime.net>
      Cc: Michal Marek <mmarek@suse.cz>
      Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
      Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>
      65478428
  2. 18 8月, 2012 1 次提交
  3. 24 1月, 2012 1 次提交
  4. 31 3月, 2011 1 次提交
  5. 07 1月, 2011 1 次提交
    • R
      kernel-doc: code reorganization · 8484baaa
      Randy Dunlap 提交于
      Move 'main' code vs. subroutines around so that they are not so
      intermixed, for better readability/understanding (relative to Perl).
      It was messy to follow the primary flow of code execution with the
      code being mixed.  Now the code begins with data initialization,
      followed by all subroutines, then ends with the main code execution.
      
      This is almost totally source code movement, with a few changes as
      needed for forward declarations.
      Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
      Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>
      8484baaa
  6. 19 11月, 2010 1 次提交
    • R
      kernel-doc: escape xml for structs · 2b35f4d9
      Randy Dunlap 提交于
      scripts/kernel-doc was leaving unescaped '<', '>', and '&' in
      generated xml output for structs.  This causes xml parser errors.
      Convert these characters to "&lt;", "&gt;", and "&amp;" as needed
      to prevent errors.
      
      Most of the conversion was already done; complete it just before
      output.
      
      Documentation/DocBook/device-drivers.xml:41883: parser error : StartTag: invalid element name
      #define INPUT_KEYMAP_BY_INDEX	(1 << 0)
      Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
      Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>
      2b35f4d9
  7. 12 9月, 2010 2 次提交
  8. 11 8月, 2010 2 次提交
    • R
      mtd/nand_base: fix kernel-doc warnings & typos · b6d676db
      Randy Dunlap 提交于
      Fix mtd/nand_base.c kernel-doc warnings and typos.
      
      Warning(drivers/mtd/nand/nand_base.c:893): No description found for parameter 'mtd'
      Warning(drivers/mtd/nand/nand_base.c:893): No description found for parameter 'ofs'
      Warning(drivers/mtd/nand/nand_base.c:893): No description found for parameter 'len'
      Warning(drivers/mtd/nand/nand_base.c:893): No description found for parameter 'invert'
      Warning(drivers/mtd/nand/nand_base.c:930): No description found for parameter 'mtd'
      Warning(drivers/mtd/nand/nand_base.c:930): No description found for parameter 'ofs'
      Warning(drivers/mtd/nand/nand_base.c:930): No description found for parameter 'len'
      Warning(drivers/mtd/nand/nand_base.c:987): No description found for parameter 'mtd'
      Warning(drivers/mtd/nand/nand_base.c:987): No description found for parameter 'ofs'
      Warning(drivers/mtd/nand/nand_base.c:987): No description found for parameter 'len'
      Warning(drivers/mtd/nand/nand_base.c:2087): No description found for parameter 'len'
      Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
      Cc: David Woodhouse <dwmw2@infradead.org>
      Signed-off-by: NAndrew Morton <akpm@linux-foundation.org>
      Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>
      b6d676db
    • R
      mtd/nand_base: fix kernel-doc warnings & typos · db9ebb7c
      Randy Dunlap 提交于
      Fix mtd/nand_base.c kernel-doc warnings and typos.
      
      Warning(drivers/mtd/nand/nand_base.c:893): No description found for parameter 'mtd'
      Warning(drivers/mtd/nand/nand_base.c:893): No description found for parameter 'ofs'
      Warning(drivers/mtd/nand/nand_base.c:893): No description found for parameter 'len'
      Warning(drivers/mtd/nand/nand_base.c:893): No description found for parameter 'invert'
      Warning(drivers/mtd/nand/nand_base.c:930): No description found for parameter 'mtd'
      Warning(drivers/mtd/nand/nand_base.c:930): No description found for parameter 'ofs'
      Warning(drivers/mtd/nand/nand_base.c:930): No description found for parameter 'len'
      Warning(drivers/mtd/nand/nand_base.c:987): No description found for parameter 'mtd'
      Warning(drivers/mtd/nand/nand_base.c:987): No description found for parameter 'ofs'
      Warning(drivers/mtd/nand/nand_base.c:987): No description found for parameter 'len'
      Warning(drivers/mtd/nand/nand_base.c:2087): No description found for parameter 'len'
      Signed-off-by: NRandy Dunlap <randy.dunlap@oracle.com>
      Signed-off-by: NDavid Woodhouse <David.Woodhouse@intel.com>
      db9ebb7c
  9. 25 3月, 2010 2 次提交
  10. 13 3月, 2010 1 次提交
  11. 27 2月, 2010 2 次提交
  12. 02 12月, 2009 1 次提交
    • J
      tracing: Add DEFINE_EVENT(), DEFINE_SINGLE_EVENT() support to docbook · 3a9089fd
      Jason Baron 提交于
      The introduction of the new 'DECLARE_EVENT_CLASS()' obviates the
      need for the 'TRACE_EVENT()' macro in some cases. Thus, docbook
      style comments that used to live with 'TRACE_EVENT()' are now
      moved to 'DEFINE_EVENT()'. Thus, we need to make the docbook
      system understand the new 'DEFINE_EVENT()' macro. In addition
      I've tried to futureproof the patch, by also adding support for
      'DEFINE_SINGLE_EVENT()', since there has been discussion about
      renaming: TRACE_EVENT() -> DEFINE_SINGLE_EVENT().
      
      Without this patch the tracepoint docbook fails to build.
      
      I've verified that this patch correctly builds the tracepoint
      docbook which currently covers signals, and irqs.
      
      Changes in v2:
       - properly indent perl 'if' statements
      Signed-off-by: NJason Baron <jbaron@redhat.com>
      Acked-by: NSteven Rostedt <rostedt@goodmis.org>
      Acked-by: NRandy Dunlap <randy.dunlap@oracle.com>
      Cc: William Cohen <wcohen@redhat.com>
      Cc: Frederic Weisbecker <fweisbec@gmail.com>
      Cc: Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
      Cc: Masami Hiramatsu <mhiramat@redhat.com>
      LKML-Reference: <200912011718.nB1HIn7t011371@int-mx04.intmail.prod.int.phx2.redhat.com>
      Signed-off-by: NIngo Molnar <mingo@elte.hu>
      3a9089fd
  13. 19 9月, 2009 1 次提交
  14. 02 7月, 2009 1 次提交
  15. 20 6月, 2009 2 次提交
  16. 10 6月, 2009 1 次提交
  17. 03 5月, 2009 1 次提交
  18. 01 5月, 2009 1 次提交
  19. 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
  20. 20 12月, 2008 1 次提交
  21. 02 12月, 2008 1 次提交
  22. 27 10月, 2008 1 次提交
  23. 23 9月, 2008 1 次提交
  24. 06 8月, 2008 1 次提交
  25. 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
  26. 20 5月, 2008 1 次提交
  27. 28 4月, 2008 2 次提交
  28. 14 3月, 2008 1 次提交
  29. 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
  30. 15 2月, 2008 1 次提交
  31. 08 2月, 2008 3 次提交
  32. 29 1月, 2008 1 次提交