diff mbox series

docs: dt: remove stale property-units.txt, link to current schema

Message ID 20210512152311.7399-1-luca@lucaceresoli.net
State Accepted, archived
Headers show
Series docs: dt: remove stale property-units.txt, link to current schema | expand

Checks

Context Check Description
robh/checkpatch warning total: 0 errors, 2 warnings, 9 lines checked

Commit Message

Luca Ceresoli May 12, 2021, 3:23 p.m. UTC 
property-units.txt is not maintained anymore. New suffixes are now
supported that have not been added here.

To avoid people incorrectly think a given suffix is not in the list remove
the file entirely and point to the authoritative place where the
recommended suffixes are maintained.

Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
---
 .../devicetree/bindings/property-units.txt    | 48 -------------------
 .../devicetree/bindings/writing-bindings.rst  |  3 +-
 2 files changed, 2 insertions(+), 49 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/property-units.txt

Comments

Rob Herring May 18, 2021, 1:05 a.m. UTC | #1 
On Wed, 12 May 2021 17:23:11 +0200, Luca Ceresoli wrote:
> property-units.txt is not maintained anymore. New suffixes are now
> supported that have not been added here.
> 
> To avoid people incorrectly think a given suffix is not in the list remove
> the file entirely and point to the authoritative place where the
> recommended suffixes are maintained.
> 
> Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
> ---
>  .../devicetree/bindings/property-units.txt    | 48 -------------------
>  .../devicetree/bindings/writing-bindings.rst  |  3 +-
>  2 files changed, 2 insertions(+), 49 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/property-units.txt
> 

Applied, thanks!
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/property-units.txt b/Documentation/devicetree/bindings/property-units.txt
deleted file mode 100644
index 218f99fa311f..000000000000
--- a/Documentation/devicetree/bindings/property-units.txt
+++ /dev/null
@@ -1,48 +0,0 @@ 
-Standard Unit Suffixes for Property names
-
-Properties which have a unit of measure are recommended to have a unit
-suffix appended to the property name. The list below contains the
-recommended suffixes. Other variations exist in bindings, but should not
-be used in new bindings or added here. The inconsistency in the unit
-prefixes is due to selecting the most commonly used variants.
-
-It is also recommended to use the units listed here and not add additional
-unit prefixes.
-
-Time/Frequency
-----------------------------------------
--mhz		: megahertz
--hz		: hertz (preferred)
--sec		: second
--ms		: millisecond
--us		: microsecond
--ns		: nanosecond
--ps		: picosecond
-
-Distance
-----------------------------------------
--mm		: millimeter
-
-Electricity
-----------------------------------------
--microamp	: microampere
--microamp-hours : microampere hour
--ohms		: ohm
--micro-ohms	: microohm
--microwatt-hours: microwatt hour
--microvolt	: microvolt
--picofarads	: picofarad
--femtofarads	: femtofarad
-
-Temperature
-----------------------------------------
--celsius	: degree Celsius
--millicelsius	: millidegree Celsius
-
-Pressure
-----------------------------------------
--kpascal	: kilopascal
-
-Throughput
-----------------------------------------
--kBps		: kilobytes per second
diff --git a/Documentation/devicetree/bindings/writing-bindings.rst b/Documentation/devicetree/bindings/writing-bindings.rst
index 45ff426d0019..f7dfb98c156e 100644
--- a/Documentation/devicetree/bindings/writing-bindings.rst
+++ b/Documentation/devicetree/bindings/writing-bindings.rst
@@ -52,7 +52,8 @@  Properties
   constraints specific to the device.
 
 - DO use common property unit suffixes for properties with scientific units.
-  See property-units.txt.
+  Recommended suffixes are listed at
+  https://github.com/devicetree-org/dt-schema/blob/master/schemas/property-units.yaml
 
 - DO define properties in terms of constraints. How many entries? What are
   possible values? What is the order?