Skip to content

Commit

Permalink
First try at converting user-manual to AsciiDoc
Browse files Browse the repository at this point in the history
You can do "make doc" in the main directory to create the html version,
and if you want to play around with it, do "make show" in the
Documentation subdirectory to start firefox on the end result.

It's by no means perfect, but it gives somewhat reasonable results, and
this is enough initial work for people to play around with, I think.

NOTE! You need "asciidoc" installed to do this: it's a python program,
so it should be pretty easy even on non-Linux platforms.  And on Linux,
most distributions package it, so you just have to do something like

	yum install asciidoc

to get it (replace with apt-get/zypper/whatever).

Asciidoc can generate other output too (man-pages, LaTeX, etc), maybe
people want to play with that part too.

Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
  • Loading branch information
torvalds committed Jan 1, 2012
1 parent 1d51c77 commit 1a83bf4
Show file tree
Hide file tree
Showing 3 changed files with 287 additions and 221 deletions.
10 changes: 10 additions & 0 deletions Documentation/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
ASCIIDOC=asciidoc
BROWSER=firefox

doc: user-manual.html

show: user-manual.html
$(BROWSER) user-manual.html

user-manual.html: user-manual.txt
$(ASCIIDOC) user-manual.txt
Loading

0 comments on commit 1a83bf4

Please sign in to comment.