[V2] dt-bindings: mmc: Remove comment on wakeup-source property

Message ID 20221130101852.5408-1-cniedermaier@dh-electronics.com
State New
Headers
Series [V2] dt-bindings: mmc: Remove comment on wakeup-source property |

Commit Message

Christoph Niedermaier Nov. 30, 2022, 10:18 a.m. UTC
  The current comment on wakeup-source is a little confusing because
the word deprecated can be interpreted at first glance to mean that
wakeup-source is deprecated. Also mentioning the obsolete property
confuses more than it helps. Therefore, the comment should be removed
completely because the enable-sdio-wakeup property is not used in
any current DTs.

Signed-off-by: Christoph Niedermaier <cniedermaier@dh-electronics.com>
---
Cc: Ulf Hansson <ulf.hansson@linaro.org>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
Cc: Marek Vasut <marex@denx.de>
Cc: kernel@dh-electronics.com
Cc: linux-mmc@vger.kernel.org
Cc: devicetree@vger.kernel.org
To: linux-kernel@vger.kernel.org
---
V2: - Instead of changing the comment, remove it
---
 Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 1 -
 1 file changed, 1 deletion(-)
  

Comments

Ulf Hansson Nov. 30, 2022, 11:39 a.m. UTC | #1
On Wed, 30 Nov 2022 at 11:20, Christoph Niedermaier
<cniedermaier@dh-electronics.com> wrote:
>
> The current comment on wakeup-source is a little confusing because
> the word deprecated can be interpreted at first glance to mean that
> wakeup-source is deprecated. Also mentioning the obsolete property
> confuses more than it helps. Therefore, the comment should be removed
> completely because the enable-sdio-wakeup property is not used in
> any current DTs.
>
> Signed-off-by: Christoph Niedermaier <cniedermaier@dh-electronics.com>
> ---
> Cc: Ulf Hansson <ulf.hansson@linaro.org>
> Cc: Rob Herring <robh+dt@kernel.org>
> Cc: Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
> Cc: Marek Vasut <marex@denx.de>
> Cc: kernel@dh-electronics.com
> Cc: linux-mmc@vger.kernel.org
> Cc: devicetree@vger.kernel.org
> To: linux-kernel@vger.kernel.org
> ---
> V2: - Instead of changing the comment, remove it
> ---
>  Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 1 -
>  1 file changed, 1 deletion(-)
>
> diff --git a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> index 802e3ca8be4d..e82c00368088 100644
> --- a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> +++ b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> @@ -293,7 +293,6 @@ properties:
>      description:
>        SDIO only. Preserves card power during a suspend/resume cycle.
>
> -  # Deprecated: enable-sdio-wakeup
>    wakeup-source:
>      $ref: /schemas/types.yaml#/definitions/flag
>      description:

This looks good to me!

However, let's also drop the reference to the property from
Documentation/devicetree/bindings/power/wakeup-source.txt.

Kind regards
Uffe
  
Christoph Niedermaier Nov. 30, 2022, 11:54 a.m. UTC | #2
From: Ulf Hansson [mailto:ulf.hansson@linaro.org]
Sent: Wednesday, November 30, 2022 12:40 PM
> On Wed, 30 Nov 2022 at 11:20, Christoph Niedermaier<cniedermaier@dh-electronics.com> wrote:
>>
>> The current comment on wakeup-source is a little confusing because
>> the word deprecated can be interpreted at first glance to mean that
>> wakeup-source is deprecated. Also mentioning the obsolete property
>> confuses more than it helps. Therefore, the comment should be removed
>> completely because the enable-sdio-wakeup property is not used in
>> any current DTs.
>>
>> Signed-off-by: Christoph Niedermaier <cniedermaier@dh-electronics.com>
>> ---
>> Cc: Ulf Hansson <ulf.hansson@linaro.org>
>> Cc: Rob Herring <robh+dt@kernel.org>
>> Cc: Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
>> Cc: Marek Vasut <marex@denx.de>
>> Cc: kernel@dh-electronics.com
>> Cc: linux-mmc@vger.kernel.org
>> Cc: devicetree@vger.kernel.org
>> To: linux-kernel@vger.kernel.org
>> ---
>> V2: - Instead of changing the comment, remove it
>> ---
>>  Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 1 -
>>  1 file changed, 1 deletion(-)
>>
>> diff --git a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
>> index 802e3ca8be4d..e82c00368088 100644
>> --- a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
>> +++ b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
>> @@ -293,7 +293,6 @@ properties:
>>      description:
>>        SDIO only. Preserves card power during a suspend/resume cycle.
>>
>> -  # Deprecated: enable-sdio-wakeup
>>    wakeup-source:
>>      $ref: /schemas/types.yaml#/definitions/flag
>>      description:
> 
> This looks good to me!
> 
> However, let's also drop the reference to the property from
> Documentation/devicetree/bindings/power/wakeup-source.txt.

Should I include this in a version 3 or should I send a separate patch?

Regards
Christoph
  
Ulf Hansson Nov. 30, 2022, 11:57 a.m. UTC | #3
On Wed, 30 Nov 2022 at 12:55, Christoph Niedermaier
<cniedermaier@dh-electronics.com> wrote:
>
> From: Ulf Hansson [mailto:ulf.hansson@linaro.org]
> Sent: Wednesday, November 30, 2022 12:40 PM
> > On Wed, 30 Nov 2022 at 11:20, Christoph Niedermaier<cniedermaier@dh-electronics.com> wrote:
> >>
> >> The current comment on wakeup-source is a little confusing because
> >> the word deprecated can be interpreted at first glance to mean that
> >> wakeup-source is deprecated. Also mentioning the obsolete property
> >> confuses more than it helps. Therefore, the comment should be removed
> >> completely because the enable-sdio-wakeup property is not used in
> >> any current DTs.
> >>
> >> Signed-off-by: Christoph Niedermaier <cniedermaier@dh-electronics.com>
> >> ---
> >> Cc: Ulf Hansson <ulf.hansson@linaro.org>
> >> Cc: Rob Herring <robh+dt@kernel.org>
> >> Cc: Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
> >> Cc: Marek Vasut <marex@denx.de>
> >> Cc: kernel@dh-electronics.com
> >> Cc: linux-mmc@vger.kernel.org
> >> Cc: devicetree@vger.kernel.org
> >> To: linux-kernel@vger.kernel.org
> >> ---
> >> V2: - Instead of changing the comment, remove it
> >> ---
> >>  Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 1 -
> >>  1 file changed, 1 deletion(-)
> >>
> >> diff --git a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> >> index 802e3ca8be4d..e82c00368088 100644
> >> --- a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> >> +++ b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> >> @@ -293,7 +293,6 @@ properties:
> >>      description:
> >>        SDIO only. Preserves card power during a suspend/resume cycle.
> >>
> >> -  # Deprecated: enable-sdio-wakeup
> >>    wakeup-source:
> >>      $ref: /schemas/types.yaml#/definitions/flag
> >>      description:
> >
> > This looks good to me!
> >
> > However, let's also drop the reference to the property from
> > Documentation/devicetree/bindings/power/wakeup-source.txt.
>
> Should I include this in a version 3 or should I send a separate patch?

Please add it in v3, so we can remove the confusing things altogether.

Kind regards
Uffe
  

Patch

diff --git a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
index 802e3ca8be4d..e82c00368088 100644
--- a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
+++ b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
@@ -293,7 +293,6 @@  properties:
     description:
       SDIO only. Preserves card power during a suspend/resume cycle.
 
-  # Deprecated: enable-sdio-wakeup
   wakeup-source:
     $ref: /schemas/types.yaml#/definitions/flag
     description: