This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
uname -r works on MINIX as well
[metaconfig.git] / README
diff --git a/README b/README
index b6e7e95..3497d96 100644 (file)
--- a/README
+++ b/README
@@ -19,7 +19,7 @@ back here.
 Contents of this directory:
 
     README:    This file.
-    U:         Metaconfig units used for buliding Perl's Configure
+    U:         Metaconfig units used for building Perl's Configure
     U.check:   Sample directory used for testing new metaconfig units.
                see U.check/README for more information.
     dist-3.5-20:
@@ -37,12 +37,12 @@ Contents of this directory:
     in your $PATH.
     The dist version used for perl is dist-3.5-20 in this directory, which is
     a slightly modified version of the original, which you can get at the SVN
-    repository https://dist.svn.sourceforge.net/svnroot/dist/trunk. If you'd
-    like to keep up to date with changes in dist, you can either use svn or
-    git to create your own clone. For git, that would be something like:
+    repository https://svn.code.sf.net/p/dist/code/trunk/dist. If you'd like
+    to keep up to date with changes in dist, you can either use svn or git to
+    create your own clone. For git, that would be something like:
 
     $ git svn clone \
-      http://dist.svn.sourceforge.net/svnroot/dist/trunk/dist \
+      svn://svn.code.sf.net/p/dist/code/trunk/dist \
       dist-svn
 
     Unsurprisingly 'dist' uses (its) Configure to generate itself:
@@ -54,7 +54,7 @@ Contents of this directory:
     $ make install
 
     After make install, remove lib/U/d_debugging.U in your target lib, as perl
-    uses it's own way to set/define debugging (see INSTALL)
+    uses its own way to set/define debugging (see INSTALL)
 
     the dist-3.5-20 installation as used by Merijn is available on his CPAN as
     perl-meta-3.5-20.tgz
@@ -87,7 +87,7 @@ Contents of this directory:
        }
     -->8---
 
-    I also added the foirst two lines of that patch to mlint
+    I also added the first two lines of that patch to mlint
 
 (b) You need to be in a/the Perl directory, i.e. either something from
     //depot/perl/... or one of its branches
@@ -107,7 +107,7 @@ Contents of this directory:
     of metalint are usually serious :-) and need fixing
 
     Exceptions are lots of
-      Your private U/modified/voidflags.U overrides the public one.
+      Your private U/modified/issymlink.U overrides the public one.
     due to the perl special units
 
     an alias to something like
@@ -157,7 +157,24 @@ Contents of this directory:
     you see fit.
     You can skip this phase, it's not essential, just good housekeeping.
 
-(k) make veryclean; sh Configure -des -Dusedevel; make all test
+(k) Run the perl build chain
+
+    make veryclean
+    sh ./Configure -des -Dusedevel
+
+    The dependency for uconfig.h isn't carved in stone, so you might
+    need to regenerate it
+
+    perl regen/uconfig_h.pl
+
+    Then make and make test or make test_harness (with TEST_JOBS=5)
+
+    make all test_harness
+
+    Before you start committing, make sure that the other developers
+    are happy and run
+
+    make test_porting
 
 -- the next steps are in the metaconfig folder again