dt-bindings: phy: qcom-qmp: Cleanup the 'reg' documentation as per review
authorDouglas Anderson <dianders@chromium.org>
Tue, 7 Aug 2018 05:14:12 +0000 (22:14 -0700)
committerKishon Vijay Abraham I <kishon@ti.com>
Mon, 10 Sep 2018 08:54:34 +0000 (14:24 +0530)
commit2f2ce8fe3c0f2f45f6c273a3b7854a72e279005c
treef19579a1771a4f6fcbe0f2fde265b5cf085b3128
parent5b394b2ddf0347bef56e50c69a58773c94343ff3
dt-bindings: phy: qcom-qmp: Cleanup the 'reg' documentation as per review

After the commit 8b1087fa3a27 ("phy: qcom-qmp: Fix dts bindings to
reflect reality") landed there was some review feedback that 'reg'
should have been documented differently.  Fix it as per review
feedback.

As per that feedback:
- Subject should have been 'dt-bindings: phy:' which this patch now
  has.
- We should leave no ambiguity in the ordering of 'reg' ranges even if
  'reg-names' are also specified.
- Normally using reg-names is discouraged unless there's a strong
  reason it's needed (like if there are optional ranges).  In this
  case reg-names wasn't needed but the driver already landed relying
  on reg-names so we'll just document it and move on.

Fixes: 8b1087fa3a27 ("phy: qcom-qmp: Fix dts bindings to reflect reality")
Suggested-by: Rob Herring <robh@kernel.org>
Signed-off-by: Douglas Anderson <dianders@chromium.org>
Reviewed-by: Rob Herring <robh@kernel.org>
Signed-off-by: Kishon Vijay Abraham I <kishon@ti.com>
Documentation/devicetree/bindings/phy/qcom-qmp-phy.txt