From patchwork Thu Mar 25 16:47:08 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Rob Herring \(Arm\)" X-Patchwork-Id: 408842 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp700135jai; Thu, 25 Mar 2021 09:48:28 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwQP70DhMK4cjQnFiT+HDFW57zgTJTB5LirGTvEke5j0Q7D0CDYwb9GLwJxEZUtdFFEPOr0 X-Received: by 2002:a17:906:6c4:: with SMTP id v4mr10297582ejb.198.1616690907910; Thu, 25 Mar 2021 09:48:27 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1616690907; cv=none; d=google.com; s=arc-20160816; b=D7bsmAeWEPZd8yB54CCPAgsJfSzksLfAI+8Sel+XQFtkq9xMKM+uzaM94ziqJA9cJ+ sgMlFDTO+zD3ttQvabDKC8cpR3SxVZ7Aba8l9IumWBRgp52+u8gsFnGAbJMvgMwEE0Wv 6OHWY2OMQOwda1/kqxxu8MEk4S7WRO2OI04H5nrIA5/wqlpqn9GsntshTD9sGq7grwIx /BeW4RHGbT/g7jSQjNUbGTKeOtbYQJzlzV4OHUD/HadRytFwhMcKuiA8mEmbRO+h0EpO /k/IdBnz5/Bq2mDC8T0C8Ed5bXp5flAvmDVKaV+dAbUv9h9BLAMwi1PTYuet8AGpOwEo bbnw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from; bh=WsN7Xqa0H0sw8FyvyboT6y25R/zqs9xa7Bq93vO2pFM=; b=eDxkdc4m29FjqsOpLBQGipYwYDj7oRpPFJKLRAc5AJhtOLbUvRIExUl65TS7SdQ7hL 1QrM413qJydYP1Lao3TkzNrE5F4ObVpr8Xn6qQpHGUoXwTZx8NSSLKo6G+yi6Tjd24/5 97qvSm+Sy8ilgeVf04nJzH4TlejZFKT3tBGyOh8l9oSysAFfE/UWM140Vjk2K4B7wsbm 71RTSvuJ0rDo2rnHish+ByVEm/7jR3VcXXK5V9fkdWVsPaG1G3KwMRXFb0CjWaqmL59W qI34Gmb5SH0jQnhaQXud/mPXEs5bOYMg6yJBVUznMbJAgno01aVqVmxc5cs/OkT3sgOd ULyA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of devicetree-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=devicetree-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id f7si4498477edu.503.2021.03.25.09.48.27; Thu, 25 Mar 2021 09:48:27 -0700 (PDT) Received-SPF: pass (google.com: domain of devicetree-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; spf=pass (google.com: domain of devicetree-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=devicetree-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229946AbhCYQrx (ORCPT + 6 others); Thu, 25 Mar 2021 12:47:53 -0400 Received: from mail-il1-f182.google.com ([209.85.166.182]:33466 "EHLO mail-il1-f182.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229812AbhCYQrc (ORCPT ); Thu, 25 Mar 2021 12:47:32 -0400 Received: by mail-il1-f182.google.com with SMTP id u10so2733854ilb.0; Thu, 25 Mar 2021 09:47:32 -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=WsN7Xqa0H0sw8FyvyboT6y25R/zqs9xa7Bq93vO2pFM=; b=m0vchpT8M6/4ID1oOxKCSRruHlMfar9Y2E7b1sE7HUoO5B+7MnfeTjRoFpzn0rfS56 4z8wG4pa3YJaXm3jKzKyTeBH6hUWQYv7jvVNS0xrtSBkCjz3u6Am9GSG02fxbpc6OivD xCWM4YGJglV+cRyizqNxr5gCMSH0CFCcKUwRVqLZF0jv6Kz+9BUIptfnweN+aRZLCA71 KdGJhesIrQYSc6qIR5AoVs2PMuDSsw+nteMe2Z/Wj+3SLxzUt5yMpn8FfrYLoeJHLUL9 VwZxlbY3FIP5jN8Hi8xgsmOEHxYrQgXQt9SkPW0f+et0rQT6oqvfgJxB/0kBKvpM7HHF 5ERg== X-Gm-Message-State: AOAM532+7rr0ptHqDcKbJMIE/plpabPsCrnkRoE3LPnuzU7MGNuI+7Bm e2AGThXK8NNAIGJPJrqZa+yAAcsM4w== X-Received: by 2002:a92:b703:: with SMTP id k3mr7597536ili.185.1616690851216; Thu, 25 Mar 2021 09:47:31 -0700 (PDT) Received: from xps15.herring.priv ([64.188.179.253]) by smtp.googlemail.com with ESMTPSA id h13sm2868615ila.82.2021.03.25.09.47.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 25 Mar 2021 09:47:29 -0700 (PDT) From: Rob Herring To: devicetree@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Frank Rowand , Lee Jones , Mauro Carvalho Chehab , Jonathan Corbet , linux-doc@vger.kernel.org Subject: [PATCH 3/8] docs: dt: writing-schema: Include the example schema in the doc build Date: Thu, 25 Mar 2021 10:47:08 -0600 Message-Id: <20210325164713.1296407-4-robh@kernel.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20210325164713.1296407-1-robh@kernel.org> References: <20210325164713.1296407-1-robh@kernel.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org The example-schema.yaml file serves as documentation, so let's include it from writing-schema.rst. Cc: Frank Rowand Cc: Mauro Carvalho Chehab Signed-off-by: Rob Herring --- Documentation/devicetree/writing-schema.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) -- 2.27.0 Reviewed-by: Mauro Carvalho Chehab diff --git a/Documentation/devicetree/writing-schema.rst b/Documentation/devicetree/writing-schema.rst index 03e279d8fd6a..be14dbed6081 100644 --- a/Documentation/devicetree/writing-schema.rst +++ b/Documentation/devicetree/writing-schema.rst @@ -8,6 +8,8 @@ written in a JSON compatible subset of YAML. YAML is used instead of JSON as it is considered more human readable and has some advantages such as allowing comments (Prefixed with '#'). +Also see :ref:`example-schema`. + Schema Contents --------------- @@ -170,3 +172,12 @@ json-schema Resources `JSON-Schema Specifications `_ `Using JSON Schema Book `_ + +.. _example-schema: + +Annotated Example Schema +------------------------ + +Also available as a separate file: :download:`example-schema.yaml` + +.. literalinclude:: example-schema.yaml