This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
README: Add instrs for modified units
authorKarl Williamson <khw@cpan.org>
Fri, 21 Aug 2020 20:30:34 +0000 (14:30 -0600)
committerKarl Williamson <khw@cpan.org>
Fri, 21 Aug 2020 20:34:31 +0000 (14:34 -0600)
README

diff --git a/README b/README
index 9ea3cc6..50bd662 100644 (file)
--- a/README
+++ b/README
@@ -17,9 +17,9 @@ You have presumably obtained the metaconfig from the repository e.g.
 
 When working with metaconfig you will generally have two git checkouts
 next to each other:  (1) this metaconfig checkout; and (2) a checkout of
-the Perl 5 source code in which you will generate a new Configure
-script. In this README, we will refer to these directories as the
-'metaconfig' directory and the 'perl' directory.
+the Perl source code in which you will generate a new Configure script. In this
+README, we will refer to these directories as the 'metaconfig' directory and
+the 'perl' directory.
 
 Since these two directories are normally next to each other, so ../perl
 will get you to perl and ../perl/../metaconfig will get you back here.
@@ -110,16 +110,18 @@ Development workflow:
         ln -s MANIFEST MANIFEST.new
         chmod +w Configure config_h.SH Porting/Glossary Porting/config*
 
-(c) Create a new file for the new unit as U/foo/d_bar.U
-    ('foo' is one of the existing folders in U except for 'all'.  It most
-    likely will be 'perl', but it could also be 'modified', 'compline' or any
-    other existing folder).  Choose the best appropriate subdir of U.  See
-    U/README for a description of the various subdirectories.)  You should
-    choose the closest existing unit file as a starting point, and first copy
-    it to the new file.  For example, the unit for seeing if strtold_l() exists
-    was created as U/threads/d_strtold_l.U, copied from perl/d_strtold.U, then
-    adjusted.  It goes under 'threads' because it is used only on threaded
-    perls.
+(c) Create a new file for the unit as U/foo/d_bar.U
+    ('foo' is one of the existing folders in U except for 'all'.  If you are
+    modifying a unit already in dist, simply copy the dist version to
+    'modified' as a starting point.  Otherwise, create a new file in one of the
+    other directories.  It most likely will be 'perl', but it could also be
+    'compline' or any other existing folder).  Choose the best appropriate
+    subdir of U.  See U/README for a description of the various subdirectories.
+    You should choose the closest existing unit file as a starting point, and
+    first copy it to the new file.  For example, the unit for seeing if
+    strtold_l() exists was created as U/threads/d_strtold_l.U, copied from
+    perl/d_strtold.U, then adjusted.  It goes under 'threads' because it is
+    used only on threaded perls.
 
 (d) Run "mlint -O" to see nits: as opposed to lint, the gripings of mlint
     are usually serious and need fixing