From patchwork Mon Feb 12 15:05:22 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Krzysztof Kozlowski X-Patchwork-Id: 199868 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:50ea:b0:106:860b:bbdd with SMTP id r10csp2484385dyd; Mon, 12 Feb 2024 07:06:03 -0800 (PST) X-Google-Smtp-Source: AGHT+IFUpRWjYRjQWEv5uDfKzCCfbWjDVozyBureiNvtzCAm5GUU23dYBBQgUtuannjfLo6MiWPB X-Received: by 2002:a37:c40a:0:b0:785:d377:5c with SMTP id d10-20020a37c40a000000b00785d377005cmr4043038qki.12.1707750363451; Mon, 12 Feb 2024 07:06:03 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1707750363; cv=pass; d=google.com; s=arc-20160816; b=ngYriP8x7X0MTTmDEWvqntOMMPlIPWr8x0ElDwIYODspCYAB2ah/2FssuYldVARtc7 cK4Lq0tmxi2YnS/5FJ3eu3CMMlX2oNF8uImzn9TYY0UHupw1+2AlBCwrFDCH5FI7aKwJ kz8jT630wJazKbLgmV1p3fN9/GuLYe3HGWiGhVS8uJjK3nFgq6GwpdI38oZ9KN9ScPpC FiMO6+jmedLiNqg7LZhL/mzEoqf+Um6Taz9QL75yiW9D9eMTwhVCdnbBwt+h9t05FaAR 0uZUdrdMVbB1NICNlKWdfHT6FWMcVGQPqL2R5bCwKPCADzryTPzvdt0HOCnFOQaVWRRQ 72Og== 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:message-id:date:subject:cc:to :from:dkim-signature; bh=qir1fthWNc0Q+rYe6JcBDOv3+52gvRslOejMmhfxB7U=; fh=BI60uqBAfr4GaY0311nojqEP+w1ndk93fAgQLsw12ng=; b=iGOuQ1F+GE+DwOCJiSDnTUxZPpy3nUZvI6qiZQ1YgoBG+dodzxUYWF9jcNG4MR1fqH BWC9Hv4aIU1G8ZFJ5M05RyfaR/2/fZt589xuQ6KwjSLh7b6SOLJaJiwTZGq+D0/IV4y4 PfKo+IHhnLrcbhZ2v/0TMyXK6YS7TtHh8lCagvGFlJlXUCQ9dhxr0Oamx3RnLIvlX6Fp 843kTqMPzvdeXCpGy2ddLj8Sv1KPFLsi0GV4dn6wvFBa9sotP1BzAeMBm0/HVCyXa8ja TdK8NiOTYIugM3PaCLiqthfP7W1wV+qZp4+KNjAUnTd002LodV9gF437SOWqeU/FUqd3 lbvQ==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=GoEEYRjG; 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-61864-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-61864-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org X-Forwarded-Encrypted: i=2; AJvYcCVXIZ7W9EaUtxh7BWiKIGq56+7FzmhWrL28m+hzSDY8FK2EE5CyfDweU63w2lkcHjdGuUlhxqyjgNBkagzl3gDiciFnTA== Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [2604:1380:45d1:ec00::1]) by mx.google.com with ESMTPS id x14-20020a05620a098e00b00785ca459548si289631qkx.113.2024.02.12.07.06.03 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 12 Feb 2024 07:06:03 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-61864-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=GoEEYRjG; 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-61864-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-61864-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 ny.mirrors.kernel.org (Postfix) with ESMTPS id 410331C2190A for ; Mon, 12 Feb 2024 15:06:03 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 5B7283C68C; Mon, 12 Feb 2024 15:05:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="GoEEYRjG" Received: from mail-wr1-f43.google.com (mail-wr1-f43.google.com [209.85.221.43]) (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 EE6833B78D for ; Mon, 12 Feb 2024 15:05:30 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.43 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707750333; cv=none; b=b0VnVyjPbwc4pPCQ4gDrJu/P6TC1BEbeWkijNus5g1S8UBdlJhwRdcJDwhblPnfCk4jjx2Nbgr59uOKuLxQ4lfOFML2cd713obGeQe+OD5NKXfA/tNtxaT8X7L9fsefigmDg2BaD5l/oGPQAbJon8cIU7PTjrN6mALx5YzDKK9k= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707750333; c=relaxed/simple; bh=9pC2Z6Vms16Gtc+ezTFhNRm1u9ImyiB0y+VyyuUyUns=; h=From:To:Cc:Subject:Date:Message-Id:MIME-Version; b=sDchs3HqEOxwoVrpJIOKoAqGhqq8V2fbhZQ7cooUZXpnXgyA28xI8dBPghzq/4fgsxFwVLi8SBVP5DfrrQ0mJBJr5OthHWFAyvN8af0ozKScBvEeFZ+OnX1RAxy3bK6NJwu4pHMgDZZa6/btdVqxWnLfK+vz+j185hU1d13RNwo= 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=GoEEYRjG; arc=none smtp.client-ip=209.85.221.43 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-f43.google.com with SMTP id ffacd0b85a97d-33b29b5ea96so1559760f8f.0 for ; Mon, 12 Feb 2024 07:05:30 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1707750329; x=1708355129; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=qir1fthWNc0Q+rYe6JcBDOv3+52gvRslOejMmhfxB7U=; b=GoEEYRjGfMILgq2JtEnPhPahmrUVt8m6kLLn2CySG50GHjQlCSBwHb5uPohXGaeSsv XNax21K57O4bue1J5AGt7c0AU/R4kAGm3r/fFRIume1LGOmT0zfLma4VfSTRr4vQ4KZk 2lw7a9ZcCbw1LQOX78IroQHwzktr0RpIOUGEhyQE/1RaHm4cuODGF17T7OrorKK7tJH7 Wu/BOGpv9pNrOMxog102FHNzEZO+WU+ksVAxOQQEVHRRYWKYpfAPi9jLCZuoTBjSrTeK B5VW0FStTE2cB+vH0T3OULBepPFnr4pe/MdnG+PnQsW64rmZCVP+xyjuV2w6jIijyo1U i9vQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1707750329; x=1708355129; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=qir1fthWNc0Q+rYe6JcBDOv3+52gvRslOejMmhfxB7U=; b=QwRtEFCMfVXmvCR+qp2f9qrpPMw/f0iGvJd/g+K/cV9JofpYtkmKktDZVeVw/cssy/ uKZvyKOxO+UBKWaugq+73HyaNz5wc2mnNmcV3XtPwc5Qi/qCFNweQ5jbahutYKof4lqg z4/hs3p8BGpExTrPZUd1ZxGZfhkQst6VXtHBPFDkl2IKaCipwX73AGVsNDkJZZ6Nuohl HrVvkOLD31FaMts9j8n2mVYA4MsmwWzE6xZxYd0HO7FAecIvX7BAZZUJJoegtJb1VYXB yw/EASnHKmXRujwCq+6v8tC3/nPY7LS8FFJkzTVmbV0qtUxIGmm9hlGiuOz5Xw5VGpVg iJ2w== X-Gm-Message-State: AOJu0YxszVKq6in5f/8I23ssNjV8lLXqdMDb1DGpFBsuwVKLPuatxnr0 41c8y7H6sU+gcP2rpJapfJ4IAjEytqKP3MWVXUuDe6VDVDzfbqO1oczVOABUqKI= X-Received: by 2002:a5d:42d1:0:b0:33b:69ef:dfb with SMTP id t17-20020a5d42d1000000b0033b69ef0dfbmr6188662wrr.14.1707750329247; Mon, 12 Feb 2024 07:05:29 -0800 (PST) X-Forwarded-Encrypted: i=1; AJvYcCU1e8ENr2VTkB/vWhkQm6MFHIiUtKB5Op+3TDHDfQfwaRr5dbRx6cf591hcKNk5scZ0JFBn8dznY4bBMDdJB/jZLetI7rqwppzEt45akuaV0wIwlUyoq8QwFLKGn/ka+2mJodweYK2QN73wNPm5rupu4c7w1v1mLwICwQEvhw== Received: from krzk-bin.. ([178.197.223.6]) by smtp.gmail.com with ESMTPSA id bu13-20020a056000078d00b0033b6d5a1244sm6964223wrb.12.2024.02.12.07.05.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 12 Feb 2024 07:05:28 -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 1/3] docs: dt: writing-schema: clarify that schema should describe hardware Date: Mon, 12 Feb 2024 16:05:22 +0100 Message-Id: <20240212150524.81819-1-krzysztof.kozlowski@linaro.org> X-Mailer: git-send-email 2.34.1 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: 1790706044803301003 X-GMAIL-MSGID: 1790706044803301003 The 'title' and 'description' fields in Devicetree schema is supposed to describe hardware, not the binding itself. Signed-off-by: Krzysztof Kozlowski --- Documentation/devicetree/bindings/writing-schema.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst index 0a6cf19a1459..2e5575e6a4e5 100644 --- a/Documentation/devicetree/bindings/writing-schema.rst +++ b/Documentation/devicetree/bindings/writing-schema.rst @@ -31,7 +31,7 @@ $schema Indicates the meta-schema the schema file adheres to. title - A one-line description on the contents of the binding schema. + A one-line description of the hardware being described in the binding schema. maintainers A DT specific property. Contains a list of email address(es) @@ -39,7 +39,7 @@ maintainers description Optional. A multi-line text block containing any detailed - information about this binding. It should contain things such as what the block + information about this hardware. It should contain things such as what the block or device does, standards the device conforms to, and links to datasheets for more information.