From patchwork Sat Jan 6 03:29:57 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13512657 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id AFBADC3DA6E for ; Sat, 6 Jan 2024 03:30:02 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 0950410E0A2; Sat, 6 Jan 2024 03:30:02 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by gabe.freedesktop.org (Postfix) with ESMTPS id 51E9310E0A2 for ; Sat, 6 Jan 2024 03:30:01 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=a/L9G46O4yhPeKVX82rAQHZm/PfK/fhGBjlWV3FYXi0=; b=TTNAvLczvr5LT3niKmQY/G7frt 4KoWmsHpP5oImO4I+wxtgQmeL+uphRn+pFdELVw8FQOJvmeqr5jSMHyGqpPR8rS8R6jLT0Y4GlV99 ihjQ9rE+m8dnfb9rX73v+c9lYuUhqYOFgUJ8+NIa++G1bHQx/WP8cAcMrMApbnalValBaMuwzWD4q 2rFBlWIoVrQw0l9RN58odnuJW/CjuzZ/85i65KpwBkAaLmH9qwDy6JOxbWJaQg74QRoux/tzbnFQW 92IIgiDnm7NpNhNeK1jvEA3YD/7v7aZNU+1XKkUlbq7wVwS6pDJ8EjOFw/mPCQ18zLUR8faZr/aEf j+/ZPaxA==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rLxNm-000fid-1A; Sat, 06 Jan 2024 03:29:58 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Subject: [PATCH v2] drm/vram-helper: fix kernel-doc warnings Date: Fri, 5 Jan 2024 19:29:57 -0800 Message-ID: <20240106032957.1195-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 MIME-Version: 1.0 X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Thomas Zimmermann , Randy Dunlap , Maxime Ripard , dri-devel@lists.freedesktop.org Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" Remove the @funcs entry from struct drm_vram_mm to quieten the kernel-doc warning. Use the "define" kernel-doc keyword and an '\' line continuation to fix another kernel-doc warning. drm_gem_vram_helper.h:129: warning: missing initial short description on line: * DRM_GEM_VRAM_PLANE_HELPER_FUNCS - drm_gem_vram_helper.h:185: warning: Excess struct member 'funcs' description in 'drm_vram_mm' Signed-off-by: Randy Dunlap Cc: David Airlie Cc: Daniel Vetter Cc: dri-devel@lists.freedesktop.org Cc: Maarten Lankhorst Cc: Maxime Ripard Cc: Thomas Zimmermann Acked-by: Daniel Vetter --- v2: Add commit description base-commit: 610a9b8f49fbcf1100716370d3b5f6f884a2835a include/drm/drm_gem_vram_helper.h | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff -- a/include/drm/drm_gem_vram_helper.h b/include/drm/drm_gem_vram_helper.h --- a/include/drm/drm_gem_vram_helper.h +++ b/include/drm/drm_gem_vram_helper.h @@ -126,7 +126,7 @@ drm_gem_vram_plane_helper_cleanup_fb(str struct drm_plane_state *old_state); /** - * DRM_GEM_VRAM_PLANE_HELPER_FUNCS - + * define DRM_GEM_VRAM_PLANE_HELPER_FUNCS - \ * Initializes struct drm_plane_helper_funcs for VRAM handling * * Drivers may use GEM BOs as VRAM helpers for the framebuffer memory. This @@ -170,7 +170,6 @@ void drm_gem_vram_simple_display_pipe_cl * @vram_base: Base address of the managed video memory * @vram_size: Size of the managed video memory in bytes * @bdev: The TTM BO device. - * @funcs: TTM BO functions * * The fields &struct drm_vram_mm.vram_base and * &struct drm_vram_mm.vrm_size are managed by VRAM MM, but are