The current comment on wakeup-source is a bit confusing, because it isn't
clear at first sight which property is actually deprecated.
Change the comment to one that is less confusing.
Signed-off-by: Christoph Niedermaier <[email protected]>
---
Cc: Ulf Hansson <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Marek Vasut <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
To: [email protected]
---
Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
index 802e3ca8be4d..a921442c6c1d 100644
--- a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
+++ b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
@@ -293,7 +293,7 @@ properties:
description:
SDIO only. Preserves card power during a suspend/resume cycle.
- # Deprecated: enable-sdio-wakeup
+ # Use wakeup-source instead of the deprecated enable-sdio-wakeup
wakeup-source:
$ref: /schemas/types.yaml#/definitions/flag
description:
--
2.11.0
On 29/11/2022 13:06, Ulf Hansson wrote:
> On Tue, 22 Nov 2022 at 12:43, Christoph Niedermaier
> <[email protected]> wrote:
>>
>> The current comment on wakeup-source is a bit confusing, because it isn't
>> clear at first sight which property is actually deprecated.
>> Change the comment to one that is less confusing.
>>
>> Signed-off-by: Christoph Niedermaier <[email protected]>
>> ---
>> Cc: Ulf Hansson <[email protected]>
>> Cc: Rob Herring <[email protected]>
>> Cc: Krzysztof Kozlowski <[email protected]>
>> Cc: Marek Vasut <[email protected]>
>> Cc: [email protected]
>> Cc: [email protected]
>> Cc: [email protected]
>> To: [email protected]
>> ---
>> Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
>> index 802e3ca8be4d..a921442c6c1d 100644
>> --- a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
>> +++ b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
>> @@ -293,7 +293,7 @@ properties:
>> description:
>> SDIO only. Preserves card power during a suspend/resume cycle.
>>
>> - # Deprecated: enable-sdio-wakeup
>> + # Use wakeup-source instead of the deprecated enable-sdio-wakeup
>> wakeup-source:
>> $ref: /schemas/types.yaml#/definitions/flag
>> description:
>
> Rob, Krzysztof - do we have a preferred pattern for how to express
> deprecated bindings - or is the above okay to you?
Yes, we have:
deprecated: true
I don't get why this is in response to LED patch? I entirely ignored
this thread because of it.
Best regards,
Krzysztof
On Tue, 22 Nov 2022 at 12:43, Christoph Niedermaier
<[email protected]> wrote:
>
> The current comment on wakeup-source is a bit confusing, because it isn't
> clear at first sight which property is actually deprecated.
> Change the comment to one that is less confusing.
>
> Signed-off-by: Christoph Niedermaier <[email protected]>
> ---
> Cc: Ulf Hansson <[email protected]>
> Cc: Rob Herring <[email protected]>
> Cc: Krzysztof Kozlowski <[email protected]>
> Cc: Marek Vasut <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: [email protected]
> To: [email protected]
> ---
> Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> index 802e3ca8be4d..a921442c6c1d 100644
> --- a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> +++ b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> @@ -293,7 +293,7 @@ properties:
> description:
> SDIO only. Preserves card power during a suspend/resume cycle.
>
> - # Deprecated: enable-sdio-wakeup
> + # Use wakeup-source instead of the deprecated enable-sdio-wakeup
> wakeup-source:
> $ref: /schemas/types.yaml#/definitions/flag
> description:
Rob, Krzysztof - do we have a preferred pattern for how to express
deprecated bindings - or is the above okay to you?
Kind regards
Uffe
On 22/11/2022 12:11, Christoph Niedermaier wrote:
> The current comment on wakeup-source is a bit confusing, because it isn't
> clear at first sight which property is actually deprecated.
> Change the comment to one that is less confusing.
It's still confusing - you mention some non-existing property. I don't
think it's worth to touch it. If you insist, drop entire comment...
>
> Signed-off-by: Christoph Niedermaier <[email protected]>
> ---
> Cc: Ulf Hansson <[email protected]>
> Cc: Rob Herring <[email protected]>
> Cc: Krzysztof Kozlowski <[email protected]>
> Cc: Marek Vasut <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: [email protected]
> To: [email protected]
> ---
> Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> index 802e3ca8be4d..a921442c6c1d 100644
> --- a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> +++ b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> @@ -293,7 +293,7 @@ properties:
> description:
> SDIO only. Preserves card power during a suspend/resume cycle.
>
> - # Deprecated: enable-sdio-wakeup
> + # Use wakeup-source instead of the deprecated enable-sdio-wakeup
> wakeup-source:
> $ref: /schemas/types.yaml#/definitions/flag
> description:
Best regards,
Krzysztof
On 11/29/22 16:30, Ulf Hansson wrote:
> On Tue, 29 Nov 2022 at 13:36, Krzysztof Kozlowski
> <[email protected]> wrote:
>>
>> On 22/11/2022 12:11, Christoph Niedermaier wrote:
>>> The current comment on wakeup-source is a bit confusing, because it isn't
>>> clear at first sight which property is actually deprecated.
>>> Change the comment to one that is less confusing.
>>
>> It's still confusing - you mention some non-existing property. I don't
>> think it's worth to touch it. If you insist, drop entire comment...
>
> Hmm, it doesn't look that easy to me. The "enable-sdio-wakeup" is
> indeed a deprecated wakeup property [1], but it seems like it's not
> really described somewhere. I wouldn't mind removing it (as it seems
> to add some confusions), but in that case it needs to be entirely
> removed from the DT docs, right?
>
> Another option, would be to add a proper description of the property
> and mark it with "deprecated: true".
There are no in-tree DTs which use the property, so maybe we should just
drop it altogether from the bindings ?
next-20221128$ git grep enable-sdio-wakeup
Documentation/devicetree/bindings/mmc/mmc-controller.yaml: #
Deprecated: enable-sdio-wakeup
Documentation/devicetree/bindings/power/wakeup-source.txt:1.
"enable-sdio-wakeup"
Documentation/devicetree/bindings/mmc/mmc.txt
drivers/mmc/core/host.c: device_property_read_bool(dev,
"enable-sdio-wakeup")) /* legacy */
drivers/mmc/host/sdhci-pltfm.c: device_property_read_bool(dev,
"enable-sdio-wakeup")) /* legacy */
On Tue, 29 Nov 2022 at 13:36, Krzysztof Kozlowski
<[email protected]> wrote:
>
> On 22/11/2022 12:11, Christoph Niedermaier wrote:
> > The current comment on wakeup-source is a bit confusing, because it isn't
> > clear at first sight which property is actually deprecated.
> > Change the comment to one that is less confusing.
>
> It's still confusing - you mention some non-existing property. I don't
> think it's worth to touch it. If you insist, drop entire comment...
Hmm, it doesn't look that easy to me. The "enable-sdio-wakeup" is
indeed a deprecated wakeup property [1], but it seems like it's not
really described somewhere. I wouldn't mind removing it (as it seems
to add some confusions), but in that case it needs to be entirely
removed from the DT docs, right?
Another option, would be to add a proper description of the property
and mark it with "deprecated: true".
>
> >
> > Signed-off-by: Christoph Niedermaier <[email protected]>
> > ---
> > Cc: Ulf Hansson <[email protected]>
> > Cc: Rob Herring <[email protected]>
> > Cc: Krzysztof Kozlowski <[email protected]>
> > Cc: Marek Vasut <[email protected]>
> > Cc: [email protected]
> > Cc: [email protected]
> > Cc: [email protected]
> > To: [email protected]
> > ---
> > Documentation/devicetree/bindings/mmc/mmc-controller.yaml | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> > index 802e3ca8be4d..a921442c6c1d 100644
> > --- a/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> > +++ b/Documentation/devicetree/bindings/mmc/mmc-controller.yaml
> > @@ -293,7 +293,7 @@ properties:
> > description:
> > SDIO only. Preserves card power during a suspend/resume cycle.
> >
> > - # Deprecated: enable-sdio-wakeup
> > + # Use wakeup-source instead of the deprecated enable-sdio-wakeup
> > wakeup-source:
> > $ref: /schemas/types.yaml#/definitions/flag
> > description:
Kind regards
Uffe
[1]
Documentation/devicetree/bindings/power/wakeup-source.txt
On 29/11/2022 16:30, Ulf Hansson wrote:
> On Tue, 29 Nov 2022 at 13:36, Krzysztof Kozlowski
> <[email protected]> wrote:
>>
>> On 22/11/2022 12:11, Christoph Niedermaier wrote:
>>> The current comment on wakeup-source is a bit confusing, because it isn't
>>> clear at first sight which property is actually deprecated.
>>> Change the comment to one that is less confusing.
>>
>> It's still confusing - you mention some non-existing property. I don't
>> think it's worth to touch it. If you insist, drop entire comment...
>
> Hmm, it doesn't look that easy to me. The "enable-sdio-wakeup" is
> indeed a deprecated wakeup property [1], but it seems like it's not
> really described somewhere. I wouldn't mind removing it (as it seems
> to add some confusions), but in that case it needs to be entirely
> removed from the DT docs, right?
Yes, from the bindings and from DTSes. It's already gone from
mmc-controller.yaml bindings, so basically we already did the most of
such removal.
>
> Another option, would be to add a proper description of the property
> and mark it with "deprecated: true".
Best regards,
Krzysztof