mail[Wesnoth-commits] r25242 - in /trunk: INSTALL SConstruct


Others Months | Index by Date | Thread Index
>>   [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Header


Content

Posted by esr on March 28, 2008 - 16:18:
Author: esr
Date: Fri Mar 28 16:18:17 2008
New Revision: 25242

URL: http://svn.gna.org/viewcvs/wesnoth?rev=25242&view=rev
Log:
Improved documentation for scons usage.

Modified:
    trunk/INSTALL
    trunk/SConstruct

Modified: trunk/INSTALL
URL: 
http://svn.gna.org/viewcvs/wesnoth/trunk/INSTALL?rev=25242&r1=25241&r2=25242&view=diff
==============================================================================
--- trunk/INSTALL (original)
+++ trunk/INSTALL Fri Mar 28 16:18:17 2008
@@ -58,6 +58,14 @@
 and its data.  The prefix defaults to /usr/local; for production builds
 you may want to set prefix=/usr.
 
+The target 'all' is equivalent to 'wesnoth wesnoth_editor cutter
+exploder wmllint wmlscope wmlindent'; it is the default.  
+
+So, for example, this builds game, editor, tools, and campaign server,
+enabling debugging on all:
+
+    scons debug=yes all campaignd 
+
 To build wesnothd:
 
    scons server_uid=<user> server_group=<group> wesnothd
@@ -73,6 +81,10 @@
 If you want to install several versions of wesnoth you should use the
 prefsdir= parameter to get distinct preferences directories.  The
 default is '.wesnoth'.
+
+Installation productions 'install', 'install-wesnothd' and
+'install-campaignd' are available.  A plain 'install' installs
+all client-side tools.
 
 Notes on the deprecated autotools build:
 

Modified: trunk/SConstruct
URL: 
http://svn.gna.org/viewcvs/wesnoth/trunk/SConstruct?rev=25242&r1=25241&r2=25242&view=diff
==============================================================================
--- trunk/SConstruct (original)
+++ trunk/SConstruct Fri Mar 28 16:18:17 2008
@@ -45,19 +45,28 @@
 
 env = Environment(options = opts)
 
-Help("""\
-Available build targets include:
-
-    wesnoth wesnoth_editor wesnothd campaignd exploder cutter
-    all = all installables
-    test = unit test binary (not an installable)
+Help("""Arguments may be a mixture of switches and targets an any order.
+Switches apply to the entire build regrdless of where they are in the order.
+Important switches include:
+
+    prefix=/usr     probably what you want for production tools
+    debug=yes       enable compiler and linker debugging switches
+
+Available build targets include the individual binaries:
+
+    wesnoth wesnoth_editor wesnothd campaignd exploder cutter test
+
+The following special build targets
+
+    all = same as 'wesnoth wesnoth_editor exploder cutter'.
     TAGS = build tags for Emacs (cleaned by 'scons -c all').
-    install = install all executables and tools
-    install-wesnothd = install the Wesnoth multiplayer server
-    install-campaignd = install the Wesnoth campaign server
-    uninstall = uninstall all executables, tools, and servers
-    wesnoth.tgz = make compressed distribution tarball
-    sanity_check = run a pre-release sanity check on the distrivution
+    install = install 'all' executables, also wmlscope/wmllint/wmlindent.
+    install-wesnothd = install the Wesnoth multiplayer server.
+    install-campaignd = install the Wesnoth campaign server.
+    uninstall = uninstall all executables, tools, and servers.
+    wesnoth.tar.bz2 = make distribution tarball (cleaned by 'scons -c all').
+    sanity-check = run a pre-release sanity check on the distribution.
+    manual.en.html = HTML version of the English-language manual.
 
 """ + opts.GenerateHelpText(env))
 
@@ -850,6 +859,14 @@
 env.Precious(uninstall)
 
 #
+# Making the manual
+#
+env.Command("manual.en.xml", "doc/manual/manual.txt",
+       "asciidoc -b docbook -d book -n -a toc -o ${TARGET} ${SOURCE}")
+env.Command("manual.en.html", "manual.en.xml",
+       'xsltproc --nonet /etc/asciidoc/docbook-xsl/xhtml.xsl "${SOURCE}" 
"${TARGET}"')
+
+#
 # Making a distribution.
 #
 def manifest():
@@ -865,15 +882,17 @@
     # filenames with tildes in them (Emacs backup files) just in case.
     lst.append("data/")
     return lst
-env.Tar('wesnoth.tgz', manifest())
-env.Append(TARFLAGS='-z --exclude=".svn" --exclude="~"',
+tarball = env.Tar('wesnoth.tar.bz2', manifest())
+env.Append(TARFLAGS='-j --exclude=".svn" --exclude="~"',
            TARCOMSTR="Making tarball...")
+env.Clean(all, 'wesnoth.tar.bz2')
+env.Alias('dist', tarball)
 
 #
 # Sanity checking
 #
-sanity_check = env.Command('sanity_check', '', [
-    Action("cd utils; ./sanity_check"),
+sanity_check = env.Command('sanity-check', '', [
+    Action("cd utils; ./sanity-check"),
     Action("cd data/tools; make sanity-check"),
     ])
 env.AlwaysBuild(sanity_check)




Related Messages


Powered by MHonArc, Updated Fri Mar 28 16:22:07 2008