From patchwork Tue Apr 27 03:13:42 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 12225263 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=-18.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham 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 92175C433ED for ; Tue, 27 Apr 2021 03:13:56 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 64FBD61164 for ; Tue, 27 Apr 2021 03:13:56 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231450AbhD0DOi (ORCPT ); Mon, 26 Apr 2021 23:14:38 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46750 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231363AbhD0DOh (ORCPT ); Mon, 26 Apr 2021 23:14:37 -0400 Received: from casper.infradead.org (casper.infradead.org [IPv6:2001:8b0:10b:1236::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 44B52C061574; Mon, 26 Apr 2021 20:13:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; 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=CgpK97dwQ7jxO/6Xiazk1B15iaHiHK4/6xEOZQpL8nc=; b=esSVxOBZiXjZRu/R53mWWIlSVr qTS4lxp3siZv6iEuYOLEAvQKD3PFP7ycbteCBLz7722M7K2ljd8WFZrPE/4q+xKwbfsWLUaju91Dl CxLfS0yvfW4nK1zOWgcbKwyiFOWG1Z0kWpbUrk60dh1hFoG7YZ2nDopoHwhkvYioK6f6rU22kme7d 5xixmRVko7OY6QqUIhhgP5tv5b5QE+t2q+RkBIlIi6zdjpu14XQxqhLwvqhHDExSNvbeg7MzehRrL ZEeNe0oD9qZApHO/w7/zruuHpyHJOXOEUGOaud4gyW2/YeUiZ6Y4LpwUKLVoQpFHBBySLerbda9Ne zN59SHGg==; Received: from [2601:1c0:6280:3f0::df68] (helo=casper.infradead.org) by casper.infradead.org with esmtpsa (Exim 4.94 #2 (Red Hat Linux)) id 1lbEAV-006PF2-A5; Tue, 27 Apr 2021 03:13:50 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Russell King , linux-clk@vger.kernel.org Subject: [PATCH] clk: : correct clk_get_parent() documentation Date: Mon, 26 Apr 2021 20:13:42 -0700 Message-Id: <20210427031342.5333-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-clk@vger.kernel.org Make the kernel-doc return value agree with both the stub implementation in and the non-stub function in drivers/clk/clk.c. Signed-off-by: Randy Dunlap Cc: Russell King Cc: linux-clk@vger.kernel.org --- There are several drivers that call clk_get_parent() and use its return value as though it returns an ERR_PTR(). I am working on a patch series to fix those. include/linux/clk.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) --- linux-next-20210426.orig/include/linux/clk.h +++ linux-next-20210426/include/linux/clk.h @@ -744,8 +744,8 @@ int clk_set_parent(struct clk *clk, stru * clk_get_parent - get the parent clock source for this clock * @clk: clock source * - * Returns struct clk corresponding to parent clock source, or - * valid IS_ERR() condition containing errno. + * Return: &struct clk corresponding to parent clock source, or + * %NULL if clk is %NULL. */ struct clk *clk_get_parent(struct clk *clk);