From patchwork Tue Jun 25 20:36:44 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Vetter X-Patchwork-Id: 11016365 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 8C62B14C0 for ; Tue, 25 Jun 2019 20:36:56 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 7CDF52842D for ; Tue, 25 Jun 2019 20:36:56 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 7026128471; Tue, 25 Jun 2019 20:36:56 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.2 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 01BB52842D for ; Tue, 25 Jun 2019 20:36:55 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 830FB6E21B; Tue, 25 Jun 2019 20:36:53 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from mail-ed1-x529.google.com (mail-ed1-x529.google.com [IPv6:2a00:1450:4864:20::529]) by gabe.freedesktop.org (Postfix) with ESMTPS id EC0BE6E21B for ; Tue, 25 Jun 2019 20:36:51 +0000 (UTC) Received: by mail-ed1-x529.google.com with SMTP id k8so29096273eds.7 for ; Tue, 25 Jun 2019 13:36:51 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=pMHQ+TZrfDndG6QbjiyPnZBt+ORF/C2d3e2WSt7CNIo=; b=hYxpSxtFUhz3hW+4GYZqtbo9eu97xZPSz01DOl1AFwttbcw0q/fdR7YbexrH04bl0M 0uwu0OYYZUxqzUtnZsg3w4X9vyr6xrqWWHHPgaxyxhtgRbOQtf5UCpiHalZL2IAuV6Yl m06VIJmPfJbhAoXCZVJ235AzYzVN0buiD0iP+0DCPCyubtpsEBhrjfLKb0NWy/72xPdN WPvirOwdPAIyfeYoUnAyBzZ/JVulWWbsdVK9ERujVVuvexVmtDxuX6tqNt6EgqU9faXv m51Iq1p51KlzxNT3JuHljPgvAkmDBNGR2GNzeXipJKxAD4WZwTmEhJ5WuDWoobCpo48c ceTg== X-Gm-Message-State: APjAAAWh7k8SY7V2cdQrfXXMr3OHSPZJ3xjc0kzqAmdT5u84da0HbTf0 0/pVYn4Z9F0DZH2Gv7PMAODFqvs9aZ4= X-Google-Smtp-Source: APXvYqwgrUQ+eIIAw8p4XwzdrtlsNL1yJ9tgxVYOS6THZcB5RJfy13SvDC15ma+SVh5qy3JXVMTMUA== X-Received: by 2002:a17:906:553:: with SMTP id k19mr437879eja.73.1561495010328; Tue, 25 Jun 2019 13:36:50 -0700 (PDT) Received: from phenom.ffwll.local ([2a02:168:569e:0:3106:d637:d723:e855]) by smtp.gmail.com with ESMTPSA id m39sm3557282edm.96.2019.06.25.13.36.48 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Tue, 25 Jun 2019 13:36:49 -0700 (PDT) From: Daniel Vetter To: DRI Development Subject: [PATCH] drm/doc: Document kapi doc expectations Date: Tue, 25 Jun 2019 22:36:44 +0200 Message-Id: <20190625203644.4423-1-daniel.vetter@ffwll.ch> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 X-Mailman-Original-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ffwll.ch; s=google; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=pMHQ+TZrfDndG6QbjiyPnZBt+ORF/C2d3e2WSt7CNIo=; b=TEGKjH/FcCV5hCCZc4FaJfW6gWmhemLMo+Sm2ChRm84G6ONQnPuEfQnkN5EhkQLPUb tydh0ftblxkwJPtX90uH90T9ffxSxyG5z4tql2TNMPceo7rN27uc2hVdReglJCCSKwhy rtUgF6NJDE0Y0rAokxGkA83ArtKstDZhOZ2s4= X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Maxime Ripard , Jani Nikula , Daniel Vetter , David Airlie , Laurent Pinchart , Daniel Vetter , Sean Paul Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Virus-Scanned: ClamAV using ClamSMTP We've had this already for anything new. With my drm_prime.c cleanup I also think documentations for everything already existing is complete, and we can bake this in as a requirements subsystem wide. Acked-by: Jani Nikula Signed-off-by: Daniel Vetter Cc: Laurent Pinchart Cc: Jani Nikula Cc: David Airlie Cc: Daniel Vetter Cc: Maarten Lankhorst Cc: Maxime Ripard Cc: Sean Paul Acked-by: Sam Ravnborg Acked-by: Maxime Ripard Acked-by: Laurent Pinchart Acked-by: Emil Velikov --- resending stand-alone for more visibility and a-b gathering. -Daniel --- Documentation/gpu/introduction.rst | 13 +++++++++++++ Documentation/gpu/todo.rst | 13 ------------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/Documentation/gpu/introduction.rst b/Documentation/gpu/introduction.rst index fccbe375244d..a94ad6ad1f54 100644 --- a/Documentation/gpu/introduction.rst +++ b/Documentation/gpu/introduction.rst @@ -51,6 +51,19 @@ and "FIXME" where the interface could be cleaned up. Also read the :ref:`guidelines for the kernel documentation at large `. +Documentation Requirements for kAPI +----------------------------------- + +All kernel APIs exported to other modules must be documented, including their +datastructures and at least a short introductory section explaining the overall +concepts. Documentation should be put into the code itself as kerneldoc comments +as much as reasonable. Do not blindly document everything, but document only +what's relevant for driver authors: Internal functions of drm.ko and definitely +static functions should not have formal kerneldoc comments. Use normal C +comments if you feel like a comment is warranted. Similar for data structures, +annotate anything entirely private with ``/* private: */`` comments as per the +documentation guide. + Getting Started =============== diff --git a/Documentation/gpu/todo.rst b/Documentation/gpu/todo.rst index e717f280f9ae..db88969a56ee 100644 --- a/Documentation/gpu/todo.rst +++ b/Documentation/gpu/todo.rst @@ -301,19 +301,6 @@ In the end no .c file should need to include ``drmP.h`` anymore. Contact: Daniel Vetter -Add missing kerneldoc for exported functions --------------------------------------------- - -The DRM reference documentation is still lacking kerneldoc in a few areas. The -task would be to clean up interfaces like moving functions around between -files to better group them and improving the interfaces like dropping return -values for functions that never fail. Then write kerneldoc for all exported -functions and an overview section and integrate it all into the drm book. - -See https://dri.freedesktop.org/docs/drm/ for what's there already. - -Contact: Daniel Vetter - Make panic handling work ------------------------