From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-10.1 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 62212C3F2D2 for ; Mon, 2 Mar 2020 08:00:09 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 39613246B6 for ; Mon, 2 Mar 2020 08:00:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1583136009; bh=M+O195E7L49tv5Ek4VyCqbN3KfTSKPYgE2OtHUVAdqI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=lWJ0NVXhzfd9nmNZ++Iqx1x9mN+j39RIX1dzelW1FSCQDm+qxdtxOTEjYIhDM8h7V eZ9uJoDvok9lGcLyVsH3qBZdPEX8RESWOMWQTzlX2qR+ivNmVmWpJycC/PtZv3A4of B5wrhEYVQuZn2BubC+jVKpE7dK5A9qp3NvFqSqzA= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727193AbgCBH7n (ORCPT ); Mon, 2 Mar 2020 02:59:43 -0500 Received: from mail.kernel.org ([198.145.29.99]:51352 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727138AbgCBH7m (ORCPT ); Mon, 2 Mar 2020 02:59:42 -0500 Received: from mail.kernel.org (ip5f5ad4e9.dynamic.kabel-deutschland.de [95.90.212.233]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 8B98A246CC; Mon, 2 Mar 2020 07:59:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1583135982; bh=M+O195E7L49tv5Ek4VyCqbN3KfTSKPYgE2OtHUVAdqI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=nGbBQuzF+fdUxUTI3L6i4qoF+RWnCIFPbXGK7bdymlDM4jfAqJxfpmfMB1MJxsuEG oCiTit7dJiRpGbkKy8SDh6KQRJicBFWi7oEwEBd5jilmnsCQjPtSMKy720OApQ/KD3 WpevFwreH+7duJVpXpYWfD2WTnho0p2AyzWxJObY= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1j8fzH-0003hB-AE; Mon, 02 Mar 2020 08:59:39 +0100 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Rob Herring , devicetree@vger.kernel.org Subject: [PATCH v2 12/12] docs: dt: convert writing-bindings.txt to ReST Date: Mon, 2 Mar 2020 08:59:37 +0100 Message-Id: <00ea462a2db1a9b4fd188e0100c52fdf0d68aaf0.1583135507.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.21.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org - Add a SPDX header; - Adjust document and section titles; - Mark literal blocks as such; - Add it to bindings/index.rst. Signed-off-by: Mauro Carvalho Chehab --- Documentation/devicetree/bindings/index.rst | 1 + .../{writing-bindings.txt => writing-bindings.rst} | 7 +++++++ 2 files changed, 8 insertions(+) rename Documentation/devicetree/bindings/{writing-bindings.txt => writing-bindings.rst} (92%) diff --git a/Documentation/devicetree/bindings/index.rst b/Documentation/devicetree/bindings/index.rst index 6b87875a049c..3837b17c234f 100644 --- a/Documentation/devicetree/bindings/index.rst +++ b/Documentation/devicetree/bindings/index.rst @@ -9,3 +9,4 @@ Device Tree ABI submitting-patches + writing-bindings diff --git a/Documentation/devicetree/bindings/writing-bindings.txt b/Documentation/devicetree/bindings/writing-bindings.rst similarity index 92% rename from Documentation/devicetree/bindings/writing-bindings.txt rename to Documentation/devicetree/bindings/writing-bindings.rst index ca024b9c7433..45ff426d0019 100644 --- a/Documentation/devicetree/bindings/writing-bindings.txt +++ b/Documentation/devicetree/bindings/writing-bindings.rst @@ -1,4 +1,8 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============================================================ DOs and DON'Ts for designing and writing Devicetree bindings +============================================================ This is a list of common review feedback items focused on binding design. With every rule, there are exceptions and bindings have many gray areas. @@ -8,6 +12,7 @@ Documentation/devicetree/bindings/submitting-patches.rst Overall design +============== - DO attempt to make bindings complete even if a driver doesn't support some features. For example, if a device has an interrupt, then include the @@ -32,6 +37,7 @@ Overall design Properties +========== - DO make 'compatible' properties specific. DON'T use wildcards in compatible strings. DO use fallback compatibles when devices are the same as or a subset @@ -53,6 +59,7 @@ Properties Board/SoC .dts Files +==================== - DO put all MMIO devices under a bus node and not at the top-level. -- 2.21.1