From patchwork Tue Oct 15 15:54:33 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Rob Herring \(Arm\)" X-Patchwork-Id: 176381 Delivered-To: patch@linaro.org Received: by 2002:a92:7e96:0:0:0:0:0 with SMTP id q22csp6096703ill; Tue, 15 Oct 2019 08:54:39 -0700 (PDT) X-Google-Smtp-Source: APXvYqxuzVmK2cI6f6oWmRxF/47f7cxWi7Xhuc0k2We4hoytZA69RoUQ1ErZT0untOMFgl8bWXu7 X-Received: by 2002:a17:906:5051:: with SMTP id e17mr370095ejk.139.1571154879539; Tue, 15 Oct 2019 08:54:39 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1571154879; cv=none; d=google.com; s=arc-20160816; b=zlT78AsjYgo1NIlNiqAICHg5YEOe3dnOeBF5lwhARATP9zg9VzOsJTboTSPEi+SArw 2WebrpFfaeemla4hf/f/hwtFcGYOQW94H0KNFsy8uKnfIeSrsE4gxsJwPllpKqX1CJ4w XuRN1jIOaDzUJv91HcApVPvQwlcaV9QdJhNrLa8l4PfuSCEsHWUERO6IVW9xvmwBP1k0 0ibpbYBFoiqqXUgzvxj4MlDSojueQW/8PEcnhASjz/odsRqwbOaO7ur/TbMPl7nxF2/B Nnx9uW+GTO2367ipbJi3BkV+d4I8YBYhRkoH1sTbGbDROzbvcz6gUDf9OzLHCflv5Ros 2lDg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from; bh=rV9egUVAST8OIR2Vy9HXV180k6eZjVdltgXDChEOcvU=; b=DPD/rxn5GZXH25RcViX9jBRYU747E1qjom6gP2d6Qc/ddZ8QOhnliOjr2eY58yli8z ZDqOo0jJe1WnpI5D3/sUftuSO/6ZQkC+FOhbZn2sPpLAFk4XS7/FGWKTLtQMkwfJ5Kf7 VWxenddC+i4Vv19jEVhQTGFhFnJDfuxqt2v5JQjT6KH6R9Nolia9fnDnuiW57npVnjMq 5BWfi5mnQZWWg1g/JSHI6OrR7CDupIEPP0hP2qGvyNguQQKFNBweMY6aItP4NSsVxMwS CC/ULtA6R0/SiFSwsy8I/BLq0a3pcPftxxHcrl0ch7SLE4adFnP2RFwbBbLi0YbI0aYJ SPIw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id pj21si13742451ejb.64.2019.10.15.08.54.39; Tue, 15 Oct 2019 08:54:39 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2387793AbfJOPyh (ORCPT + 22 others); Tue, 15 Oct 2019 11:54:37 -0400 Received: from mail-ot1-f68.google.com ([209.85.210.68]:43468 "EHLO mail-ot1-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1731631AbfJOPyg (ORCPT ); Tue, 15 Oct 2019 11:54:36 -0400 Received: by mail-ot1-f68.google.com with SMTP id o44so17347854ota.10; Tue, 15 Oct 2019 08:54:36 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=rV9egUVAST8OIR2Vy9HXV180k6eZjVdltgXDChEOcvU=; b=cPQ+OZD3dhkI/H/TMcl72kMh08oJgrGV0No0fhVEFXQifG6axCFu06NCDMXEf63bLQ LFaPZMPOipaYlSVQ2a9yII+zczCW1OHJk3NeiFoQdUachjXN9kHP1EF8A4ZWXCTaP9Wn RWK8Ck9LYZm+deIsTK/tdBwmqUC06H57lZePbiNclpFHjkJskzEH9XuZbr2PiTJyntiS N6b1ZSWJoBQsMvzhn8/78RpZRe9KW+G5S0W7O6Ll2U3EHskrGsrSLUNspTYUWVgTTUIX A7l0Cjswfq40RhXgBu7ncAcZX7tHGAC9TURSeQKuZPtnhuI+nQlCKxlbTFX6hm5ia410 wzKw== X-Gm-Message-State: APjAAAVvUYGYQzMr4ItcQX01fxrn/MGMXOVAaeE4HXLF16C7Vo2NAoGr WPgPkhKYThzFpHJFlEzWbjlFCyE= X-Received: by 2002:a9d:3e4e:: with SMTP id h14mr30809861otg.198.1571154875408; Tue, 15 Oct 2019 08:54:35 -0700 (PDT) Received: from xps15.herring.priv (24-155-109-49.dyn.grandenetworks.net. [24.155.109.49]) by smtp.googlemail.com with ESMTPSA id y137sm6633719oie.53.2019.10.15.08.54.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Oct 2019 08:54:34 -0700 (PDT) From: Rob Herring To: devicetree@vger.kernel.org Cc: linux-kernel@vger.kernel.org Subject: [PATCH 2/2] dt: submitting-patches: Document requirements for DT schema Date: Tue, 15 Oct 2019 10:54:33 -0500 Message-Id: <20191015155433.25359-2-robh@kernel.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20191015155433.25359-1-robh@kernel.org> References: <20191015155433.25359-1-robh@kernel.org> MIME-Version: 1.0 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Update the DT submitting-patches.txt with additional requirements for DT binding schemas. New binding documents should generally use the schema format and have an explicit license. Signed-off-by: Rob Herring --- .../bindings/submitting-patches.txt | 21 ++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) -- 2.20.1 diff --git a/Documentation/devicetree/bindings/submitting-patches.txt b/Documentation/devicetree/bindings/submitting-patches.txt index de0d6090c0fd..98bee6240b65 100644 --- a/Documentation/devicetree/bindings/submitting-patches.txt +++ b/Documentation/devicetree/bindings/submitting-patches.txt @@ -15,17 +15,28 @@ I. For patch submitters use "Documentation" or "doc" because that is implied. All bindings are docs. Repeating "binding" again should also be avoided. - 2) Submit the entire series to the devicetree mailinglist at + 2) DT binding files are written in DT schema format using json-schema + vocabulary and YAML file format. The DT binding files must pass validation + by running: + + make dt_binding_check + + See ../writing-schema.rst for more details about schema and tools setup. + + 3) DT binding files should be dual licensed. The preferred license tag is + (GPL-2.0-only OR BSD-2-Clause). + + 4) Submit the entire series to the devicetree mailinglist at devicetree@vger.kernel.org and Cc: the DT maintainers. Use scripts/get_maintainer.pl to identify all of the DT maintainers. - 3) The Documentation/ portion of the patch should come in the series before + 5) The Documentation/ portion of the patch should come in the series before the code implementing the binding. - 4) Any compatible strings used in a chip or board DTS file must be + 6) Any compatible strings used in a chip or board DTS file must be previously documented in the corresponding DT binding text file in Documentation/devicetree/bindings. This rule applies even if the Linux device driver does not yet match on the compatible @@ -33,7 +44,7 @@ I. For patch submitters followed as of commit bff5da4335256513497cc8c79f9a9d1665e09864 ("checkpatch: add DT compatible string documentation checks"). ] - 5) The wildcard "" may be used in compatible strings, as in + 7) The wildcard "" may be used in compatible strings, as in the following example: - compatible: Must contain '"nvidia,-pcie", @@ -42,7 +53,7 @@ I. For patch submitters As in the above example, the known values of "" should be documented if it is used. - 6) If a documented compatible string is not yet matched by the + 8) If a documented compatible string is not yet matched by the driver, the documentation should also include a compatible string that is matched by the driver (as in the "nvidia,tegra20-pcie" example above).