diff mbox

bindings: rtc: correct wrong reference in required properties

Message ID 1486496213-11790-1-git-send-email-akinobu.mita@gmail.com
State Accepted
Headers show

Commit Message

Akinobu Mita Feb. 7, 2017, 7:36 p.m. UTC
There are currently two broken bindings descriptions for RTC:

maxim,ds3231.txt
pcf8563.txt

They broke because of a improper RST documentation conversion with
commit 8c27ceff3604b2 ("docs: fix locations of several documents that got
moved") and now reference to a non-existing file:

Documentation/devicetree/bindings/i2c/trivial-admin-guide/devices.rst

However, the original reference to i2c/trivial-devices should have never
been made in the first place.

This change fixes this issue by replacing with correct descriptions.

Reported-by: Wolfram Sang <wsa@the-dreams.de>
Cc: Alexandre Belloni <alexandre.belloni@free-electrons.com>
Cc: Heiko Schocher <hs@denx.de>
Cc: Rob Herring <robh@kernel.org>
Signed-off-by: Akinobu Mita <akinobu.mita@gmail.com>
---
 Documentation/devicetree/bindings/rtc/maxim,ds3231.txt | 3 ++-
 Documentation/devicetree/bindings/rtc/pcf8563.txt      | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)

Comments

Alexandre Belloni Feb. 11, 2017, 11:39 p.m. UTC | #1
On 08/02/2017 at 04:36:53 +0900, Akinobu Mita wrote:
> There are currently two broken bindings descriptions for RTC:
> 
> maxim,ds3231.txt
> pcf8563.txt
> 
> They broke because of a improper RST documentation conversion with
> commit 8c27ceff3604b2 ("docs: fix locations of several documents that got
> moved") and now reference to a non-existing file:
> 
> Documentation/devicetree/bindings/i2c/trivial-admin-guide/devices.rst
> 
> However, the original reference to i2c/trivial-devices should have never
> been made in the first place.
> 
> This change fixes this issue by replacing with correct descriptions.
> 
> Reported-by: Wolfram Sang <wsa@the-dreams.de>
> Cc: Alexandre Belloni <alexandre.belloni@free-electrons.com>
> Cc: Heiko Schocher <hs@denx.de>
> Cc: Rob Herring <robh@kernel.org>
> Signed-off-by: Akinobu Mita <akinobu.mita@gmail.com>
> ---
>  Documentation/devicetree/bindings/rtc/maxim,ds3231.txt | 3 ++-
>  Documentation/devicetree/bindings/rtc/pcf8563.txt      | 3 ++-
>  2 files changed, 4 insertions(+), 2 deletions(-)
> 
Applied, thanks.
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/rtc/maxim,ds3231.txt b/Documentation/devicetree/bindings/rtc/maxim,ds3231.txt
index 1ad4c1c..85be53a 100644
--- a/Documentation/devicetree/bindings/rtc/maxim,ds3231.txt
+++ b/Documentation/devicetree/bindings/rtc/maxim,ds3231.txt
@@ -1,7 +1,8 @@ 
 * Maxim DS3231 Real Time Clock
 
 Required properties:
-see: Documentation/devicetree/bindings/i2c/trivial-admin-guide/devices.rst
+- compatible: Should contain "maxim,ds3231".
+- reg: I2C address for chip.
 
 Optional property:
 - #clock-cells: Should be 1.
diff --git a/Documentation/devicetree/bindings/rtc/pcf8563.txt b/Documentation/devicetree/bindings/rtc/pcf8563.txt
index 086c998..36984ac 100644
--- a/Documentation/devicetree/bindings/rtc/pcf8563.txt
+++ b/Documentation/devicetree/bindings/rtc/pcf8563.txt
@@ -3,7 +3,8 @@ 
 Philips PCF8563/Epson RTC8564 Real Time Clock
 
 Required properties:
-see: Documentation/devicetree/bindings/i2c/trivial-admin-guide/devices.rst
+- compatible: Should contain "nxp,pcf8563".
+- reg: I2C address for chip.
 
 Optional property:
 - #clock-cells: Should be 0.