On Thu, 18 Apr 2019, Mike Rapoport wrote: > On Thu, Apr 18, 2019 at 10:41:47AM +0200, Thomas Gleixner wrote: > > +/** > > + * arch_stack_walk - Architecture specific function to walk the stack > > + > > Nit: no '*' at line beginning makes kernel-doc unhappy Oops. > > + * @consume_entry: Callback which is invoked by the architecture code for > > + * each entry. > > + * @cookie: Caller supplied pointer which is handed back to > > + * @consume_entry > > + * @task: Pointer to a task struct, can be NULL > > + * @regs: Pointer to registers, can be NULL > > + * > > + * @task @regs: > > + * NULL NULL Stack trace from current > > + * task NULL Stack trace from task (can be current) > > + * NULL regs Stack trace starting on regs->stackpointer > > This will render as a single line with 'make *docs'. > Adding line separators makes this actually a table in the generated docs: > > * ============ ======= ============================================ > * task regs > * ============ ======= ============================================ > * NULL NULL Stack trace from current > * task NULL Stack trace from task (can be current) > * NULL regs Stack trace starting on regs->stackpointer > * ============ ======= ============================================ Cute. > > + * Returns number of entries stored. > > Can you please s/Returns/Return:/ so that kernel-doc will recognize this as > return section. > > This is relevant for other comments below as well. Sure. Thanks for the free kernel doc course! :) tglx
