From patchwork Fri Nov 17 16:53:21 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Boyd X-Patchwork-Id: 839066 Return-Path: X-Original-To: incoming-dt@patchwork.ozlabs.org Delivered-To: patchwork-incoming-dt@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=devicetree-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=codeaurora.org header.i=@codeaurora.org header.b="V2DXGPnO"; dkim=fail reason="signature verification failed" (1024-bit key) header.d=codeaurora.org header.i=@codeaurora.org header.b="V2DXGPnO"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 3ydkhQ58CSz9s7h for ; Sat, 18 Nov 2017 03:53:26 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751330AbdKQQxY (ORCPT ); Fri, 17 Nov 2017 11:53:24 -0500 Received: from smtp.codeaurora.org ([198.145.29.96]:34556 "EHLO smtp.codeaurora.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750745AbdKQQxY (ORCPT ); Fri, 17 Nov 2017 11:53:24 -0500 Received: by smtp.codeaurora.org (Postfix, from userid 1000) id 9CB8B60584; Fri, 17 Nov 2017 16:53:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=codeaurora.org; s=default; t=1510937603; bh=5HUmszJ8jCOuoU0X0+ezobB3F9SXKKNSP6mcRLo8l1k=; h=From:To:Cc:Subject:Date:From; b=V2DXGPnORZ7siAbAsr8OMgVlM+mlifhgRXa4/nMNfpVrGmy6DAO+j91Jj829IJUFt 7gFwIKu7bVobagd1q252aYHi5QbOT6+FrgWVkw63HrG26rgcrFb4ob4R4Ob7t3RxNV tPygGUHcTtzeuLQIHGBy3XAnJ23ob5mlGbTerwzc= X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on pdx-caf-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.8 required=2.0 tests=ALL_TRUSTED,BAYES_00, DKIM_SIGNED, T_DKIM_INVALID autolearn=no autolearn_force=no version=3.4.0 Received: from sboyd-linux.qualcomm.com (i-global254.qualcomm.com [199.106.103.254]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: sboyd@smtp.codeaurora.org) by smtp.codeaurora.org (Postfix) with ESMTPSA id C1C6360584; Fri, 17 Nov 2017 16:53:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=codeaurora.org; s=default; t=1510937603; bh=5HUmszJ8jCOuoU0X0+ezobB3F9SXKKNSP6mcRLo8l1k=; h=From:To:Cc:Subject:Date:From; b=V2DXGPnORZ7siAbAsr8OMgVlM+mlifhgRXa4/nMNfpVrGmy6DAO+j91Jj829IJUFt 7gFwIKu7bVobagd1q252aYHi5QbOT6+FrgWVkw63HrG26rgcrFb4ob4R4Ob7t3RxNV tPygGUHcTtzeuLQIHGBy3XAnJ23ob5mlGbTerwzc= DMARC-Filter: OpenDMARC Filter v1.3.2 smtp.codeaurora.org C1C6360584 Authentication-Results: pdx-caf-mail.web.codeaurora.org; dmarc=none (p=none dis=none) header.from=codeaurora.org Authentication-Results: pdx-caf-mail.web.codeaurora.org; spf=none smtp.mailfrom=sboyd@codeaurora.org From: Stephen Boyd To: Rob Herring , Frank Rowand Cc: linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, devicetree@vger.kernel.org, Randy Dunlap Subject: [PATCHv2] of: Document exactly what of_find_node_by_name() puts Date: Fri, 17 Nov 2017 08:53:21 -0800 Message-Id: <20171117165321.18591-1-sboyd@codeaurora.org> X-Mailer: git-send-email 2.15.0.164.g4123bcaed089 Sender: devicetree-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org It isn't clear if this function of_node_put()s the 'from' argument, or the node it searches. Clearly indicate which variable is touched. Fold in some more fixes from Randy too because we're in the area. Cc: Randy Dunlap Signed-off-by: Stephen Boyd Acked-by: Randy Dunlap --- Changes from v1: * Fold in Randy's fixes drivers/of/base.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/drivers/of/base.c b/drivers/of/base.c index 63897531cd75..4368a878df88 100644 --- a/drivers/of/base.c +++ b/drivers/of/base.c @@ -863,10 +863,10 @@ EXPORT_SYMBOL(of_find_node_opts_by_path); /** * of_find_node_by_name - Find a node by its "name" property - * @from: The node to start searching from or NULL, the node + * @from: The node to start searching from or NULL; the node * you pass will not be searched, only the next one - * will; typically, you pass what the previous call - * returned. of_node_put() will be called on it + * will. Typically, you pass what the previous call + * returned. of_node_put() will be called on @from. * @name: The name string to match against * * Returns a node pointer with refcount incremented, use