Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751748AbdDMLCy (ORCPT ); Thu, 13 Apr 2017 07:02:54 -0400 Received: from ec2-52-27-115-49.us-west-2.compute.amazonaws.com ([52.27.115.49]:39848 "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1750979AbdDMLCw (ORCPT ); Thu, 13 Apr 2017 07:02:52 -0400 Date: Thu, 13 Apr 2017 08:02:45 -0300 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , Jonathan Corbet Cc: Markus Heiser , Mauro Carvalho Chehab , LKML , Greg Kroah-Hartman , Kees Cook , Anton Vorontsov , Colin Cross , Tony Luck Subject: Re: [PATCH v2 00/11] Documentation: Add ABI to the admin guide Message-ID: <20170413080245.5c574fe2@vento.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 Content-Length: 1629 Lines: 44 Em Thu, 13 Apr 2017 07:08:43 -0300 Mauro Carvalho Chehab escreveu: > That's the third attempt to add support for the Kernel ABI > at the Documentation's admin guide. > > The first approach was based on a generic extension that > calls a random script. This one is based on a new Sphinx > extension with adds a symbol specific for parsing ABI > symbols. > > It adds a new script (scripts/get_abi.pl) with can either > search for ABI symbols that match a regular expression or > outputs the entire documentation found inside a directory > as a ReST book. > > Adding the ABI description to the Linux documentation is > as easy as adding a tab like: > > .. kernel-abi:: $srctree/Documentation/ABI/obsolete > > On version 3, I improved the script to better parse the > ABI descriptions. On this version, it will identify if the > description can be handled as a normal text. If so, it will > escape characters that has special meaning on Sphinx. > If it detects that the description syntax is too complex, > it outputs inside a literal block. > > Also on version 3, I opted to use 4 separate sections, one > for each type of symbol. It also add an entry with the name > of each ABI file, with has cross-references to the symbols > defined on each file. > > The parser was also improved to handle any content at the > files that are before the ABI tags. The HTML formatted result can be seen at: http://www.infradead.org/~mchehab/kernel_docs/admin-guide/abi.html And the PDF formatted result at (pages 151 to 565): http://www.infradead.org/~mchehab/kernel_docs_pdf/linux-user.pdf Thanks, Mauro