From: Marcel Holtmann <marcel@holtmann.org>
To: Michael Ellerman <mpe@ellerman.id.au>
Cc: ksummit-discuss@lists.linuxfoundation.org
Subject: Re: [Ksummit-discuss] [CORE TOPIC] Documentation
Date: Tue, 4 Aug 2015 00:42:55 -0700 [thread overview]
Message-ID: <9B190076-263A-4C51-AFA4-A1D7FD403BC3@holtmann.org> (raw)
In-Reply-To: <1438672367.9418.3.camel@ellerman.id.au>
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.
>
> 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
next prev parent reply other threads:[~2015-08-04 7:43 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-08-01 14:41 Jonathan Corbet
2015-08-02 7:07 ` Davidlohr Bueso
2015-08-03 13:35 ` Rafael J. Wysocki
2015-08-03 13:27 ` Konstantin Ryabitsev
2015-08-03 14:33 ` Jonathan Corbet
2015-08-03 20:45 ` Dmitry Torokhov
2015-08-04 10:59 ` Daniel Vetter
2015-08-04 0:52 ` Rafael J. Wysocki
2015-08-04 12:50 ` Laurent Pinchart
2015-08-04 13:03 ` Daniel Vetter
2015-08-04 14:28 ` Laurent Pinchart
2015-08-04 14:30 ` Daniel Vetter
2015-08-04 13:50 ` Dan Carpenter
2015-08-04 14:05 ` Geert Uytterhoeven
2015-08-04 14:29 ` Daniel Vetter
2015-08-04 14:30 ` Laurent Pinchart
2015-08-04 17:10 ` Geert Uytterhoeven
2015-08-04 14:42 ` Konstantin Ryabitsev
2015-08-04 18:21 ` Tim Bird
2015-08-04 21:00 ` Laurent Pinchart
2015-08-04 15:35 ` Mark Brown
2015-08-05 17:07 ` Michael Kerrisk (man-pages)
2015-08-04 17:24 ` Jonathan Corbet
2015-08-04 7:12 ` Michael Ellerman
2015-08-04 7:42 ` Marcel Holtmann [this message]
2015-08-04 8:33 ` Peter Huewe
2015-08-05 17:08 ` Michael Kerrisk (man-pages)
2015-08-05 17:19 ` josh
2015-08-05 17:21 ` Konstantin Ryabitsev
2015-08-04 12:54 ` Laurent Pinchart
2015-08-04 13:07 ` Daniel Vetter
2015-08-04 11:09 ` Daniel Vetter
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=9B190076-263A-4C51-AFA4-A1D7FD403BC3@holtmann.org \
--to=marcel@holtmann.org \
--cc=ksummit-discuss@lists.linuxfoundation.org \
--cc=mpe@ellerman.id.au \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox