summaryrefslogtreecommitdiffstats
path: root/doc/guide/Makefile
diff options
context:
space:
mode:
authorAlexander Bokovoy <abokovoy@redhat.com>2011-11-22 15:39:23 +0200
committerAlexander Bokovoy <abokovoy@redhat.com>2011-11-22 15:52:02 +0200
commitd09389ab6fe203ce93d1a68986ff93c8ad75a480 (patch)
treea9d7e4357eb7603c9394fa21b1190812354c819c /doc/guide/Makefile
parent17cc52a1541b8326e9a7b1146285fe9ff4171782 (diff)
downloadfreeipa.git-d09389ab6fe203ce93d1a68986ff93c8ad75a480.tar.gz
freeipa.git-d09389ab6fe203ce93d1a68986ff93c8ad75a480.tar.xz
freeipa.git-d09389ab6fe203ce93d1a68986ff93c8ad75a480.zip
Add "Extending FreeIPA" developer guide
"Extending FreeIPA" is a developer guide of FreeIPA core framework. Please make sure to improve the guide every time parts of the core framework are affected by your changes. This document ideally should correspond to the current state of the framework. The Guide is written using Emacs Org Mode but can be edited with any plain text editing tool. Emacs is only required to convert it to distribution formats like HTML and TXT. See guide/Makefile for building the guide and README for details of the build environment.
Diffstat (limited to 'doc/guide/Makefile')
-rw-r--r--doc/guide/Makefile36
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/guide/Makefile b/doc/guide/Makefile
new file mode 100644
index 00000000..2fc4af48
--- /dev/null
+++ b/doc/guide/Makefile
@@ -0,0 +1,36 @@
+FILE=guide.org
+XML=$(addsuffix .xml, $(basename $(FILE)))
+PDF=$(addsuffix .pdf, $(basename $(FILE)))
+TXT=$(addsuffix .txt, $(basename $(FILE)))
+HTML=$(addsuffix .html, $(basename $(FILE)))
+FO=$(addsuffix .fo, $(basename $(FILE)))
+
+all: $(PDF) $(TXT) $(HTML)
+ @echo Finished: $? are created
+
+plain: $(FILE)
+ @echo -n "Building HTML, Docbook, and plain text ..."
+ @emacs -batch -q --no-site-file -eval "(require 'org)" \
+ --visit $< -f org-export-as-html \
+ --visit $< -f org-export-as-docbook \
+ --visit $< -f org-export-as-ascii 2>/dev/null
+ @echo "done, see $(HTML), $(XML), $(TXT)"
+
+$(TXT): plain
+
+$(HTML): plain
+
+$(XML): plain
+
+$(FO): $(XML)
+ @xmlto --skip-validation fo $< 2>/dev/null
+
+$(PDF): $(FO)
+ @echo -n "Building PDF ... "
+ @fop -fo $< -pdf $@ -l en -a 2>/dev/null
+ @echo "done, see $(PDF)"
+
+.PHONY: clean
+
+clean:
+ @rm -f *.html *.txt *.xml *.fo *.pdf *~