From patchwork Tue Nov 23 05:09:28 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 12633439 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 238EBC433EF for ; Tue, 23 Nov 2021 05:09:34 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 6FC566E106; Tue, 23 Nov 2021 05:09:31 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:e::133]) by gabe.freedesktop.org (Postfix) with ESMTPS id 8A61F6E0EE; Tue, 23 Nov 2021 05:09:30 +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: Content-Type:MIME-Version:Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To: Content-ID:Content-Description:In-Reply-To:References; bh=XcTY0WjwUY8rhTXzrXCh5eTVe9RMeOMTY8mUb3Id2RY=; b=tayXV/n6xHxzHRwDtBtjjgLIq8 XgrZCBGxU1Ef3RwKU6GCqxJ3YioRw0BDV2elC5+IhIkvwB/BSnVomB8OchFIDjBVLPQYdv29Y5DYH aMeLKWUU3PisYAEY4tuKkibdLEfrhjNOaZ/qby/UFVxztf77uP5AyVqgumjFsN4Ayh03xWWJLiy6/ j6O9ufUm6HzsF5i7TuDIjNOWtbWrMZ092tggOtI9HKPrPyejHHhXQ8EublTdN6WjSHxNEpKLa6jRh REnVYul1d4WAn5pbLC7C6lqXf2exKuXY+eNFz3uYp4IthTQAyk5P5vrzL0py7YM3v/yZF57iNtgNn qx7M73lg==; Received: from [2601:1c0:6280:3f0::aa0b] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1mpO3d-000orn-6h; Tue, 23 Nov 2021 05:09:29 +0000 From: Randy Dunlap To: dri-devel@lists.freedesktop.org Subject: [PATCH] drm/i915/gem: placate scripts/kernel-doc Date: Mon, 22 Nov 2021 21:09:28 -0800 Message-Id: <20211123050928.20434-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.31.1 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: =?utf-8?q?Thomas_Hellstr=C3=B6m?= , Randy Dunlap , kernel test robot , Tvrtko Ursulin , intel-gfx@lists.freedesktop.org, Matthew Auld , Rodrigo Vivi Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" Correct kernel-doc warnings in i915_drm_object.c: i915_gem_object.c:103: warning: expecting prototype for i915_gem_object_fini(). Prototype was for __i915_gem_object_fini() instead i915_gem_object.c:110: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Mark up the object's coherency levels for a given cache_level i915_gem_object.c:110: warning: missing initial short description on line: * Mark up the object's coherency levels for a given cache_level i915_gem_object.c:457: warning: No description found for return value of 'i915_gem_object_read_from_page' Signed-off-by: Randy Dunlap Reported-by: kernel test robot Cc: Thomas Hellström Cc: Matthew Auld Cc: Jani Nikula Cc: Joonas Lahtinen Cc: Rodrigo Vivi Cc: Tvrtko Ursulin Cc: intel-gfx@lists.freedesktop.org Reviewed-by: Matthew Auld --- drivers/gpu/drm/i915/gem/i915_gem_object.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) --- linux-next-20211118.orig/drivers/gpu/drm/i915/gem/i915_gem_object.c +++ linux-next-20211118/drivers/gpu/drm/i915/gem/i915_gem_object.c @@ -91,7 +91,7 @@ void i915_gem_object_init(struct drm_i91 } /** - * i915_gem_object_fini - Clean up a GEM object initialization + * __i915_gem_object_fini - Clean up a GEM object initialization * @obj: The gem object to cleanup * * This function cleans up gem object fields that are set up by @@ -107,7 +107,8 @@ void __i915_gem_object_fini(struct drm_i } /** - * Mark up the object's coherency levels for a given cache_level + * i915_gem_object_set_cache_coherency - Mark up the object's coherency levels + * for a given cache_level * @obj: #drm_i915_gem_object * @cache_level: cache level */ @@ -450,7 +451,7 @@ i915_gem_object_read_from_page_iomap(str * from can't cross a page boundary. The caller must ensure that @obj pages * are pinned and that @obj is synced wrt. any related writes. * - * Returns 0 on success or -ENODEV if the type of @obj's backing store is + * Return: %0 on success or -ENODEV if the type of @obj's backing store is * unsupported. */ int i915_gem_object_read_from_page(struct drm_i915_gem_object *obj, u64 offset, void *dst, int size)