aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Mynott <steve.mynott@gmail.com>2017-07-24 11:51:31 +0100
committerSteve Mynott <steve.mynott@gmail.com>2017-07-24 15:15:30 +0100
commiteb441c1b54505bfd59351ecde6d2afdf4b1ab3e3 (patch)
tree080bc5217b74fdef828cec49d62039ead905e21d
parent60e4f01d42a9ca4709dff02f126a305da3e05ae5 (diff)
document last min fix process
-rw-r--r--tools/star/Makefile9
-rw-r--r--tools/star/lastmin-fixes.txt37
2 files changed, 42 insertions, 4 deletions
diff --git a/tools/star/Makefile b/tools/star/Makefile
index dcc2de7..b5959ab 100644
--- a/tools/star/Makefile
+++ b/tools/star/Makefile
@@ -1,8 +1,9 @@
+# Usually these exist as tarballs existing on the FTP site(s)
+# eg. 2017.07 etc.
+# Occasionally (mis-)used to pull in fixes (see 'lastmin-fixes.txt')
+# eg. 2017.07-9-gc0abee7 etc.
RAKUDO_VER = 2017.07
-# XXX Work around
-# note neither of the following two tarballs exist on the FTP site(s)
-# manually create under src/
-NQP_VER = 2017.07
+NQP_VER = 2017.07-9-gc0abee7
MOAR_VER = 2017.07
STAR_REL = rakudo-star-$(VERSION)
diff --git a/tools/star/lastmin-fixes.txt b/tools/star/lastmin-fixes.txt
new file mode 100644
index 0000000..bdbc2e6
--- /dev/null
+++ b/tools/star/lastmin-fixes.txt
@@ -0,0 +1,37 @@
+"Last Minute Fixes”
+~~~~~~~~~~~~~~~~~~
+This process should be used sparingly, under protest and eventually be replaced
+by something better.
+
+The Problem
+~~~~~~~~~~~
+Conventionally Rakudo Star is built from monthly release tarballs of rakudo,
+nqp and moarvm which are named as YYYY.MM. Inevitably these sometimes contain
+bugs. Serious bugs are fixed in further releases of the components named as
+YYYY.MM.N where N is a (hopefully low) number.
+
+Sometimes less serious bugs exist which are fixed in git shortly after the
+release but aren’t officially released as tarballs. It’s useful for some of
+these fixes to get pulled into Rakudo Star since it has a life longer than that
+of the monthly releases.
+
+A Solution
+~~~~~~~~~~
+In Rakudo Star ship tarballs based on git checkouts which are close to the
+official release but which contain extra fixes.
+
+Example
+~~~~~~~
+Replace nqp 2017.07 by nqp 2017.07-9-gc0abee7 to include --ll-exception fix in c0abee7953ac7d6f090ccf4a762f6de5fc85ca70
+
+Edit ‘tools/star/Makefile’ setting NQP_VER as 2017.07-9-gc0abee7
+
+(From R* git checkout root)
+% mkdir src && cd src
+% git clone https://github.com/perl6/nqp.git && cd nqp
+% git checkout c0abee && echo MANIFEST >MANIFEST && git ls-files >>MANIFEST
+% rm -rf .git && echo 2017.07-9-gc0abee7 > VERSION && cd ..
+% tar cvfz nqp-2017.07-9-gc0abee7.tar.gz nqp && rm -rf nqp
+
+You can then proceed from the usual “make -f tools/star/Makefile” step in the release guide.
+