[PATCH] doc: really get rid of Documentation/ directory

[Simon Goldschmidt]

On Thu, Dec 12, 2019 at 3:38 PM Rasmus Villemoes
<rasmus.villemoes at prevas.dk> wrote:
>
> Commit 656d8da9d2 (doc: Remove duplicated documentation directory) got
> rid of most of Documentation/. But there's still an obviously useless
> .gitignore left behind.
>
> Also, there's a copy of the linux kernel's net/ethernet.txt binding
> imported from v5.0, while the existing one in doc/ is from 4.0-rc1. So
> replace the latter by the former, and making Documentation/ finally
> empty.
>
> Signed-off-by: Rasmus Villemoes <rasmus.villemoes at prevas.dk>

Reviewed-by: Simon Goldschmidt <simon.k.r.goldschmidt at gmail.com>

> ---
>  Documentation/.gitignore                      |  1 -
>  .../devicetree/bindings/net/ethernet.txt      | 66 -------------------
>  doc/device-tree-bindings/net/ethernet.txt     | 55 ++++++++++++++--
>  3 files changed, 48 insertions(+), 74 deletions(-)
>  delete mode 100644 Documentation/.gitignore
>  delete mode 100644 Documentation/devicetree/bindings/net/ethernet.txt
>
> diff --git a/Documentation/.gitignore b/Documentation/.gitignore
> deleted file mode 100644
> index 0d20b6487c..0000000000
> --- a/Documentation/.gitignore
> +++ /dev/null
> @@ -1 +0,0 @@
> -*.pyc
> diff --git a/Documentation/devicetree/bindings/net/ethernet.txt b/Documentation/devicetree/bindings/net/ethernet.txt
> deleted file mode 100644
> index cfc376bc97..0000000000
> --- a/Documentation/devicetree/bindings/net/ethernet.txt
> +++ /dev/null
> @@ -1,66 +0,0 @@
> -The following properties are common to the Ethernet controllers:
> -
> -NOTE: All 'phy*' properties documented below are Ethernet specific. For the
> -generic PHY 'phys' property, see
> -Documentation/devicetree/bindings/phy/phy-bindings.txt.
> -
> -- local-mac-address: array of 6 bytes, specifies the MAC address that was
> -  assigned to the network device;
> -- mac-address: array of 6 bytes, specifies the MAC address that was last used by
> -  the boot program; should be used in cases where the MAC address assigned to
> -  the device by the boot program is different from the "local-mac-address"
> -  property;
> -- nvmem-cells: phandle, reference to an nvmem node for the MAC address;
> -- nvmem-cell-names: string, should be "mac-address" if nvmem is to be used;
> -- max-speed: number, specifies maximum speed in Mbit/s supported by the device;
> -- max-frame-size: number, maximum transfer unit (IEEE defined MTU), rather than
> -  the maximum frame size (there's contradiction in the Devicetree
> -  Specification).
> -- phy-mode: string, operation mode of the PHY interface. This is now a de-facto
> -  standard property; supported values are:
> -  * "internal"
> -  * "mii"
> -  * "gmii"
> -  * "sgmii"
> -  * "qsgmii"
> -  * "tbi"
> -  * "rev-mii"
> -  * "rmii"
> -  * "rgmii" (RX and TX delays are added by the MAC when required)
> -  * "rgmii-id" (RGMII with internal RX and TX delays provided by the PHY, the
> -     MAC should not add the RX or TX delays in this case)
> -  * "rgmii-rxid" (RGMII with internal RX delay provided by the PHY, the MAC
> -     should not add an RX delay in this case)
> -  * "rgmii-txid" (RGMII with internal TX delay provided by the PHY, the MAC
> -     should not add an TX delay in this case)
> -  * "rtbi"
> -  * "smii"
> -  * "xgmii"
> -  * "trgmii"
> -  * "2000base-x",
> -  * "2500base-x",
> -  * "rxaui"
> -  * "xaui"
> -  * "10gbase-kr" (10GBASE-KR, XFI, SFI)
> -- phy-connection-type: the same as "phy-mode" property but described in the
> -  Devicetree Specification;
> -- phy-handle: phandle, specifies a reference to a node representing a PHY
> -  device; this property is described in the Devicetree Specification and so
> -  preferred;
> -- phy: the same as "phy-handle" property, not recommended for new bindings.
> -- phy-device: the same as "phy-handle" property, not recommended for new
> -  bindings.
> -- rx-fifo-depth: the size of the controller's receive fifo in bytes. This
> -  is used for components that can have configurable receive fifo sizes,
> -  and is useful for determining certain configuration settings such as
> -  flow control thresholds.
> -- tx-fifo-depth: the size of the controller's transmit fifo in bytes. This
> -  is used for components that can have configurable fifo sizes.
> -- managed: string, specifies the PHY management type. Supported values are:
> -  "auto", "in-band-status". "auto" is the default, it usess MDIO for
> -  management if fixed-link is not specified.
> -
> -Child nodes of the Ethernet controller are typically the individual PHY devices
> -connected via the MDIO bus (sometimes the MDIO bus controller is separate).
> -They are described in the phy.txt file in this same directory.
> -For non-MDIO PHY management see fixed-link.txt.
> diff --git a/doc/device-tree-bindings/net/ethernet.txt b/doc/device-tree-bindings/net/ethernet.txt
> index 3fc360523b..cfc376bc97 100644
> --- a/doc/device-tree-bindings/net/ethernet.txt
> +++ b/doc/device-tree-bindings/net/ethernet.txt
> @@ -1,25 +1,66 @@
>  The following properties are common to the Ethernet controllers:
>
> +NOTE: All 'phy*' properties documented below are Ethernet specific. For the
> +generic PHY 'phys' property, see
> +Documentation/devicetree/bindings/phy/phy-bindings.txt.
> +
>  - local-mac-address: array of 6 bytes, specifies the MAC address that was
>    assigned to the network device;
>  - mac-address: array of 6 bytes, specifies the MAC address that was last used by
>    the boot program; should be used in cases where the MAC address assigned to
>    the device by the boot program is different from the "local-mac-address"
>    property;
> +- nvmem-cells: phandle, reference to an nvmem node for the MAC address;
> +- nvmem-cell-names: string, should be "mac-address" if nvmem is to be used;
>  - max-speed: number, specifies maximum speed in Mbit/s supported by the device;
>  - max-frame-size: number, maximum transfer unit (IEEE defined MTU), rather than
> -  the maximum frame size (there's contradiction in ePAPR).
> -- phy-mode: string, operation mode of the PHY interface; supported values are
> -  "mii", "gmii", "sgmii", "qsgmii", "tbi", "rev-mii", "rmii", "rgmii", "rgmii-id",
> -  "rgmii-rxid", "rgmii-txid", "rtbi", "smii", "xgmii"; this is now a de-facto
> -  standard property;
> -- phy-connection-type: the same as "phy-mode" property but described in ePAPR;
> +  the maximum frame size (there's contradiction in the Devicetree
> +  Specification).
> +- phy-mode: string, operation mode of the PHY interface. This is now a de-facto
> +  standard property; supported values are:
> +  * "internal"
> +  * "mii"
> +  * "gmii"
> +  * "sgmii"
> +  * "qsgmii"
> +  * "tbi"
> +  * "rev-mii"
> +  * "rmii"
> +  * "rgmii" (RX and TX delays are added by the MAC when required)
> +  * "rgmii-id" (RGMII with internal RX and TX delays provided by the PHY, the
> +     MAC should not add the RX or TX delays in this case)
> +  * "rgmii-rxid" (RGMII with internal RX delay provided by the PHY, the MAC
> +     should not add an RX delay in this case)
> +  * "rgmii-txid" (RGMII with internal TX delay provided by the PHY, the MAC
> +     should not add an TX delay in this case)
> +  * "rtbi"
> +  * "smii"
> +  * "xgmii"
> +  * "trgmii"
> +  * "2000base-x",
> +  * "2500base-x",
> +  * "rxaui"
> +  * "xaui"
> +  * "10gbase-kr" (10GBASE-KR, XFI, SFI)
> +- phy-connection-type: the same as "phy-mode" property but described in the
> +  Devicetree Specification;
>  - phy-handle: phandle, specifies a reference to a node representing a PHY
> -  device; this property is described in ePAPR and so preferred;
> +  device; this property is described in the Devicetree Specification and so
> +  preferred;
>  - phy: the same as "phy-handle" property, not recommended for new bindings.
>  - phy-device: the same as "phy-handle" property, not recommended for new
>    bindings.
> +- rx-fifo-depth: the size of the controller's receive fifo in bytes. This
> +  is used for components that can have configurable receive fifo sizes,
> +  and is useful for determining certain configuration settings such as
> +  flow control thresholds.
> +- tx-fifo-depth: the size of the controller's transmit fifo in bytes. This
> +  is used for components that can have configurable fifo sizes.
> +- managed: string, specifies the PHY management type. Supported values are:
> +  "auto", "in-band-status". "auto" is the default, it usess MDIO for
> +  management if fixed-link is not specified.
>
>  Child nodes of the Ethernet controller are typically the individual PHY devices
>  connected via the MDIO bus (sometimes the MDIO bus controller is separate).
>  They are described in the phy.txt file in this same directory.
> +For non-MDIO PHY management see fixed-link.txt.
> --
> 2.23.0
>