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=-13.1 required=3.0 tests=BAYES_00,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 7A9E0C6379D for ; Fri, 30 Oct 2020 07:43:43 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 24CAA22203 for ; Fri, 30 Oct 2020 07:43:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1604043823; bh=wFU++KSFEQxW3zzCglij7nhYkn+PPO5+JXjet9MbMEw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=bmsWqmaoNGq1fKCyvkt55UMkVITlb/w19UGuXU0WjYk32AF169JF9y0EfSmaHMG71 CfVFR8esGZzZkNHJTphe34NYPk96rKohE3DEq1CLDaCCRs2Q13Z//OfwAbN7Z745e2 IUZWD6JydEopf1ihtYnMbpwY3qGxTMhnvg618DdU= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726073AbgJ3Hn1 (ORCPT ); Fri, 30 Oct 2020 03:43:27 -0400 Received: from mail.kernel.org ([198.145.29.99]:51630 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726065AbgJ3HlE (ORCPT ); Fri, 30 Oct 2020 03:41:04 -0400 Received: from mail.kernel.org (ip5f5ad5bb.dynamic.kabel-deutschland.de [95.90.213.187]) (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 BBCFD22254; Fri, 30 Oct 2020 07:41:02 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1604043662; bh=wFU++KSFEQxW3zzCglij7nhYkn+PPO5+JXjet9MbMEw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=t9ol1wUdQE4dXG6YMW4SusstNI573YVlapnfUR/QyIq4yLp4+0RnOQ78mZSRFTNOe /aHlbQiiGD/Ksf+jT28w3zTH9oZhUwjLRShzxxZPJDUSr/2PTtkVuqpHK4917o3dLu ZX9YSmbicL4Hfec/PSti7PAFXJwnXOuCJlDE4EC8= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kYP1w-004Og4-RJ; Fri, 30 Oct 2020 08:41:00 +0100 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Jonathan Corbet" , linux-kernel@vger.kernel.org Subject: [PATCH v2 18/39] docs: ABI: README: specify that files should be ReST compatible Date: Fri, 30 Oct 2020 08:40:37 +0100 Message-Id: <178a997070debd1953ba7d302c375948501d6193.1604042072.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.26.2 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org As we plan to remove the escaping code from the scripts/get_abi.pl, specify at the ABI README file that the content of the file should be ReST compatible. Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/README | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/Documentation/ABI/README b/Documentation/ABI/README index 3121029dce21..8bac9cb09a6d 100644 --- a/Documentation/ABI/README +++ b/Documentation/ABI/README @@ -32,7 +32,7 @@ The different levels of stability are: layout of the files below for details on how to do this.) obsolete/ - This directory documents interfaces that are still remaining in + This directory documents interfaces that are still remaining in the kernel, but are marked to be removed at some later point in time. The description of the interface will document the reason why it is obsolete and when it can be expected to be removed. @@ -58,6 +58,14 @@ Users: All users of this interface who wish to be notified when be changed further. +Note: + The fields should be use a simple notation, compatible with ReST markup. + Also, the file **should not** have a top-level index, like:: + + === + foo + === + How things move between levels: Interfaces in stable may move to obsolete, as long as the proper -- 2.26.2