linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Javier Martinez Canillas <javier.martinez@collabora.co.uk>
To: Paul Walmsley <paul@pwsan.com>
Cc: Mark Rutland <mark.rutland@arm.com>,
	devicetree@vger.kernel.org, Pawel Moll <pawel.moll@arm.com>,
	Ian Campbell <ijc+devicetree@hellion.org.uk>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-kernel@vger.kernel.org, Rob Herring <robh+dt@kernel.org>,
	Paul Walmsley <pwalmsley@nvidia.com>,
	Kumar Gala <galak@codeaurora.org>
Subject: Re: [PATCH 01/24] Documentation: DT: document compatible string existence requirement
Date: Thu, 29 Jan 2015 17:43:29 +0100	[thread overview]
Message-ID: <54CA6331.3010909@collabora.co.uk> (raw)
In-Reply-To: <20150128234936.20644.76672.stgit@dusk.lan>

Hello Paul,

On 01/29/2015 12:49 AM, Paul Walmsley wrote:
> 
> DT maintainers require all compatible strings used in chip or board
> DTS file to be previously documented somewhere in
> Documentation/devicetree/bindings, per:
> 
> http://marc.info/?l=linux-tegra&m=142201349727836&w=2
>

I would had preferred if checkpatch.pl didn't warn about the most specific
variants of the IP blocks tbh.

Since afaiu those were only added to the compatible string as a way to make
it future proof in case there is going to be needed later. So in that sense
I thought they were not part of the DT ABI.

Now, dumping the unused specific strings in binding docs only to make
checkpatch happy, will have the effect of making those unused strings become
part of the DT ABI. Which mean that couldn't be dropped later if those are
found to not be needed since there won't be a way to know if an OS following
the DT binding will be matching those or not.

But since the decision is to warn for all strings in a compatible property
even if those are not used, I agree with you that it should be documented.

Reviewed-by: Javier Martinez Canillas <javier.martinez@collabora.co.uk>

Best regards,
Javier

  reply	other threads:[~2015-01-29 16:43 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-01-28 23:49 Documentation: DT bindings: update DT binding docs with Tegra chips Paul Walmsley
2015-01-28 23:49 ` [PATCH 08/24] Documentation: DT bindings: add more chip compatible strings for Tegra UART Paul Walmsley
2015-01-28 23:49 ` [PATCH 10/24] Documentation: DT bindings: add more chip compatible strings for Tegra I2C Paul Walmsley
2015-01-28 23:49 ` [PATCH 02/24] Documentation: DT bindings: add more chip compatible strings for Tegra PCIe Paul Walmsley
2015-01-29 14:45   ` Rob Herring
2015-01-29 15:45     ` Paul Walmsley
2015-01-29 16:44       ` Rob Herring
2015-01-29 17:08         ` Paul Walmsley
2015-01-29 17:29           ` Paul Walmsley
2015-01-29 18:34           ` Rob Herring
2015-01-29 18:49             ` Paul Walmsley
2015-01-30  3:06               ` Paul Walmsley
2015-01-30  3:07               ` Paul Walmsley
2015-01-28 23:49 ` [PATCH 07/24] Documentation: DT bindings: add more chip compatible strings for Tegra124 pinmux Paul Walmsley
2015-01-28 23:49 ` [PATCH 01/24] Documentation: DT: document compatible string existence requirement Paul Walmsley
2015-01-29 16:43   ` Javier Martinez Canillas [this message]
2015-01-29 17:06     ` Paul Walmsley
2015-01-29 18:15     ` Rob Herring
2015-01-28 23:49 ` [PATCH 11/24] Documentation: DT bindings: add more chip compatible strings for Tegra SPI Paul Walmsley
2015-01-28 23:49 ` [PATCH 09/24] Documentation: DT bindings: add more chip compatible strings for Tegra PWM Paul Walmsley
2015-01-28 23:49 ` [PATCH 04/24] Documentation: DT bindings: add more chip compatible strings for Tegra timers Paul Walmsley
2015-01-28 23:49 ` [PATCH 05/24] Documentation: DT bindings: add more chip compatible strings for Tegra AHB gizmo Paul Walmsley
2015-01-28 23:49 ` [PATCH 06/24] Documentation: DT bindings: add more chip compatible strings for Tegra APB_MISC Paul Walmsley
2015-01-28 23:49 ` [PATCH 03/24] Documentation: DT bindings: add more chip compatible strings for Tegra SOR Paul Walmsley
2015-01-28 23:49 ` [PATCH 17/24] Documentation: DT bindings: add more chip compatible strings for Tegra XUSB pad control Paul Walmsley
2015-01-28 23:49 ` [PATCH 14/24] Documentation: DT bindings: add more chip compatible strings for Tegra eFuse Paul Walmsley
2015-01-28 23:49 ` [PATCH 18/24] Documentation: DT bindings: add more chip compatible strings for Tegra SDHCI Paul Walmsley
2015-01-28 23:49 ` [PATCH 13/24] Documentation: DT bindings: add more chip compatible strings for Tegra PMC Paul Walmsley
2015-01-28 23:49 ` [PATCH 21/24] Documentation: DT bindings: add more chip compatible strings for Tegra I2S Paul Walmsley
2015-01-28 23:49 ` [PATCH 22/24] Documentation: DT bindings: add more chip compatible strings for Tegra EHCI Paul Walmsley
2015-01-28 23:49 ` [PATCH 23/24] Documentation: DT bindings: add more chip compatible strings for Tegra USB PHY Paul Walmsley
2015-01-28 23:49 ` [PATCH 12/24] Documentation: DT bindings: add more chip compatible strings for Tegra RTC Paul Walmsley
2015-01-28 23:49 ` [PATCH 20/24] Documentation: DT bindings: add more chip compatible strings for Tegra AHUB Paul Walmsley
2015-01-28 23:49 ` [PATCH 15/24] Documentation: DT bindings: add more chip compatible strings for Tegra AHCI Paul Walmsley
2015-01-28 23:49 ` [PATCH 16/24] Documentation: DT bindings: add more chip compatible strings for Tegra HDA Paul Walmsley
2015-01-28 23:49 ` [PATCH 19/24] Documentation: DT bindings: add more chip compatible strings for Tegra SOC_THERM Paul Walmsley
2015-01-28 23:49 ` [PATCH 24/24] Documentation: DT bindings: add nvidia, denver compatible string Paul Walmsley
2015-01-29 14:36   ` Rob Herring
2015-01-30 19:33     ` Paul Walmsley

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=54CA6331.3010909@collabora.co.uk \
    --to=javier.martinez@collabora.co.uk \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=galak@codeaurora.org \
    --cc=ijc+devicetree@hellion.org.uk \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=paul@pwsan.com \
    --cc=pawel.moll@arm.com \
    --cc=pwalmsley@nvidia.com \
    --cc=robh+dt@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).