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 Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 55DB5C433FE for ; Sun, 22 May 2022 07:51:17 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235455AbiEVHvQ (ORCPT ); Sun, 22 May 2022 03:51:16 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51788 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230461AbiEVHvO (ORCPT ); Sun, 22 May 2022 03:51:14 -0400 Received: from mail-lf1-x12a.google.com (mail-lf1-x12a.google.com [IPv6:2a00:1450:4864:20::12a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 85CAC63CE for ; Sun, 22 May 2022 00:51:11 -0700 (PDT) Received: by mail-lf1-x12a.google.com with SMTP id w14so20723352lfl.13 for ; Sun, 22 May 2022 00:51:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=message-id:date:mime-version:user-agent:subject:content-language:to :cc:references:from:in-reply-to:content-transfer-encoding; bh=88owq8uKXDsheKyfsbWWUMK1Cxn07lBnqHB3aJaGB1U=; b=HVhU/XPrfs70po+5RBr7uTXEFc/VT5WW15xfZyh/B66A+4JMDjApfrPm9LRtsDlVDx rn4F21ZXGLeqWNK6TPvES0lJnTpmWCfIDKIIQKrhwl5a5jq+U03iw57s2C+vvGGiEaTa K92fGdP1dmnlb2nq/bKbPysPtwIOUuZc0KgZ3pzvbRgmExF722IxMHjeKrj1xbqGKvy0 OHdyWGfX/JJXBD6AvvCredZcZamJSn5dzrg6726hKyC+yDDqAZxIF1ZnRyWlxgAnF9tA x/zX17rGo5nQAgaLZYBoVVJG9yl9byHEjzzdusuHaqplRK85L/MKn+jf/6y7/vBOO7G9 Q1xw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:date:mime-version:user-agent:subject :content-language:to:cc:references:from:in-reply-to :content-transfer-encoding; bh=88owq8uKXDsheKyfsbWWUMK1Cxn07lBnqHB3aJaGB1U=; b=Y/TmeSoFkwV4AG6KXkBWUNr69c8rzQ6zIsR02qsyfEgNJpEj5quBz4UO+B0XTSTFsO /bzb+z0UPtSWh9tW7H18+USE/TW6bErTDs/LSDU/Yx2BSR+xmBglLjGwxAUQVVlj0PSi IjDCRYazbs3XG5fgnQy5ndFnerN0wmZax38qWlk7lfPeE0FE1Y+rfnT5Jp6dmdWosAu2 J8IZQb/YXe21tK85rkWSVEd0NN+3WqPIFF2/UNkTqBYf+qGnPmIIMg1pOTR+7T0HphPw 1YDj1JSvTSKHl6ME/D4BrTcrmTRzIm+3+sRlkF0+eDhvZhuqKjqR2qqt5TLdJOsD4rCX dMcw== X-Gm-Message-State: AOAM532vpTfShKU6M7PiPAq42lwPYzKzGp1R0rao98p/t9N/XHFsJzTV YDUdXrFrv+9/fVT8Hl0iN5LKVQ== X-Google-Smtp-Source: ABdhPJxn3SFCU7olnoR4mSUevcHXgr6rUAve15/U4XQVAOEFghCkWDWlZk6zSIXXpDyWWLZER5dIUg== X-Received: by 2002:a05:6512:150a:b0:474:bb9:5174 with SMTP id bq10-20020a056512150a00b004740bb95174mr11826565lfb.207.1653205869755; Sun, 22 May 2022 00:51:09 -0700 (PDT) Received: from [192.168.0.17] (78-11-189-27.static.ip.netia.com.pl. [78.11.189.27]) by smtp.gmail.com with ESMTPSA id q6-20020ac25286000000b0047255d211c1sm1354476lfm.240.2022.05.22.00.51.08 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sun, 22 May 2022 00:51:09 -0700 (PDT) Message-ID: Date: Sun, 22 May 2022 09:51:08 +0200 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.8.1 Subject: Re: [PATCH] dt-bindings: mips: Convert plain text file to ReST Content-Language: en-US To: Soumya Negi Cc: Shuah Khan , Thomas Bogendoerfer , Rob Herring , Krzysztof Kozlowski , linux-kernel-mentees@lists.linuxfoundation.org, linux-mips@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, Greg KH References: <20220521015613.6197-1-soumya.negi97@gmail.com> <7fd80a4b-5e60-0117-b790-359f6d94aeef@linaro.org> <20220521202412.GE14144@Negi> From: Krzysztof Kozlowski In-Reply-To: <20220521202412.GE14144@Negi> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org On 21/05/2022 22:24, Soumya Negi wrote: > On Sat, May 21, 2022 at 04:25:07PM +0200, Krzysztof Kozlowski wrote: >> On 21/05/2022 03:56, Soumya Negi wrote: >>> Converts .txt documentation file to ReST format(.rst). >>> >>> Signed-off-by: Soumya Negi >>> --- >>> .../devicetree/bindings/mips/cpu_irq.rst | 56 +++++++++++++++++++ >>> 1 file changed, 56 insertions(+) >>> create mode 100644 Documentation/devicetree/bindings/mips/cpu_irq.rst >>> >>> diff --git a/Documentation/devicetree/bindings/mips/cpu_irq.rst b/Documentation/devicetree/bindings/mips/cpu_irq.rst >>> new file mode 100644 >>> index 000000000000..601cc12caa2a >>> --- /dev/null >>> +++ b/Documentation/devicetree/bindings/mips/cpu_irq.rst >>> @@ -0,0 +1,56 @@ >>> +============================= >>> +MIPS CPU interrupt controller >>> +============================= >>> + >>> +On MIPS the ``mips_cpu_irq_of_init()`` helper can be used to initialize the 8 CPU >>> +IRQs from a devicetree file and create a ``irq_domain`` for IRQ controller. >> >> Bindings is not a place for code. No. >> >>> + >>> +With the ``irq_domain`` in place we can describe how the 8 IRQs are wired to the >>> +platforms internal interrupt controller cascade. >>> + >>> +Below is an example of a platform describing the cascade inside the devicetree >>> +and the code used to load it inside ``arch_init_irq()``. >>> + >>> +Required properties >>> +------------------- >>> +* compatible: Should be **"mti,cpu-interrupt-controller"** >> >> If you wanted to add bindings, please use DT schema format (see >> writing-schema, writing-bindings and example-schema files). > > Hi, > I don't want to add bindings. I want to the convert the doc file > Documentation/devicetree/bindings/mips/cpu_irq.txt to ReST file format. > > I referred to this page(https://wiki.linuxfoundation.org/lkmp/lkmp_task_list) while > creating the patch. It also mentions exceptions that should be kept as plain text > files. Does this file count as an exception? The original file you mention is a dt-bindings file, not a doc file. As you see it is in the bindings subdirectory. All (or almost all) files in Documentation/devicetree/bindings are bindings. It should be stripped out of C code and converted to DT schema (and moved to interrupt-controllers), not to ReST. Best regards, Krzysztof