From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id 618D768 for ; Tue, 4 Aug 2015 07:43:03 +0000 (UTC) Received: from mail.holtmann.org (senator.holtmann.net [87.106.208.187]) by smtp1.linuxfoundation.org (Postfix) with ESMTP id B7BEF7D for ; Tue, 4 Aug 2015 07:43:02 +0000 (UTC) Content-Type: text/plain; charset=us-ascii Mime-Version: 1.0 (Mac OS X Mail 8.2 \(2102\)) From: Marcel Holtmann In-Reply-To: <1438672367.9418.3.camel@ellerman.id.au> Date: Tue, 4 Aug 2015 00:42:55 -0700 Content-Transfer-Encoding: quoted-printable Message-Id: <9B190076-263A-4C51-AFA4-A1D7FD403BC3@holtmann.org> References: <20150801164142.653012af@lwn.net> <1438672367.9418.3.camel@ellerman.id.au> To: Michael Ellerman Cc: ksummit-discuss@lists.linuxfoundation.org Subject: Re: [Ksummit-discuss] [CORE TOPIC] Documentation List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Hi Michael, >> Markdown in one of its many forms might be a good alternative here. = I'm >> also somewhat attracted by Sphinx, which is designed for documenting = code >> already and could probably be made to work well with our existing = kerneldoc >> comments without a whole lot of trouble. The Sphinx idea, though, is >> hobbled by the inconvenient fact that I've not had the time to = develop it >> far enough to even have a vague idea of whether it would make = real-world >> sense. >=20 > I'd vote for Markdown. It's very unobtrusive, reads nicely as plain = text, and > all the young kids know it from writing Github README.md files. actually AsciiDoc might be something to look into as well. Regards Marcel