[RFC] obsolete references to Documentation/devicetree/bindings/net/ethernet.txt

[RFC] obsolete references to Documentation/devicetree/bindings/net/ethernet.txt

[Madalin Bucur (OSS)]

Hi,

this patch removed the ethernet.txt content and added the information found in
it in the ethernet-controller.yaml (Documentation/devicetree/bindings/net):

  commit 9d3de3c58347623b5e71d554628a1571cd3142ad
  Author: Maxime Ripard <maxime.ripard@bootlin.com>
  Date:   Thu Jun 27 17:31:43 2019 +0200

      dt-bindings: net: Add YAML schemas for the generic Ethernet options

      The Ethernet controllers have a good number of generic options that can be
      needed in a device tree. Add a YAML schemas for those.

      Reviewed-by: Rob Herring <robh@kernel.org>
      Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>
      Reviewed-by: Andrew Lunn <andrew@lunn.ch>
      Signed-off-by: Rob Herring <robh@kernel.org>

There are still many references to the previous ethernet.txt document:

  $ grep ethernet.txt Documentation/devicetree/bindings/net/ -r | wc -l
  96

Should those be updated too or it's enough to rely on the current content
of the previous ethernet.txt file:

  $ cat Documentation/devicetree/bindings/net/ethernet.txt
  This file has moved to ethernet-controller.yaml.

Thanks,
Madalin

Re: [RFC] obsolete references to Documentation/devicetree/bindings/net/ethernet.txt

[Andrew Lunn]

On Mon, Dec 23, 2019 at 09:00:50AM +0000, Madalin Bucur (OSS) wrote:
> Hi,
> 
> this patch removed the ethernet.txt content and added the information found in
> it in the ethernet-controller.yaml (Documentation/devicetree/bindings/net):
> 
>   commit 9d3de3c58347623b5e71d554628a1571cd3142ad
>   Author: Maxime Ripard <maxime.ripard@bootlin.com>
>   Date:   Thu Jun 27 17:31:43 2019 +0200
> 
>       dt-bindings: net: Add YAML schemas for the generic Ethernet options
> 
>       The Ethernet controllers have a good number of generic options that can be
>       needed in a device tree. Add a YAML schemas for those.
> 
>       Reviewed-by: Rob Herring <robh@kernel.org>
>       Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>
>       Reviewed-by: Andrew Lunn <andrew@lunn.ch>
>       Signed-off-by: Rob Herring <robh@kernel.org>
> 
> There are still many references to the previous ethernet.txt document:
> 
>   $ grep ethernet.txt Documentation/devicetree/bindings/net/ -r | wc -l
>   96
> 
> Should those be updated too or it's enough to rely on the current content
> of the previous ethernet.txt file:
> 
>   $ cat Documentation/devicetree/bindings/net/ethernet.txt
>   This file has moved to ethernet-controller.yaml.

Hi Madalin

Feel free to fix the references if you want. Probably a perl one liner
should do most of the work.

       Thanks
	Andrew

Re: [RFC] obsolete references to Documentation/devicetree/bindings/net/ethernet.txt

[Rob Herring]

On Thu, Dec 26, 2019 at 12:08:21PM +0100, Andrew Lunn wrote:
> On Mon, Dec 23, 2019 at 09:00:50AM +0000, Madalin Bucur (OSS) wrote:
> > Hi,
> > 
> > this patch removed the ethernet.txt content and added the information found in
> > it in the ethernet-controller.yaml (Documentation/devicetree/bindings/net):
> > 
> >   commit 9d3de3c58347623b5e71d554628a1571cd3142ad
> >   Author: Maxime Ripard <maxime.ripard@bootlin.com>
> >   Date:   Thu Jun 27 17:31:43 2019 +0200
> > 
> >       dt-bindings: net: Add YAML schemas for the generic Ethernet options
> > 
> >       The Ethernet controllers have a good number of generic options that can be
> >       needed in a device tree. Add a YAML schemas for those.
> > 
> >       Reviewed-by: Rob Herring <robh@kernel.org>
> >       Signed-off-by: Maxime Ripard <maxime.ripard@bootlin.com>
> >       Reviewed-by: Andrew Lunn <andrew@lunn.ch>
> >       Signed-off-by: Rob Herring <robh@kernel.org>
> > 
> > There are still many references to the previous ethernet.txt document:
> > 
> >   $ grep ethernet.txt Documentation/devicetree/bindings/net/ -r | wc -l
> >   96
> > 
> > Should those be updated too or it's enough to rely on the current content
> > of the previous ethernet.txt file:
> > 
> >   $ cat Documentation/devicetree/bindings/net/ethernet.txt
> >   This file has moved to ethernet-controller.yaml.

If this wasn't enough, we wouldn't have put that there.

> 
> Hi Madalin
> 
> Feel free to fix the references if you want. Probably a perl one liner
> should do most of the work.

The above was done to avoid some churn. The real fix is convert bindings 
to DT schema. The references should get dropped as part of that.

Rob