Improvements to the build system.

* Add `install`/`uninstall` targets.
* Less hacky release archive creation.
* Apply some DRY throughout.
* Don't use the `sdb` script to run tests.

Author: Alex Rønne Petersen

.gitignore

@@ -1,5 +1,6 @@
 bin/*
 dep/*
+rel/*
 
 *.dll
 *.exe

Makefile

@@ -29,9 +29,11 @@ CP ?= cp
 ECHO ?= echo
 FSHARPC ?= fsharpc
 GENDARME ?= gendarme
+INSTALL ?= install
 MCS ?= mcs
 MKDIR ?= mkdir
 PKG_CONFIG ?= pkg-config
+PREFIX ?= /usr/local
 SED ?= sed
 TAR ?= tar
 XBUILD ?= xbuild
@@ -47,7 +49,6 @@ ifeq ($(MODE), Debug)
 	MCS_FLAGS += -debug
 else
 	override xb_mode = net_4_0_Release
-	override mono_opt =
 
 	FSHARPC_FLAGS += --optimize
 	MCS_FLAGS += -optimize
@@ -56,19 +57,18 @@ endif
 FSHARPC_FLAGS += --nologo --warnaserror
 GENDARME_FLAGS += --severity all --confidence all
 MCS_FLAGS += -langversion:experimental -unsafe -warnaserror
-XBUILD_FLAGS += /verbosity:quiet /property:Configuration=$(xb_mode)
+XBUILD_FLAGS += /nologo /property:Configuration=$(xb_mode) /verbosity:quiet
 
 FSHARPC_TEST_FLAGS += --debug+ --nologo --warnaserror
 MCS_TEST_FLAGS += -debug -langversion:experimental -unsafe -warnaserror
 
-.PHONY: all check clean clean-check clean-deps gendarme update-deps
+.PHONY: all check clean clean-check clean-deps clean-release gendarme install release uninstall update-deps
 
 override results = \
-	LICENSE \
-	README \
 	sdb.exe \
 	sdb.exe.config \
-	sdb
+	sdb \
+	sdb-dev
 
 all: $(addprefix bin/, $(results))
 
@@ -104,7 +104,7 @@ override tests = \
 	$(addprefix chk/fs/, $(addsuffix .mdb, $(fs_tests)))
 
 check: chk/check.exe $(addprefix bin/, $(results)) $(tests)
-	$(CD) chk && MONO_PATH=. $(MONO_PREFIX)/bin/mono check.exe
+	$(CD) chk && MONO_PATH=. $(MONO_PREFIX)/bin/mono $(notdir $<)
 
 clean:
 	$(RM) -r bin
@@ -116,9 +116,40 @@ clean-check:
 clean-deps:
 	$(CD) dep/debugger-libs && $(XBUILD) $(XBUILD_FLAGS) /target:Clean
 
+clean-release:
+	$(RM) -r rel
+
 gendarme: bin/sdb.exe
 	$(GENDARME) $(GENDARME_FLAGS) --log bin/sdb.log $<
 
+install: $(addprefix bin/, $(results))
+	$(INSTALL) -m755 -d $(PREFIX)/lib/sdb
+	$(INSTALL) -m755 bin/ICSharpCode.NRefactory.dll $(PREFIX)/lib/sdb
+	$(INSTALL) -m755 bin/ICSharpCode.NRefactory.CSharp.dll $(PREFIX)/lib/sdb
+	$(INSTALL) -m755 bin/Mono.Cecil.dll $(PREFIX)/lib/sdb
+	$(INSTALL) -m755 bin/Mono.Cecil.Mdb.dll $(PREFIX)/lib/sdb
+	$(INSTALL) -m755 bin/Mono.Debugger.Soft.dll $(PREFIX)/lib/sdb
+	$(INSTALL) -m755 bin/Mono.Debugging.dll $(PREFIX)/lib/sdb
+	$(INSTALL) -m755 bin/Mono.Debugging.Soft.dll $(PREFIX)/lib/sdb
+	$(INSTALL) -m755 bin/sdb.exe $(PREFIX)/lib/sdb
+	$(INSTALL) -m755 bin/sdb.exe.config $(PREFIX)/lib/sdb
+	$(INSTALL) -m755 -d $(PREFIX)/bin
+	$(INSTALL) -m755 bin/sdb $(PREFIX)/bin
+
+release: rel/sdb.tar.gz
+
+uninstall:
+	$(RM) $(PREFIX)/lib/sdb/ICSharpCode.NRefactory.dll
+	$(RM) $(PREFIX)/lib/sdb/ICSharpCode.NRefactory.CSharp.dll
+	$(RM) $(PREFIX)/lib/sdb/Mono.Cecil.dll
+	$(RM) $(PREFIX)/lib/sdb/Mono.Cecil.Mdb.dll
+	$(RM) $(PREFIX)/lib/sdb/Mono.Debugger.Soft.dll
+	$(RM) $(PREFIX)/lib/sdb/Mono.Debugging.dll
+	$(RM) $(PREFIX)/lib/sdb/Mono.Debugging.Soft.dll
+	$(RM) $(PREFIX)/lib/sdb/sdb.exe
+	$(RM) $(PREFIX)/lib/sdb/sdb.exe.config
+	$(RM) $(PREFIX)/bin/sdb
+
 override refs = \
 	ICSharpCode.NRefactory.dll \
 	ICSharpCode.NRefactory.CSharp.dll \
@@ -196,32 +227,38 @@ override srcs = \
 	src/State.cs \
 	src/Utilities.cs
 
-bin/sdb.exe: $(srcs) $(addprefix bin/, $(refs)) mono.snk
-	$(MCS) $(MCS_FLAGS) -keyfile:mono.snk -lib:bin -out:bin/sdb.exe -target:exe -r:Mono.Posix $(addprefix -r:, $(refs)) $(srcs)
+bin/sdb.exe: mono.snk $(srcs) $(addprefix bin/, $(refs))
+	$(MCS) $(MCS_FLAGS) -keyfile:$< -lib:bin -out:$@ -target:exe -r:Mono.Posix $(addprefix -r:, $(refs)) $(srcs)
 
 bin/sdb.exe.config: sdb.exe.config
 	$(MKDIR) -p bin
 	$(CP) $< $@
 
 bin/sdb: sdb.in
 	$(MKDIR) -p bin
-	$(SED) s/__MONO_OPTIONS__/$(mono_opt)/ $< > $@
+	$(SED) -e s+__LIB_PATH_EXTRA__+/../lib/sdb+ -e s+__MONO_OPTIONS_EXTRA__+$(mono_opt)+ $< > $@
 	$(CHMOD) +x $@
 
-bin/LICENSE: LICENSE
+bin/sdb-dev: sdb.in
 	$(MKDIR) -p bin
-	$(CP) $< $@
-
-bin/README: README.md
-	$(MKDIR) -p bin
-	$(CP) $< $@
+	$(SED) -e s+__LIB_PATH_EXTRA__++ -e s+__MONO_OPTIONS_EXTRA__+$(mono_opt)+ $< > $@
+	$(CHMOD) +x $@
 
 chk/check.exe: chk/check.fs mono.snk
-	$(FSHARPC) $(FSHARPC_FLAGS) --keyfile:mono.snk --out:$@ --target:exe chk/check.fs
+	$(FSHARPC) $(FSHARPC_FLAGS) --keyfile:mono.snk --out:$@ --target:exe $<
 
-sdb.tar.gz: $(addprefix bin/, $(results))
-	$(RM) sdb.tar.gz
-	$(CD) bin && $(TAR) -zcf ../sdb.tar.gz $(results) $(refs)
+override artifacts = \
+	README.md \
+	LICENSE \
+	$(addprefix bin/, $(refs)) \
+	bin/sdb.exe \
+	bin/sdb.exe.config
+
+rel/sdb.tar.gz: sdb.in $(artifacts)
+	$(MKDIR) -p rel
+	$(CP) $(artifacts) rel
+	$(CP) bin/sdb-dev rel/sdb
+	$(CD) rel && $(TAR) -zcf $(notdir $@) $(notdir $(artifacts)) sdb
 
 update-deps:
 	$(ECHO) "/* DO NOT EDIT - OVERWRITTEN BY MAKEFILE */\n" > src/Options.cs

README.md

@@ -12,20 +12,24 @@ installed Mono framework.
 
 First, clone the submodules:
 
-	$ git submodule update --init --recursive
+    $ git submodule update --init --recursive
 
 To build, run:
 
     $ make
 
-This compiles SDB and its dependencies, and puts everything in the `bin`
-directory. This directory can be moved around freely; when executed, the `sdb`
-script will set up the environment so all the dependency assemblies are found.
+If the build succeeds, you can install SDB with:
 
-You could, for example, just add the `bin` directory to your `PATH`:
+    $ make install
+
+(You may need to invoke it with `sudo` or some such command.)
+
+You can also run SDB from within the build directory by appending it to `PATH`
+and invoking `sdb-dev`. This is mainly intended for development of SDB itself.
+An example:
 
     $ export PATH=`pwd`/bin:$PATH
-    $ sdb
+    $ sdb-dev
     Welcome to the Mono soft debugger (sdb 1.0.5058.39468)
     Type 'help' for a list of commands or 'quit' to exit
 
@@ -35,10 +39,9 @@ You can run the SDB test suite with:
 
     $ make check
 
-It's generally a good idea to do that to ensure that SDB works correctly on
-your system before you start using it.
+(This requires an F# installation.)
 
-The following variables can be set in your environment or on the Make command
+The following variables can be set in your environment or on the `make` command
 line to affect the build:
 
 * `CAT`: Path to the `cat` POSIX utility.
@@ -51,24 +54,24 @@ line to affect the build:
 * `FSHARPC_TEST_FLAGS`: Flags to pass to the F# compiler for tests.
 * `GENDARME`: Which Gendarme executable to use (optional).
 * `GENDARME_FLAGS`: Flags to pass to Gendarme.
+* `INSTALL`: Path to the `install` POSIX utility.
 * `MCS`: Which C# compiler executable to use.
 * `MCS_FLAGS`: Flags to pass to the C# compiler.
 * `MCS_TEST_FLAGS`: Flags to pass to the C# compiler for tests.
 * `MKDIR`: Path to the `mkdir` POSIX utility.
 * `PKG_CONFIG`: Path to the `pkg-config` utility.
+* `RM`: Path to the `rm` POSIX utility.
 * `SED`: Path to the `sed` POSIX utility.
 * `TAR`: Path to the `tar` POSIX utility.
 * `XBUILD`: Which XBuild executable to use.
 * `XBUILD_FLAGS`: Flags to pass to XBuild.
 
-Note that the F# tools are only necessary to run the test suite. Gendarme is
-also optional and is mostly used by the SDB developers. `tar` is also only used
-to package SDB releases.
-
 Additionally, `MODE` can be set to `Debug` (default) or `Release` to indicate
-the kind of build desired.
+the kind of build desired. `PREFIX` can be set to specify the path that the
+`install` and `uninstall` targets should operate within (defaults to
+`/usr/local`).
 
-Finally, `MONO_PREFIX` and `MONO_BINARY` can be set to tell the test runner
+Finally, `MONO_PREFIX` and `MONO_BINARY` can be set to tell the `check` target
 which Mono executable should be used. See the description of `RuntimePrefix`
 and `RuntimeExecutable` further down for more information.
 
@@ -247,7 +250,8 @@ that is tagged with `CommandAttribute` will be instantiated at startup time and
 put into the root command list.
 
 For SDB to find custom commands, they should be compiled into `.dll` assemblies
-and put in `~/.sdb` (or some other directory specified in `SDB_PATH`).
+and put in `~/.sdb` (or some other directory specified in `SDB_PATH`). Plugin
+assemblies can also be loaded manually with the `plugin` command.
 
 Here's an example of compiling and using a test plugin:
 
@@ -282,7 +286,7 @@ Here's an example of compiling and using a test plugin:
             Log.Info("Hello! I received: {0}", args);
         }
     }
-    $ mcs -debug -t:library test.cs -r:`which sdb`.exe -out:$HOME/.sdb/test.dll
+    $ mcs -debug -t:library test.cs -r:$(dirname $(which sdb))/../lib/sdb/sdb.exe -out:$HOME/.sdb/test.dll
     $ sdb
     Welcome to the Mono soft debugger (sdb 1.0.5061.14716)
     Type 'help' for a list of commands or 'quit' to exit
@@ -295,3 +299,6 @@ Here's an example of compiling and using a test plugin:
 
     (sdb) mycmd foo bar baz
     Hello! I received: foo bar baz
+
+You can look at SDB's own command classes for some examples of things that you
+can do in your commands.

chk/check.fs

@@ -63,7 +63,7 @@ let runTest () =
     Console.WriteLine("{0} {1} {0}", delim, testName)
     Console.WriteLine()
 
-    let psi = ProcessStartInfo(Path.Combine("..", "bin", "sdb"),
+    let psi = ProcessStartInfo(Path.Combine("..", "bin", "sdb.exe"),
                                Arguments = testArgs,
                                CreateNoWindow = true,
                                RedirectStandardError = true,

sdb.in

@@ -1,2 +1,5 @@
 #!/usr/bin/env bash
-MONO_PATH=`dirname $0`:$MONO_PATH exec "`which mono`" __MONO_OPTIONS__ $MONO_OPTIONS `dirname $0`/sdb.exe "$@"
+MONO_PATH="`dirname $0`__LIB_PATH_EXTRA__:$MONO_PATH" \
+	exec "`which mono`" __MONO_OPTIONS_EXTRA__ $MONO_OPTIONS \
+	"`dirname $0`__LIB_PATH_EXTRA__/sdb.exe" \
+	"$@"