From patchwork Mon Jan 8 08:37:49 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Krzysztof Kozlowski X-Patchwork-Id: 185840 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:37c1:b0:101:2151:f287 with SMTP id y1csp895764dyq; Mon, 8 Jan 2024 00:38:26 -0800 (PST) X-Google-Smtp-Source: AGHT+IFokgM8lBydlADWi4ma78/31veibN/jCV+XSXmVZ9Ft2hwfxvFQloz69pwCbSAgw/otyvWj X-Received: by 2002:a17:902:82c3:b0:1d4:be70:21c0 with SMTP id u3-20020a17090282c300b001d4be7021c0mr3806815plz.16.1704703106361; Mon, 08 Jan 2024 00:38:26 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1704703106; cv=none; d=google.com; s=arc-20160816; b=v5JAqyjFWfVqcL76xRG/dK7Z+pRreUJX3j8a1sfDCF/XAx6dyOs7iMMh/6AHJT/gpJ qmNkcu/GGqoWw3MKWPk+MJOLM+ZShP/+efJ0wB55dJljT8Q+v+gK1IWaNQdeZ3PKbNjB Hx1g4lrxdm+/736Bgz9I1Mtm9w4MRkdSc6rjyy4H2UV0t6iNPKa6yUDeAuEBpPllgk5b uofzf4tWBz7FXi78bAi9fiIYmBUBRJeIsSw4VGkBiDMWChOIt9vWfqyhQ/Ty7j4PKRKV MW3nQGoDUJC3S2iN63DGiGfOJNPPrCdxeOT2+OxFKWmve/+8ccWb8Jsit0JlBnBdDEdT 0LdA== ARC-Message-Signature: i=1; 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=h9EjmPEpm+7zFB1A5P7UnIdVAOMDyAK96vwEc7rBv8w=; fh=7TVkEZZKrFPdsdn1MV030Rx9E0wsYAs5UPWs5tafNfU=; b=yCP/NpOshVzGywkfDdqW0KIPOrMnCCZmcTo8DQsv8agRUXebpP5orl4BoLC3c+KTun 10kLK2iz/roK2VQCBNsISknExdZdIs9z8EXUqvjT8UOPTPov5lFyPPvxK7CySHbZp4eB Da+LnUl50VHxL7hCZ0v22oCo1+OqUVCNBfgVO0Y/nr9Zg4pBXWiira8sIslwhenW5iiq 1fvQtihcMa4UcQsciRIs/rprf8nPEMEYvNZiCJNUeKv97fpnly7YY0VRFkhHzBf69NaV YT+VV+H5hgKzGVVXR3HXm0fXabsEJW7IFOb6mJ9ikhECI4yWrj0pWP3+pwlL3wbEWhi1 4Jaw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=rB4y1W2j; spf=pass (google.com: domain of linux-kernel+bounces-19194-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-19194-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from sv.mirrors.kernel.org (sv.mirrors.kernel.org. [2604:1380:45e3:2400::1]) by mx.google.com with ESMTPS id x12-20020a17090300cc00b001d508e3cf5csi3535438plc.287.2024.01.08.00.38.26 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 08 Jan 2024 00:38:26 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-19194-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=rB4y1W2j; spf=pass (google.com: domain of linux-kernel+bounces-19194-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-19194-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 sv.mirrors.kernel.org (Postfix) with ESMTPS id 24AF02825AB for ; Mon, 8 Jan 2024 08:38:26 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id D816DC13D; Mon, 8 Jan 2024 08:38:04 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="rB4y1W2j" X-Original-To: linux-kernel@vger.kernel.org Received: from mail-ej1-f47.google.com (mail-ej1-f47.google.com [209.85.218.47]) (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 8A0051170D for ; Mon, 8 Jan 2024 08:38:00 +0000 (UTC) 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-ej1-f47.google.com with SMTP id a640c23a62f3a-a298accc440so152431666b.1 for ; Mon, 08 Jan 2024 00:38:00 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1704703079; x=1705307879; 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=h9EjmPEpm+7zFB1A5P7UnIdVAOMDyAK96vwEc7rBv8w=; b=rB4y1W2jdiSv1eD16TZIQLf4hXLfK8bfRRRTLSa/VI60RnLg0/De3xXp980lt/bDaf Yfw9TVXpTXi5r9tVFYiJT2HE9MMb+Ejc/pvspaYuxrjrdIJakta3SaO1AVIfvB1toGcG TCu0/7TvA3Rs/jhbVKhQyH2FCrBFO3+ySPXc+R8eLl+Lc3+8HRk42BBwrQRvOnI57lql 8hLqfyO8MPgFpZ1ZjQRoqv2CIvE/tCsyPVnVdzv720kT03rTa14fsGlv8YTWxziU82ZB QoL5wqmWHo0o2MO6E/bL515hJXzsTsVPp1n4gv3lqZnpadN06/6UlU9gTBfXECmeDoVF nF8A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1704703079; x=1705307879; 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=h9EjmPEpm+7zFB1A5P7UnIdVAOMDyAK96vwEc7rBv8w=; b=JdhJN1Y+QNYGSuBUXTedHXY5yY4TERjEtCTmvFQvhz4jwI518Dr245Grt9FeIaCVsl 37sD9mfkTpoIMKhad83mwYFGYJHj7G2Ckm/Si41BrU+/8qTczPcoHbaPXNnl8fdi0Dtr o3xgm++R1j0Mn2QsHLyDwB1Zrpav4NCiztbUE+5mzGp5oOTZfj9hWKlbojfK9cj/yEHZ jR12Ns1msD4k9b9MNjv+H5xoxpSe1/7OdsGelyi6rFiBTYOIlaXfrNZrfj1Iw4TwQQ96 g9Z5OzJitiyLWHSFtIOV1bPsomGDSIGu74q+4tVQU/Ux+vmkHYbE4Dq7M5CIu2e0TQrc j6Xg== X-Gm-Message-State: AOJu0YxL0zUwtagBcI76pMGth4UbjdQ9Er+yLMDGv7djjoXT/oNBJBd9 Vi1L0enjEFfCf8yD+EU8u9EuaOObRSV8Rw== X-Received: by 2002:a17:907:268a:b0:a28:abb3:dd74 with SMTP id bn10-20020a170907268a00b00a28abb3dd74mr1615203ejc.81.1704703078532; Mon, 08 Jan 2024 00:37:58 -0800 (PST) Received: from krzk-bin.. ([178.197.223.112]) by smtp.gmail.com with ESMTPSA id ws6-20020a170907704600b00a2a360d719fsm1683504ejb.221.2024.01.08.00.37.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 08 Jan 2024 00:37:58 -0800 (PST) From: Krzysztof Kozlowski To: Rob Herring , Krzysztof Kozlowski , Conor Dooley , devicetree@vger.kernel.org, linux-kernel@vger.kernel.org Cc: Krzysztof Kozlowski , Mark Brown , Mauro Carvalho Chehab Subject: [PATCH 1/2] docs: dt: submitting-patches: drop outdated points to TXT format Date: Mon, 8 Jan 2024 09:37:49 +0100 Message-Id: <20240108083750.16350-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: 1787510764167850195 X-GMAIL-MSGID: 1787510764167850195 New bindings in TXT format are not accepted and DT schema format expects all compatibles to be explicitly defined, thus guidance about "wildcard " is not correct anymore. Drop that paragraph and update one more place which still mentions TXT files. Signed-off-by: Krzysztof Kozlowski --- Cc: Mark Brown Cc: Mauro Carvalho Chehab --- .../devicetree/bindings/submitting-patches.rst | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst index 36a17b250ccc..b460ebffee42 100644 --- a/Documentation/devicetree/bindings/submitting-patches.rst +++ b/Documentation/devicetree/bindings/submitting-patches.rst @@ -42,28 +42,18 @@ I. For patch submitters the code implementing the binding. 6) Any compatible strings used in a chip or board DTS file must be - previously documented in the corresponding DT binding text file + previously documented in the corresponding DT binding file in Documentation/devicetree/bindings. This rule applies even if the Linux device driver does not yet match on the compatible string. [ checkpatch will emit warnings if this step is not followed as of commit bff5da4335256513497cc8c79f9a9d1665e09864 ("checkpatch: add DT compatible string documentation checks"). ] - 7) The wildcard "" may be used in compatible strings, as in - the following example: - - - compatible: Must contain '"nvidia,-pcie", - "nvidia,tegra20-pcie"' where is tegra30, tegra132, ... - - As in the above example, the known values of "" should be - documented if it is used. - - 8) If a documented compatible string is not yet matched by the + 7) 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). + string that is matched by the driver. - 9) Bindings are actively used by multiple projects other than the Linux + 8) Bindings are actively used by multiple projects other than the Linux Kernel, extra care and consideration may need to be taken when making changes to existing bindings. From patchwork Mon Jan 8 08:37:50 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Krzysztof Kozlowski X-Patchwork-Id: 185841 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:37c1:b0:101:2151:f287 with SMTP id y1csp895821dyq; Mon, 8 Jan 2024 00:38:40 -0800 (PST) X-Google-Smtp-Source: AGHT+IFA96y0fAo9ekgFAldcMzBs2AkTTv/o5/hbS/AR96Q61BpWXDliLKMFzA62MZ5G6MT8qvRm X-Received: by 2002:a05:6358:7204:b0:175:86ae:9131 with SMTP id h4-20020a056358720400b0017586ae9131mr2052565rwa.6.1704703119862; Mon, 08 Jan 2024 00:38:39 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1704703119; cv=none; d=google.com; s=arc-20160816; b=cPvrjuL1sQawUdKyywNQV5Fq9UESIlrqfXy5344cjn7vT/6zIw0MqFDuBWQ8xSjo8W irT2B+Sg4B433vIDYOX4//5XiWpNXCkowSEJFZ0IU9d2o+TwIHgZB1/TgOPFQwyEkDry zJVAIh6fBWI/2eGL5j8A3hcld1pGAm17L0FLPJVYv+icTU+LPDXAaspua6TArRBl3fCT MmoJAnyYpXf4F+7YWWuTiLUghIEeqs+UwdcRlEPb6Fa2ON+bnWdSeE+PY09/L53xCMXg 9fFO75LjUbwGnAYutiiwe1hqddP+L602JNpctv6NBvIKXW7ykt0t710nqQKVkCrE9+9X psAA== ARC-Message-Signature: i=1; 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=LmR9KxQP8dD4PzUTQD7z34F00y2gKvodpqxcPdEO1Jc=; fh=7TVkEZZKrFPdsdn1MV030Rx9E0wsYAs5UPWs5tafNfU=; b=PfU7ZVlHZ3lgBHW5LuAeSjUvvGkBCwi+fjhqcV+hRd0qINm/sawn6ZzsfCAjSqtBum qkOm50QwNjk6P38tw7wL/0tQSd/kLk+lSkS1ww23bMB/aRS2nDQrmxAPM8il3ZEoapIq WPYyDp8DLjkjbY6lM8JvUx3dKthTb2g45KcBEed+meGX6AnSLmGEigM1XfBmWHp+Jrh6 o7kyGBKSv2iuyUHhm5u6frBk5TMA36RmhrHddBbd0QIOYqeQYHlHpVfdHvOLyHM2M7et EFvexDZhqGpBTWH5VrhaqqvyS9vg7qcvZMBJV0EwUyG+Qn66WRNV8EZAeFODaBr/Xcdn zxrQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=gq4D9Z2p; spf=pass (google.com: domain of linux-kernel+bounces-19195-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-19195-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from sv.mirrors.kernel.org (sv.mirrors.kernel.org. [2604:1380:45e3:2400::1]) by mx.google.com with ESMTPS id h185-20020a636cc2000000b005bdfbf1d562si5580789pgc.192.2024.01.08.00.38.39 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 08 Jan 2024 00:38:39 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-19195-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=gq4D9Z2p; spf=pass (google.com: domain of linux-kernel+bounces-19195-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-19195-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 sv.mirrors.kernel.org (Postfix) with ESMTPS id 973DB2825F6 for ; Mon, 8 Jan 2024 08:38:39 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 2315B10A0F; Mon, 8 Jan 2024 08:38:07 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="gq4D9Z2p" X-Original-To: linux-kernel@vger.kernel.org Received: from mail-ej1-f52.google.com (mail-ej1-f52.google.com [209.85.218.52]) (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 F2FDA1173E for ; Mon, 8 Jan 2024 08:38:02 +0000 (UTC) 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-ej1-f52.google.com with SMTP id a640c23a62f3a-a2ac304e526so37089466b.0 for ; Mon, 08 Jan 2024 00:38:02 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1704703081; x=1705307881; 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=LmR9KxQP8dD4PzUTQD7z34F00y2gKvodpqxcPdEO1Jc=; b=gq4D9Z2pMuu990PveRM7Ho9mA8QXwLC9Wup3I/2NYHu2KB9aMvNQeZp4/R26ZKZzVt GDPoL5FY+8ZDO/HqfSyVQplqqPr4wNenh3ADokOXiJE6TaRyOyVArRYfesyLCyzeBEXH z5skURwFU3hhRR+oUv0b0VcLRNNgR9uyR6lIVOq41lQErNPGYqMC08WKrVI+6hmx26Nb pttdftgY6XIrhCFUPXwDChN1TC6Y067JCPbY4MPiBnKdQfslzIocQIoZT5prcAQB3pLL gnf0dp7QD0lYqzszEBmM5wtZr3wOfuaAHH2c3AHWBbXLT/1r+wjVipSE/AsUfSZjq2/p Bq8g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1704703081; x=1705307881; 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=LmR9KxQP8dD4PzUTQD7z34F00y2gKvodpqxcPdEO1Jc=; b=vExrCoUqbbxogKeqs2WY6ACb009rcLQIqHE669HJtA50TK9SZb+/ACT4IBOQ4gK5RG +uexIPbj1GxOYIZMbE8Zl/AussYtqLUp/PydRZnlN1iehHO6dKviKI9fRpjvB9CGB0n7 5YQzlbu6iJQ4MJLaEIdccfMP5fwJlBgeuyMpNgyU8T9OK5xqeX/CfJS6JSpmz0qXTqNc SnyhseUs693IRIf9pF+bNDRU1qJwh2VT4olGMhuP9iIiEj+OCJyGNhjtz/TpYjJRZ8Yd YTAppXvy2zz773TfJy73T15cNx4gEGKjKhqJxbEMq4D6L/lizZDdFudWSvVoa9caWlym 1tkQ== X-Gm-Message-State: AOJu0YzcmkgPCR4oQD0xKNyzZa5FsSuf395Z0D6Re/mz6gQ7qjli/PAY 3HDdX7mIbfAmiD2hgJZTIitdhaGCOrYaOg== X-Received: by 2002:a17:907:969e:b0:a26:9d95:a347 with SMTP id hd30-20020a170907969e00b00a269d95a347mr1631096ejc.25.1704703080980; Mon, 08 Jan 2024 00:38:00 -0800 (PST) Received: from krzk-bin.. ([178.197.223.112]) by smtp.gmail.com with ESMTPSA id ws6-20020a170907704600b00a2a360d719fsm1683504ejb.221.2024.01.08.00.37.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 08 Jan 2024 00:37:59 -0800 (PST) From: Krzysztof Kozlowski To: Rob Herring , Krzysztof Kozlowski , Conor Dooley , devicetree@vger.kernel.org, linux-kernel@vger.kernel.org Cc: Krzysztof Kozlowski , Mark Brown , Mauro Carvalho Chehab Subject: [PATCH 2/2] docs: dt: submitting-patches: add commit subject prefix in reversed format Date: Mon, 8 Jan 2024 09:37:50 +0100 Message-Id: <20240108083750.16350-2-krzysztof.kozlowski@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240108083750.16350-1-krzysztof.kozlowski@linaro.org> References: <20240108083750.16350-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: 1787510778578107665 X-GMAIL-MSGID: 1787510778578107665 ASoC, media, regulators and SPI subsystems prefer commits starting with subsystem name (e.g. "spi: dt-bindings:"), so document this to avoid confusing contributors. Cc: Mark Brown Cc: Mauro Carvalho Chehab Signed-off-by: Krzysztof Kozlowski Reviewed-by: Mark Brown --- Documentation/devicetree/bindings/submitting-patches.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst index b460ebffee42..a64f21a5f299 100644 --- a/Documentation/devicetree/bindings/submitting-patches.rst +++ b/Documentation/devicetree/bindings/submitting-patches.rst @@ -15,6 +15,11 @@ I. For patch submitters "dt-bindings: : ..." + Few subsystems, like ASoC, media, regulators and SPI, expect reverse order + of the prefixes:: + + ": dt-bindings: ..." + The 80 characters of the subject are precious. It is recommended to not use "Documentation" or "doc" because that is implied. All bindings are docs. Repeating "binding" again should also be avoided.