[PATCH] Documentation: ACPI: Update links and references to DSD related docs

[PATCH] Documentation: ACPI: Update links and references to DSD related docs

[Sudeep Holla]

The existing references to DSD are stale and outdated. The new process
and guidance is maintained @https://github.com/UEFI/DSD-Guide

Update the existing documents to reflect the same.

Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
---
 .../firmware-guide/acpi/DSD-properties-rules.rst      | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/Documentation/firmware-guide/acpi/DSD-properties-rules.rst b/Documentation/firmware-guide/acpi/DSD-properties-rules.rst
index 8b2d8d0864c2..70442bc2521e 100644
--- a/Documentation/firmware-guide/acpi/DSD-properties-rules.rst
+++ b/Documentation/firmware-guide/acpi/DSD-properties-rules.rst
@@ -21,7 +21,9 @@ specific type) associated with it.
 
 In the ACPI _DSD context it is an element of the sub-package following the
 generic Device Properties UUID in the _DSD return package as specified in the
-Device Properties UUID definition document [1]_.
+section titled "Well-Known _DSD UUIDs and Data Structure Formats" sub-section
+"Device Properties UUID" in _DSD (Device Specific Data) Implementation Guide
+document [1]_.
 
 It also may be regarded as the definition of a key and the associated data type
 that can be returned by _DSD in the Device Properties UUID sub-package for a
@@ -36,7 +38,9 @@ Property subsets are nested collections of properties.  Each of them is
 associated with an additional key (name) allowing the subset to be referred
 to as a whole (and to be treated as a separate entity).  The canonical
 representation of property subsets is via the mechanism specified in the
-Hierarchical Properties Extension UUID definition document [2]_.
+section titled "Well-Known _DSD UUIDs and Data Structure Formats" sub-section
+"Hierarchical Data Extension UUID" in _DSD (Device Specific Data)
+Implementation Guide document [1]_.
 
 Property sets may be hierarchical.  That is, a property set may contain
 multiple property subsets that each may contain property subsets of its
@@ -96,5 +100,4 @@ contents.
 References
 ==========
 
-.. [1] https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf
-.. [2] https://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf
+.. [1] https://github.com/UEFI/DSD-Guide
-- 
2.36.1

Re: [PATCH] Documentation: ACPI: Update links and references to DSD related docs

[Andy Shevchenko]

On Tue, Jun 21, 2022 at 5:12 PM Sudeep Holla <sudeep.holla@arm.com> wrote:
>
> The existing references to DSD are stale and outdated. The new process
> and guidance is maintained @https://github.com/UEFI/DSD-Guide
>
> Update the existing documents to reflect the same.

Hmm... On one hand I like the change, on the other the mentioned
repository doesn't look like it is officially supported by ASWG (or
did I misread something?). If I'm not mistaken, then I would rather
see both mentioned. Otherwise it looks good, thanks!

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH] Documentation: ACPI: Update links and references to DSD related docs

[Rafael J. Wysocki]

On Wed, Jun 22, 2022 at 12:42 PM Andy Shevchenko
<andy.shevchenko@gmail.com> wrote:
>
> On Tue, Jun 21, 2022 at 5:12 PM Sudeep Holla <sudeep.holla@arm.com> wrote:
> >
> > The existing references to DSD are stale and outdated. The new process
> > and guidance is maintained @https://github.com/UEFI/DSD-Guide
> >
> > Update the existing documents to reflect the same.
>
> Hmm... On one hand I like the change, on the other the mentioned
> repository doesn't look like it is officially supported by ASWG (or
> did I misread something?). If I'm not mistaken, then I would rather
> see both mentioned. Otherwise it looks good, thanks!

The new project officially replaces the "legacy" documentation hosted
on the UEFI Forum web site.

Re: [PATCH] Documentation: ACPI: Update links and references to DSD related docs

[Andy Shevchenko]

On Tue, Jun 21, 2022 at 5:12 PM Sudeep Holla <sudeep.holla@arm.com> wrote:
>
> The existing references to DSD are stale and outdated. The new process
> and guidance is maintained @https://github.com/UEFI/DSD-Guide
>
> Update the existing documents to reflect the same.

Taking Rafael's comment into account,
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Thanks!

> Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
> ---
>  .../firmware-guide/acpi/DSD-properties-rules.rst      | 11 +++++++----
>  1 file changed, 7 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/firmware-guide/acpi/DSD-properties-rules.rst b/Documentation/firmware-guide/acpi/DSD-properties-rules.rst
> index 8b2d8d0864c2..70442bc2521e 100644
> --- a/Documentation/firmware-guide/acpi/DSD-properties-rules.rst
> +++ b/Documentation/firmware-guide/acpi/DSD-properties-rules.rst
> @@ -21,7 +21,9 @@ specific type) associated with it.
>
>  In the ACPI _DSD context it is an element of the sub-package following the
>  generic Device Properties UUID in the _DSD return package as specified in the
> -Device Properties UUID definition document [1]_.
> +section titled "Well-Known _DSD UUIDs and Data Structure Formats" sub-section
> +"Device Properties UUID" in _DSD (Device Specific Data) Implementation Guide
> +document [1]_.
>
>  It also may be regarded as the definition of a key and the associated data type
>  that can be returned by _DSD in the Device Properties UUID sub-package for a
> @@ -36,7 +38,9 @@ Property subsets are nested collections of properties.  Each of them is
>  associated with an additional key (name) allowing the subset to be referred
>  to as a whole (and to be treated as a separate entity).  The canonical
>  representation of property subsets is via the mechanism specified in the
> -Hierarchical Properties Extension UUID definition document [2]_.
> +section titled "Well-Known _DSD UUIDs and Data Structure Formats" sub-section
> +"Hierarchical Data Extension UUID" in _DSD (Device Specific Data)
> +Implementation Guide document [1]_.
>
>  Property sets may be hierarchical.  That is, a property set may contain
>  multiple property subsets that each may contain property subsets of its
> @@ -96,5 +100,4 @@ contents.
>  References
>  ==========
>
> -.. [1] https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf
> -.. [2] https://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf
> +.. [1] https://github.com/UEFI/DSD-Guide
> --
> 2.36.1
>


-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH] Documentation: ACPI: Update links and references to DSD related docs

[Sudeep Holla]

On Wed, Jun 22, 2022 at 12:41:58PM +0200, Andy Shevchenko wrote:
> On Tue, Jun 21, 2022 at 5:12 PM Sudeep Holla <sudeep.holla@arm.com> wrote:
> >
> > The existing references to DSD are stale and outdated. The new process
> > and guidance is maintained @https://github.com/UEFI/DSD-Guide
> >
> > Update the existing documents to reflect the same.
> 
> Hmm... On one hand I like the change, on the other the mentioned
> repository doesn't look like it is officially supported by ASWG (or
> did I misread something?). If I'm not mistaken, then I would rather
> see both mentioned. Otherwise it looks good, thanks!
> 

Sorry I must have mentioned that, I know and also I am told there was a request
made to ASWG to remove the outdated links. Hopefully it will be removed soon.

-- 
Regards,
Sudeep

Re: [PATCH] Documentation: ACPI: Update links and references to DSD related docs

[Rafael J. Wysocki]

On Wed, Jun 22, 2022 at 1:31 PM Andy Shevchenko
<andy.shevchenko@gmail.com> wrote:
>
> On Tue, Jun 21, 2022 at 5:12 PM Sudeep Holla <sudeep.holla@arm.com> wrote:
> >
> > The existing references to DSD are stale and outdated. The new process
> > and guidance is maintained @https://github.com/UEFI/DSD-Guide
> >
> > Update the existing documents to reflect the same.
>
> Taking Rafael's comment into account,
> Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
> Thanks!
>
> > Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
> > ---
> >  .../firmware-guide/acpi/DSD-properties-rules.rst      | 11 +++++++----
> >  1 file changed, 7 insertions(+), 4 deletions(-)
> >
> > diff --git a/Documentation/firmware-guide/acpi/DSD-properties-rules.rst b/Documentation/firmware-guide/acpi/DSD-properties-rules.rst
> > index 8b2d8d0864c2..70442bc2521e 100644
> > --- a/Documentation/firmware-guide/acpi/DSD-properties-rules.rst
> > +++ b/Documentation/firmware-guide/acpi/DSD-properties-rules.rst
> > @@ -21,7 +21,9 @@ specific type) associated with it.
> >
> >  In the ACPI _DSD context it is an element of the sub-package following the
> >  generic Device Properties UUID in the _DSD return package as specified in the
> > -Device Properties UUID definition document [1]_.
> > +section titled "Well-Known _DSD UUIDs and Data Structure Formats" sub-section
> > +"Device Properties UUID" in _DSD (Device Specific Data) Implementation Guide
> > +document [1]_.
> >
> >  It also may be regarded as the definition of a key and the associated data type
> >  that can be returned by _DSD in the Device Properties UUID sub-package for a
> > @@ -36,7 +38,9 @@ Property subsets are nested collections of properties.  Each of them is
> >  associated with an additional key (name) allowing the subset to be referred
> >  to as a whole (and to be treated as a separate entity).  The canonical
> >  representation of property subsets is via the mechanism specified in the
> > -Hierarchical Properties Extension UUID definition document [2]_.
> > +section titled "Well-Known _DSD UUIDs and Data Structure Formats" sub-section
> > +"Hierarchical Data Extension UUID" in _DSD (Device Specific Data)
> > +Implementation Guide document [1]_.
> >
> >  Property sets may be hierarchical.  That is, a property set may contain
> >  multiple property subsets that each may contain property subsets of its
> > @@ -96,5 +100,4 @@ contents.
> >  References
> >  ==========
> >
> > -.. [1] https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf
> > -.. [2] https://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf
> > +.. [1] https://github.com/UEFI/DSD-Guide
> > --

Applied as 5.20 material, thanks!