From patchwork Mon Feb 12 15:05:24 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Krzysztof Kozlowski X-Patchwork-Id: 199874 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:50ea:b0:106:860b:bbdd with SMTP id r10csp2499128dyd; Mon, 12 Feb 2024 07:28:30 -0800 (PST) X-Forwarded-Encrypted: i=3; AJvYcCWK2/gppFWSIIM0/iCdd4btAXiMPKqZUcj3Pvmm5zyozjtW0VmY1XBBQ140srIps07uCj3j7TnrvZbS+Sw+lsuBo7Su0g== X-Google-Smtp-Source: AGHT+IHrprGLo7gU1nD3rZW3ztnDPAerhfWqUzj7KQus3HvYeiHd75rGj9hJVvmvBVv7kta9OcHo X-Received: by 2002:a17:902:d4c8:b0:1da:1fde:8411 with SMTP id o8-20020a170902d4c800b001da1fde8411mr8325333plg.34.1707751710338; Mon, 12 Feb 2024 07:28:30 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1707751710; cv=pass; d=google.com; s=arc-20160816; b=kyQ/T8a1e+jk1D3R22ekIdHeFDu0hfh9CNdd9ZKQfapbiWkfcBF34G5UT4tbIpcqLI 8L5Cb50ByEMzL3nJjXUBd9WW0s68/5bbFtpiRMXsS+9+t3yANFdcx5Bit5Q6mz5Zsw+G ZevNbQtNbRnbZiIO/eO4S/zXcmzFQspy6f+UYR9Lj7QppyfxxQUB9mq/TTBiMkCuiiSk eWRFeEB4vXu9keUvhVM+8J6rLs479bgYvZ6cFJhnU6vVhFdZKqfMQSAmAOrqMd+zaqJ1 9nwmYBG3ZMIutZRbwCAObXZzYGAdEO3M9ftNo5wL4dMMG2EkJUk1j1TKboIfBMn+NKIG 23WQ== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:references:in-reply-to:message-id :date:subject:cc:to:from:dkim-signature; bh=JyTLWvwJXO7xoVt7rika7/6Jet6raOmjXeaXTzvReEM=; fh=9m4hMo0rpAFaZ1NLAfqP42WDHo0In4z9UR3Kq+w9OiE=; b=Z0pvTDfRUfjC2IjKC84k8geOIL/o+OBSYgsF0/tlpwdJPV3GRtkeFf+vsN1FFvbe25 nJrJgyTqP48YcSraq8QU6347PinLl3h4I3AUGUZ/pBgeqeRim2LmZLTbOt+J7G+jF3q+ Gj3Zvr1pC3FSyZjaroyOQqLFFgga3KGoBQPjzqZOtJ6XwL9MtmNPNT/wwft5VBt9Y2tr 6ha6ZeAU7dVd8fShM4yzKbefhZC68gDTRmpjquMG8tXm7RaulQRtJqofAofmSxVWqWBu GHrV2ZyBbu2CJW85sSgsDpBva6d1/11z5XN6+sxT/cWXW2u9YZpHxdhYqZLmZc++jlg2 idNg==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=TB9CSVOt; arc=pass (i=1 spf=pass spfdomain=linaro.org dkim=pass dkdomain=linaro.org dmarc=pass fromdomain=linaro.org); spf=pass (google.com: domain of linux-kernel+bounces-61866-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-61866-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org X-Forwarded-Encrypted: i=2; AJvYcCUFFRal4OZrdoo7G3sXaxX7P3ZeQ1UHXVfmyPat6VJCQ/5VjUc521ljANO++OySHYJs9GUN6Q+r4aR2Ehbe/AlI4SxYMg== Received: from sy.mirrors.kernel.org (sy.mirrors.kernel.org. [2604:1380:40f1:3f00::1]) by mx.google.com with ESMTPS id 202-20020a6301d3000000b005dc55690b2bsi380896pgb.324.2024.02.12.07.28.29 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 12 Feb 2024 07:28:30 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-61866-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=TB9CSVOt; arc=pass (i=1 spf=pass spfdomain=linaro.org dkim=pass dkdomain=linaro.org dmarc=pass fromdomain=linaro.org); spf=pass (google.com: domain of linux-kernel+bounces-61866-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-61866-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by sy.mirrors.kernel.org (Postfix) with ESMTPS id 9BDF2B250BF for ; Mon, 12 Feb 2024 15:06:23 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 7984C3CF78; Mon, 12 Feb 2024 15:05:38 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="TB9CSVOt" Received: from mail-wr1-f45.google.com (mail-wr1-f45.google.com [209.85.221.45]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3D3DF3BB34 for ; Mon, 12 Feb 2024 15:05:34 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.45 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707750335; cv=none; b=d4Z8lsTaIUFB/hn2lB/rsYB7KgTLv6jE6na/g50pQSPmaUHYunyW54tGDYszrcWFMLbkyR54s23vbMl2WvowNhl45UKe7Pc8HlH+8i1Zxm5DElSZxkjp7TAhYifHWZjLbomcWBRplveGyEYM4MpnuPO6aGLVZBacn5o3KycBiLA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707750335; c=relaxed/simple; bh=KgUowYfgtXl28hHu8o53H1gGOukBG50qgWooL1gLRCo=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=in9y+xqjGFfj4ggu9JXESDY+SPebttfXnmwKRkjEvNa5+gFY2WLOTZ/zxQLZCW8uxV7dB3nTMlL7MrvyAARnJHMwg3T7uKoiFAafflYROWtReGfpT8SjeuKDLinz2BwTh86I9VcdOkZEO/tD+K4rXa7FASf9JBVSIQyqbF7r0oM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linaro.org; spf=pass smtp.mailfrom=linaro.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b=TB9CSVOt; arc=none smtp.client-ip=209.85.221.45 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=linaro.org Received: by mail-wr1-f45.google.com with SMTP id ffacd0b85a97d-33aea66a31cso1855247f8f.1 for ; Mon, 12 Feb 2024 07:05:33 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1707750332; x=1708355132; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=JyTLWvwJXO7xoVt7rika7/6Jet6raOmjXeaXTzvReEM=; b=TB9CSVOteC2cMG0gOP50vkZ9rvmG6IQszJ2R8MvIsL+64nVVJNy8siWyuX++uqX4Cp 4M4w3wQ5cdRgSfENQ2gSpIH5AgYqbAACWm/HyTKin2PDynH3yLUQKRnhdRA/gSs8zevo ZPC1B81vsMPsNiuvuDa5vyn/IlboWQKc9UgtbWLq+NNiz8Vs8QUrEUIag2KpWLTO0Tx6 wf4WAYhjpehQpVcykNle3myLlVzM5tobuezuAn8NG8NX/6GMG8bLwSw/0Dz1cvQSsk/+ ntSgK4cRj6nu14OJHIRpDRC3+42le5K/Y1E0kwmDI0K9RPJgt8jmvxkeHpl0tmohyAfN hx3w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1707750332; x=1708355132; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=JyTLWvwJXO7xoVt7rika7/6Jet6raOmjXeaXTzvReEM=; b=TLkB3bUD/5qmZDRCQHMPjRABicjmzbP5bBghU3ypFKKc9M27lpMXNlVZDpK+Hj9yNc GMxQdSGFNsV0oVcUfffNaiweGwSwH5jr8teIxl8XO6ap6XwfNz5bX8UrdV4GhzQ6lTvK fMyn2RiMQyQhsHhwdl9ozt2cSZ3TC8N5YLWZOmVBbjrhT+AmSkfCQ806K4wfrtMWHy1B /m0UULIjVviK4Z4Cis6JXKQH/h1F756A59o0QcJuLTKR0IUAgFbaNZYX/zSX6R95ZcoP 8JjRNl/GFgRvK/xZYtRidbNNzGpmhNBFrGc4MAVdiAy9yfU5BHGQ08CRNwnoUhDEaqAA rjrA== X-Forwarded-Encrypted: i=1; AJvYcCU5bAum19V3Iprl0BDPLv5tFlILnkA1hLOzD3F9EmIXKoXrP2tU0KNZIDYi+sjs8Tk73jd7/oUP/dpwT/geTDb5/94PfgKTWJTVA3TV X-Gm-Message-State: AOJu0YwVA+5w/WMtAgM4RJ6mRebhavBVVpB4fNoXssm+mqKhUHx4Q5Ea 3x5cEXVFpDwLr3aLisxCEY5GYpuwUBBNidyT2/sJ5+NTPBYYX1oWAp3D1ZS2/1c= X-Received: by 2002:a5d:6daa:0:b0:33b:582e:1e4e with SMTP id u10-20020a5d6daa000000b0033b582e1e4emr6259901wrs.6.1707750332526; Mon, 12 Feb 2024 07:05:32 -0800 (PST) X-Forwarded-Encrypted: i=1; AJvYcCXFXqShNNvztQDBXSpM8OOw/PBnzVmD8Yv1Kz/rd2nVlpk3UjRQrEKiLCd1ONeLZ0xpPw8+acwyELh5o62P19lzguRMuQD4Y1tczTwFDHKss0GLB3SHAGwPu6m1W+gh5e2w7AgpfS8neTPJSrQnw0zKbe6okpx35a30VbCL/A== Received: from krzk-bin.. ([178.197.223.6]) by smtp.gmail.com with ESMTPSA id bu13-20020a056000078d00b0033b6d5a1244sm6964223wrb.12.2024.02.12.07.05.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 12 Feb 2024 07:05:32 -0800 (PST) From: Krzysztof Kozlowski To: Rob Herring , Krzysztof Kozlowski , Conor Dooley , devicetree@vger.kernel.org, linux-kernel@vger.kernel.org Cc: Krzysztof Kozlowski Subject: [PATCH 3/3] docs: dt: writing-schema: document expectations on example DTS Date: Mon, 12 Feb 2024 16:05:24 +0100 Message-Id: <20240212150524.81819-3-krzysztof.kozlowski@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240212150524.81819-1-krzysztof.kozlowski@linaro.org> References: <20240212150524.81819-1-krzysztof.kozlowski@linaro.org> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1790707457414115674 X-GMAIL-MSGID: 1790707457414115674 Devicetree binding maintainers expect the example DTS in a binding to show the usage of only this one particular binding, without unrelated device nodes. Signed-off-by: Krzysztof Kozlowski --- Documentation/devicetree/bindings/writing-schema.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst index a35859f3be00..7e71cdd1d6de 100644 --- a/Documentation/devicetree/bindings/writing-schema.rst +++ b/Documentation/devicetree/bindings/writing-schema.rst @@ -92,8 +92,10 @@ additionalProperties / unevaluatedProperties 'unevaluatedProperties: false'. Typically bus or common-part schemas. examples - Optional. A list of one or more DTS hunks implementing the - binding. Note: YAML doesn't allow leading tabs, so spaces must be used instead. + Optional. A list of one or more DTS hunks implementing this binding only. + Example should not contain unrelated device nodes, e.g. consumer nodes in a + provider binding, other nodes referenced by phandle. + Note: YAML doesn't allow leading tabs, so spaces must be used instead. Unless noted otherwise, all properties are required.