changeset 7515:ceed5f8c4ebf

Document how HTML documentation is built under Windows
author Patrick Mezard <pmezard@gmail.com>
date Sat, 17 Jan 2009 15:15:26 +0100
parents 25ac72ca68f6
children 876de22b70b8 09b44d87dd28
files contrib/win32/win32-build.txt doc/Makefile
diffstat 2 files changed, 17 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/contrib/win32/win32-build.txt	Thu Jan 15 14:19:29 2009 +0100
+++ b/contrib/win32/win32-build.txt	Sat Jan 17 15:15:26 2009 +0100
@@ -27,6 +27,9 @@
   add_path (you need only add_path.exe in the zip file)
       http://www.barisione.org/apps.html#add_path
 
+  Asciidoc - optional
+      http://www.methods.co.nz/asciidoc/
+
 And, of course, Mercurial itself.
 
 Once you have all this installed and built, clone a copy of the
@@ -51,6 +54,14 @@
 
 Copy mfc71.dll and add_path.exe into the dist directory that just got created.
 
+Before building the installer, you have to build Mercurial HTML documentation 
+(or fix mercurial.iss to not reference the doc directory). Assuming you have an
+"asciidoc.bat" batch file somewhere in your PATH:
+
+  cd doc
+  mingw32-make ASCIIDOC=asciidoc.bat html
+  cd ..
+
 If you use ISTool, you open the C:\hg\hg-release\contrib\win32\mercurial.iss
 file and type Ctrl-F9 to compile the installer file.
 
@@ -66,6 +77,9 @@
   echo [build] > setup.cfg
   echo compiler=mingw32 >> setup.cfg
   python setup.py py2exe -b 1
+  cd doc
+  mingw32-make ASCIIDOC=asciidoc.bat html
+  cd ..
   iscc contrib\win32\mercurial.iss
 
 and run it from the root of the hg repository (c:\hg\hg-release).
--- a/doc/Makefile	Thu Jan 15 14:19:29 2009 +0100
+++ b/doc/Makefile	Sat Jan 17 15:15:26 2009 +0100
@@ -5,6 +5,7 @@
 MANDIR=$(PREFIX)/share/man
 INSTALL=install -c
 PYTHON=python
+ASCIIDOC=asciidoc
 
 all: man html
 
@@ -24,10 +25,10 @@
 	mv $*~ $*
 
 %.xml: %.txt
-	asciidoc -d manpage -b docbook $*.txt
+	$(ASCIIDOC) -d manpage -b docbook $*.txt
 
 %.html: %.txt
-	asciidoc -b html4 $*.txt || asciidoc -b html $*.txt
+	$(ASCIIDOC) -b html4 $*.txt || $(ASCIIDOC) -b html $*.txt
 
 MANIFEST: man html
 	# tracked files are already in the main MANIFEST