From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1032478AbdEXUSh (ORCPT ); Wed, 24 May 2017 16:18:37 -0400 Received: from ec2-52-27-115-49.us-west-2.compute.amazonaws.com ([52.27.115.49]:36674 "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S964823AbdEXUSd (ORCPT ); Wed, 24 May 2017 16:18:33 -0400 Date: Thu, 25 May 2017 05:18:27 +0900 From: Mauro Carvalho Chehab To: Kees Cook Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , LKML , Jonathan Corbet , David Woodhouse , Brian Norris , Boris Brezillon , Marek Vasut , Richard Weinberger , Cyrille Pitchen , Linux mtd , Emese Revfy , "kernel-hardening@lists.openwall.com" Subject: Re: [PATCH 23/31] gcc-plugins.txt: standardize document format Message-ID: <20170525051827.0ed2b88e@vela.lan> In-Reply-To: References: Organization: Samsung X-Mailer: Claws Mail 3.14.1 (GTK+ 2.24.31; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Em Wed, 24 May 2017 10:35:42 -0700 Kees Cook escreveu: > On Thu, May 18, 2017 at 6:22 PM, Mauro Carvalho Chehab > wrote: > > Each text file under Documentation follows a different > > format. Some doesn't even have titles! > > > > Change its representation to follow the adopted standard, > > using ReST markups for it to be parseable by Sphinx: > > > > - promote main title; > > - use the right markup for footnotes; > > - use bold markup for files name; > > - identify literal blocks; > > - add blank lines to avoid Sphinx to complain; > > - remove numeration from titles. > > > > Signed-off-by: Mauro Carvalho Chehab > > Acked-by: Kees Cook > > This should probably get moved under "Kernel API documentation" but > may need a new sub-category, maybe "instrumentation"? Things like > KASan could be put under that too. Yeah, I guess that most documents under Documentation/ will need to be renamed and placed into an existing or new book. Kasan documentation is currently under dev-tools, with is, currently, an unsorted book with: coccinelle sparse kcov gcov kasan ubsan kmemleak kmemcheck gdb-kernel-debugging kgdb I agree with you: it probably makes sense to split external development tools, like coccinelle/sparse from Kernel instrumentation, like kgdb, kasan, gcc-plugins, etc. So, perhaps we can change the content of Documentation/dev-tools/index.rst to something like. ================================ Development tools for the kernel ================================ This document describe tools and instrumentation features of the Linux Kernel used by developers to do quality assurance (QA). This section describes Kernel internal features designed to provide mechanisms for developers to test their code. .. toctree:: :maxdepth: 2 (add here books like kasan, printk related docs, gcc-plugins, etc) This section describes external tools used to ensure Kernel quality assurance (QA). .. toctree:: :maxdepth: 2 (add here books related external tools and robots, like coccinelle, sparse, kernel build robot, ktest, Coverity, etc) .. only:: subproject and html Indices ======= * :ref:`genindex` Cheers, Mauro