From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S965937AbdKQQxa (ORCPT ); Fri, 17 Nov 2017 11:53:30 -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 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: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@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 --- 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 -- The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project