]> git.tdb.fi Git - builder.git/blobdiff - Readme.txt
Refactor transitive dependencies to work on all targets
[builder.git] / Readme.txt
index db18ed7359bb3a640c28172a7163cb776b339ef9..609bf7dadbadc0e076dfef953228d8bfc1d76642 100644 (file)
@@ -1,6 +1,6 @@
 Builder
-Copyright © 2006-2012 Mikkosoft Productions
-Version 2.0 readme
+Copyright © 2006-2022 Mikkosoft Productions
+Version 3.0 readme
 
 -------------------------------------------------------------------------------
 
@@ -34,23 +34,21 @@ builds, cross-compilation and pkg-config integration.
 
 2. Building Builder
 
-Builder is normally built using itself.  However, if you just downloaded the
-source and don't yet have a Builder binary, how is that possible?  To resolve
-this problem, there's a script called bootstrap.sh in the Builder main
-directory.  Before running it, make sure you have the following libraries
-available:
+Builder is normally built using itself.  This creates a conundrum if you just
+downloaded the source and don't yet have a Builder binary.  To resolve the
+problem, there's a script called bootstrap.sh in the Builder main directory.
+Before running it, make sure you have the following libraries available:
 
-MSP libraries: core datafile
+MSP libraries: core crypto datafile
 
 Others: sigc++-2.0
 
 You should be able to get the MSP libraries from the same place you got
 Builder itself from.  Since they are also normally built with Builder, the
 script will need to have their sources available.  By default, it will look at
-the parent directory of builder.  You can change this by setting the LIBPATH
-evironment variable for the script.  If everything goes well, the script will
-build a builder-stage1 binary and then proceed to build a normal version with
-it.
+the parent directory of builder.  You can change this with the --libpath
+parameter for the script.  If everything goes well, the script will build a
+builder-stage1 binary and then proceed to build a normal version with it.
 
 -------------------------------------------------------------------------------
 
@@ -236,9 +234,9 @@ install
 tarballs
   Depends on source tarballs of all packages.
 
-cmdline
-  This target is an internal representation of the command line.  Trying to
-  add it to the command line will cause Builder to abort.
+goals
+  Depends on all targets on the command line.  Trying to add this target to the
+  command line will cause Builder to abort due to a circular dependency.
 
 -------------------------------------------------------------------------------
 
@@ -435,9 +433,9 @@ library components from the same package:
 
   use "mylib_common";
 
-Libraries used in this way will always be linked in statically.  This can be
-useful in organizing code when multiple components in a package share a common
-part.
+This can be useful in organizing code when multiple components in a package
+share a common part.  If the used library is not specified to be installed,
+it will be linked statically.  
 
 Packages may want to offer optional features, for example to allow the user to
 choose whether to use a particular external library:
@@ -460,8 +458,8 @@ conditional statement may be used:
   };
 
 Any statements inside the conditional block are evaluated if the feature is
-enabled.  This can be negated with a !.  Conditionals can appear at the package
-level and may contain anything that the package statement can.
+enabled.  This can be negated with a !.  Conditionals can appear at package and
+component scopes and may contain anything that the enclosing statement can.
 
 When making cross-platform software, it's often necessary to use different
 libraries on different platforms.  Another kind of conditional can be used for
@@ -518,7 +516,7 @@ Read-only git access is available at git://git.tdb.fi/builder
 
 13. License
 
-Builder is copyright © 2006-2012  Mikko Rasa, Mikkosoft Productions
+Builder is copyright © 2006-2022  Mikko Rasa, Mikkosoft Productions
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by