Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Subject: Re: [PATCH v2] of: property: Fix documentation for out values
To:     Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>,
        mazziesaccount@gmail.com
Cc:     Rob Herring <robh+dt@kernel.org>, devicetree@vger.kernel.org,
        linux-kernel@vger.kernel.org
References: <20191113064338.GA13274@localhost.localdomain>
From:   Frank Rowand <frowand.list@gmail.com>
Message-ID: <ab2a2217-fb9f-f41b-689a-8478b8895ec6@gmail.com>
Date:   Wed, 13 Nov 2019 16:24:34 -0600
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101
 Thunderbird/60.9.0
MIME-Version: 1.0
In-Reply-To: <20191113064338.GA13274@localhost.localdomain>
Content-Type: text/plain; charset=utf-8
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On 11/13/19 12:43 AM, Matti Vaittinen wrote:
> Property fetching functions which return number of successfully fetched
> properties should not state that out-values are only modified if 0 is
> returned. Fix this. Also, "pointer to return value" is slightly suboptimal
> phrase as "return value" commonly refers to value function returns (not via
> arguments). Rather use "pointer to found values".
> 
> Signed-off-by: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
> ---
> 
> Changes from v1. Removed statement about modifying arg ptr only upon
> successful execution (as requested by Frank). Also changed "pointer to
> return value" with "pointer to found values"
> 
>  drivers/of/property.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/of/property.c b/drivers/of/property.c
> index d7fa75e31f22..c1dd22ed03f3 100644
> --- a/drivers/of/property.c
> +++ b/drivers/of/property.c
> @@ -164,7 +164,7 @@ EXPORT_SYMBOL_GPL(of_property_read_u64_index);
>   *
>   * @np:		device node from which the property value is to be read.
>   * @propname:	name of the property to be searched.
> - * @out_values:	pointer to return value, modified only if return value is 0.
> + * @out_values:	pointer to found values.
>   * @sz_min:	minimum number of array elements to read
>   * @sz_max:	maximum number of array elements to read, if zero there is no
>   *		upper limit on the number of elements in the dts entry but only
> @@ -212,7 +212,7 @@ EXPORT_SYMBOL_GPL(of_property_read_variable_u8_array);
>   *
>   * @np:		device node from which the property value is to be read.
>   * @propname:	name of the property to be searched.
> - * @out_values:	pointer to return value, modified only if return value is 0.
> + * @out_values:	pointer to found values.
>   * @sz_min:	minimum number of array elements to read
>   * @sz_max:	maximum number of array elements to read, if zero there is no
>   *		upper limit on the number of elements in the dts entry but only
> @@ -260,7 +260,7 @@ EXPORT_SYMBOL_GPL(of_property_read_variable_u16_array);
>   *
>   * @np:		device node from which the property value is to be read.
>   * @propname:	name of the property to be searched.
> - * @out_values:	pointer to return value, modified only if return value is 0.
> + * @out_values:	pointer to return found values.
>   * @sz_min:	minimum number of array elements to read
>   * @sz_max:	maximum number of array elements to read, if zero there is no
>   *		upper limit on the number of elements in the dts entry but only
> @@ -334,7 +334,7 @@ EXPORT_SYMBOL_GPL(of_property_read_u64);
>   *
>   * @np:		device node from which the property value is to be read.
>   * @propname:	name of the property to be searched.
> - * @out_values:	pointer to return value, modified only if return value is 0.
> + * @out_values:	pointer to found values.
>   * @sz_min:	minimum number of array elements to read
>   * @sz_max:	maximum number of array elements to read, if zero there is no
>   *		upper limit on the number of elements in the dts entry but only
> 
> base-commit: 31f4f5b495a62c9a8b15b1c3581acd5efeb9af8c
> 

Reviewed-by: Frank Rowand <frowand.list@gmail.com>