From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S938631AbcISLMy (ORCPT ); Mon, 19 Sep 2016 07:12:54 -0400 Received: from bombadil.infradead.org ([198.137.202.9]:40100 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755245AbcISLIM (ORCPT ); Mon, 19 Sep 2016 07:08:12 -0400 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , Markus Heiser , Jonathan Corbet , Jani Nikula , LKML , Greg KH Subject: [PATCH v4 23/29] Documentation/HOWTO: update information about generating documentation Date: Mon, 19 Sep 2016 08:07:57 -0300 Message-Id: X-Mailer: git-send-email 2.7.4 In-Reply-To: References: In-Reply-To: References: Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The description there are pre-Sphinx. Update it to cover the new way. Signed-off-by: Mauro Carvalho Chehab --- Documentation/HOWTO | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/Documentation/HOWTO b/Documentation/HOWTO index 31c8df5d20c7..f297d5512885 100644 --- a/Documentation/HOWTO +++ b/Documentation/HOWTO @@ -164,21 +164,37 @@ required reading: apply it to the different development branches of the kernel. The kernel also has a large number of documents that can be -automatically generated from the source code itself. This includes a +automatically generated from the source code itself or from +ReStructuredText markups (ReST), like this one. This includes a full description of the in-kernel API, and rules on how to handle -locking properly. The documents will be created in the -Documentation/DocBook/ directory and can be generated as PDF, -Postscript, HTML, and man pages by running: +locking properly. + +All such documents can be generated as PDF or HTML by running: :: make pdfdocs - make psdocs make htmldocs - make mandocs respectively from the main kernel source directory. +The documents that uses ReST markup will be generated at Documentation/output. +They can also be generated on LaTeX and ePub formats with: + +:: + + make latexdocs + make epubdocs + +Currently, there are some documents written on DocBook that are in +the process of conversion to ReST. Such documents will be created in the +Documentation/DocBook/ directory and can be generated also as +Postscript or man pages by running: + +:: + + make psdocs + make mandocs Becoming A Kernel Developer --------------------------- -- 2.7.4