From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-1.0 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BA542C10F0E for ; Thu, 18 Apr 2019 11:58:01 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 877C3217FA for ; Thu, 18 Apr 2019 11:58:01 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2388823AbfDRL5u (ORCPT ); Thu, 18 Apr 2019 07:57:50 -0400 Received: from Galois.linutronix.de ([146.0.238.70]:35758 "EHLO Galois.linutronix.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727807AbfDRL5u (ORCPT ); Thu, 18 Apr 2019 07:57:50 -0400 Received: from pd9ef12d2.dip0.t-ipconnect.de ([217.239.18.210] helo=nanos) by Galois.linutronix.de with esmtpsa (TLS1.2:DHE_RSA_AES_256_CBC_SHA256:256) (Exim 4.80) (envelope-from ) id 1hH5fQ-00069B-K5; Thu, 18 Apr 2019 13:57:24 +0200 Date: Thu, 18 Apr 2019 13:57:22 +0200 (CEST) From: Thomas Gleixner To: Mike Rapoport cc: LKML , Josh Poimboeuf , x86@kernel.org, Andy Lutomirski , Steven Rostedt , Alexander Potapenko , linux-arch@vger.kernel.org, Alexey Dobriyan , Andrew Morton , Pekka Enberg , linux-mm@kvack.org, David Rientjes , Christoph Lameter , Catalin Marinas , Dmitry Vyukov , Andrey Ryabinin , kasan-dev@googlegroups.com, Mike Rapoport , Akinobu Mita , iommu@lists.linux-foundation.org, Robin Murphy , Christoph Hellwig , Marek Szyprowski , Johannes Thumshirn , David Sterba , Chris Mason , Josef Bacik , linux-btrfs@vger.kernel.org, dm-devel@redhat.com, Mike Snitzer , Alasdair Kergon , intel-gfx@lists.freedesktop.org, Joonas Lahtinen , Maarten Lankhorst , dri-devel@lists.freedesktop.org, David Airlie , Jani Nikula , Daniel Vetter , Rodrigo Vivi Subject: Re: [patch V2 28/29] stacktrace: Provide common infrastructure In-Reply-To: <20190418115207.GB13304@rapoport-lnx> Message-ID: References: <20190418084119.056416939@linutronix.de> <20190418084255.652003111@linutronix.de> <20190418115207.GB13304@rapoport-lnx> User-Agent: Alpine 2.21 (DEB 202 2017-01-01) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII X-Linutronix-Spam-Score: -1.0 X-Linutronix-Spam-Level: - X-Linutronix-Spam-Status: No , -1.0 points, 5.0 required, ALL_TRUSTED=-1,SHORTCIRCUIT=-0.0001 Sender: linux-btrfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-btrfs@vger.kernel.org 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