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=-2.2 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=no 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 08F39C433E0 for ; Sat, 13 Jun 2020 16:43:00 +0000 (UTC) Received: from whitealder.osuosl.org (smtp1.osuosl.org [140.211.166.138]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id A945E2074D for ; Sat, 13 Jun 2020 16:42:59 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org A945E2074D Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=inria.fr Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=ksummit-discuss-bounces@lists.linuxfoundation.org Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id 2DE1087FEB; Sat, 13 Jun 2020 16:42:59 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from whitealder.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id BG3r8of5IZ7v; Sat, 13 Jun 2020 16:42:58 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [140.211.9.56]) by whitealder.osuosl.org (Postfix) with ESMTP id D9E2687FF0; Sat, 13 Jun 2020 16:42:57 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id A8133C0888; Sat, 13 Jun 2020 16:42:57 +0000 (UTC) Received: from hemlock.osuosl.org (smtp2.osuosl.org [140.211.166.133]) by lists.linuxfoundation.org (Postfix) with ESMTP id BAF28C016F for ; Sat, 13 Jun 2020 16:42:54 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by hemlock.osuosl.org (Postfix) with ESMTP id A410388AA9 for ; Sat, 13 Jun 2020 16:42:54 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from hemlock.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id dHNu1+mStboK for ; Sat, 13 Jun 2020 16:42:53 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail3-relais-sop.national.inria.fr (mail3-relais-sop.national.inria.fr [192.134.164.104]) by hemlock.osuosl.org (Postfix) with ESMTPS id C699B88A9D for ; Sat, 13 Jun 2020 16:42:52 +0000 (UTC) X-IronPort-AV: E=Sophos;i="5.73,507,1583190000"; d="scan'208";a="351506055" Received: from abo-173-121-68.mrs.modulonet.fr (HELO hadrien) ([85.68.121.173]) by mail3-relais-sop.national.inria.fr with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 13 Jun 2020 18:42:49 +0200 Date: Sat, 13 Jun 2020 18:42:49 +0200 (CEST) From: Julia Lawall X-X-Sender: jll@hadrien To: Shuah Khan In-Reply-To: Message-ID: References: <20200609145353.628a342d@lwn.net> <8f68863a-d04c-4502-f88e-2a8b0e3c7968@linuxfoundation.org> <928d6b2c9a8afb4262a0d931bce03987ef002c8f.camel@perches.com> <20200612090706.GF2051223@linux.ibm.com> User-Agent: Alpine 2.22 (DEB 394 2020-01-19) MIME-Version: 1.0 Cc: ksummit Subject: Re: [Ksummit-discuss] [TECH TOPIC] Documentation X-BeenThere: ksummit-discuss@lists.linuxfoundation.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ksummit-discuss-bounces@lists.linuxfoundation.org Sender: "Ksummit-discuss" I tried collecting information about missing or incorrectly formatted function documentation using Coccinelle. Here is an example of the output: drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr: extra names mod, f_isr, h_src_arg drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr: missing name isr_cb drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr: missing name module drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr: missing name src_arg drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr: return comment but no return value drivers/net/ethernet/freescale/fman/fman.c:2103 fman_unregister_intr: extra names mod drivers/net/ethernet/freescale/fman/fman.c:2103 fman_unregister_intr: missing name module drivers/net/ethernet/freescale/fman/fman.c:2103 fman_unregister_intr: return comment but no return value drivers/net/ethernet/freescale/fman/fman.c:2355 fman_get_revision: return comment but no return value drivers/net/ethernet/freescale/fman/fman.c:2520 fman_bind: extra names dev drivers/net/ethernet/freescale/fman/fman.c:2520 fman_bind: missing name fm_dev drivers/net/ethernet/freescale/fman/fman.c:2527 fman_has_errata_a050385: no comment for fman_has_errata_a050385 It's not illustrated here, but if it can find documentation for the same variable with the same type somewhere else in the same file, it suggests that, and it finds a mention of the function in the Documentation directory, it give the name of that file. I assumed that all EXPORT_SYMBOLs and EXPORT_SYMBOL_GPLs should be documented. Perhaps this was an overapproximation, because it seems like a lot of them are not. julia _______________________________________________ Ksummit-discuss mailing list Ksummit-discuss@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss