From patchwork Fri Jun 14 20:36:15 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Vetter X-Patchwork-Id: 10996771 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 A8DA0112C for ; Fri, 14 Jun 2019 20:39:41 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 9AD2328733 for ; Fri, 14 Jun 2019 20:39:41 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 8F34A2876B; Fri, 14 Jun 2019 20:39:41 +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=unavailable 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 3F28228733 for ; Fri, 14 Jun 2019 20:39:41 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 2D3DA898EE; Fri, 14 Jun 2019 20:37:44 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from mail-ed1-x543.google.com (mail-ed1-x543.google.com [IPv6:2a00:1450:4864:20::543]) by gabe.freedesktop.org (Postfix) with ESMTPS id 5868B892EA for ; Fri, 14 Jun 2019 20:37:32 +0000 (UTC) Received: by mail-ed1-x543.google.com with SMTP id k8so5198763edr.11 for ; Fri, 14 Jun 2019 13:37:32 -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:in-reply-to :references:mime-version:content-transfer-encoding; bh=jopVjs1ZtwLEDssKa/MvAYuS6CFFWIv9JYOhNrUAu0Y=; b=L8sQYzGXroJewUC52QYXd7OIRx+7Yrp95T1SbSt21iH1zAReL/0jSGffKq8NMlzR1M X+9ES4YXohKxjtvINykk+61chAQEunN7EP3Rv52oE2Zv7iPdM0BuhQWohCnZNgjyKiOm gfRS5grJx8Aer2CXDyOT2y5kBSUI+XXqW1QgHFiNrNX51jivsEFKB9+f77ojP10sp70/ L4fqD1dkAxdR8ds+SWgkeaD9H1Sf0wG6EVGWUtbrRvjtrcfrIZJyOkWPfmp2kEoiJnfz ElVy27tsZLVTMcOD+lf8RX3M9IZJV1tBSapb22aleL2xwagWbkw7BikK6VSYg2SZADp1 RcXw== X-Gm-Message-State: APjAAAUsMt1iXu/jmRPWBWshbTHc3aJx0rpQY2/m6vOMsa/+UEuRXPqE l+QmoJDQm5oEMLbylR7L/wdgZ3GhfOM= X-Google-Smtp-Source: APXvYqz/eHCh/fI/IDRTsxZ4di6x9GoO6XRexaYbfJeCSRxXatAlJlk/KtmZgGEvRDZgUUzZ3aSTow== X-Received: by 2002:a50:aeaf:: with SMTP id e44mr105605594edd.239.1560544649148; Fri, 14 Jun 2019 13:37:29 -0700 (PDT) Received: from phenom.ffwll.local ([2a02:168:569e:0:3106:d637:d723:e855]) by smtp.gmail.com with ESMTPSA id n15sm1166672edd.49.2019.06.14.13.37.27 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Fri, 14 Jun 2019 13:37:28 -0700 (PDT) From: Daniel Vetter To: DRI Development Subject: [PATCH 59/59] drm/doc: Document kapi doc expectations Date: Fri, 14 Jun 2019 22:36:15 +0200 Message-Id: <20190614203615.12639-60-daniel.vetter@ffwll.ch> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190614203615.12639-1-daniel.vetter@ffwll.ch> References: <20190614203615.12639-1-daniel.vetter@ffwll.ch> 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:in-reply-to:references :mime-version:content-transfer-encoding; bh=jopVjs1ZtwLEDssKa/MvAYuS6CFFWIv9JYOhNrUAu0Y=; b=f/KKoY8xcVk1JrB/RknvvEKfXm0haUxGNsIstH9sTEHK8+DFRLgGvjNb2mktWge1qt +PN25RkKplS04b6HPXEfei5X85+7smbe9jldNacb7kIO55rS6/kOYlZvRoZNGGhSveuJ +ewds0W2YprbENsuRXk09sorRQuuqw50DNcFw= 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: David Airlie , Daniel Vetter , Intel Graphics Development , Maxime Ripard , 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. 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: Jani Nikula --- 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 026e55c517e1..25878dd048fd 100644 --- a/Documentation/gpu/todo.rst +++ b/Documentation/gpu/todo.rst @@ -299,19 +299,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 ------------------------