commit: 209c60e0929ac4133fbeb3883a99285a08ba5d1b
parent 88f3b52c352651ad8e10b61d5802f8531dcb4869
Author: fosslinux <fosslinux@aussies.space>
Date: Sat, 6 Feb 2021 10:12:42 +1100
Various README fixes
- fix a couple of typos
- flex 2.6.4 clarity
- add colons to part numbers
- textwrap to 80
Diffstat:
| M | README.md | 64 | +++++++++++++++++++++++++++++++++++++--------------------------- |
1 file changed, 37 insertions(+), 27 deletions(-)
diff --git a/README.md b/README.md
@@ -235,15 +235,19 @@ preferred where we can use it, and makes source code sizes smaller.
#### Part 17: coreutils 5.0.0
-GNU Coreutils is a collection of widely used utilities such as `cat`, `chmod`, `chown`,
-`cp`, `install`, `ln`, `ls`, `mkdir`, `mknod`, `mv`, `rm`, `rmdir`, `tee`, `test`, `true`, and many others.
+GNU Coreutils is a collection of widely used utilities such as `cat`, `chmod`,
+`chown`, `cp`, `install`, `ln`, `ls`, `mkdir`, `mknod`, `mv`, `rm`, `rmdir`,
+`tee`, `test`, `true`, and many others.
-A few of the utilities cannot be easily compiled with Mes C library, so we skip them.
+A few of the utilities cannot be easily compiled with Mes C library, so we skip
+them.
#### Part 18: heirloom devtools
+
`lex` and `yacc` from the Heirloom project. The Heirloom project is a collection
-of standard UNIX utilities derived from code by Caldera and Sun. Differently from
-the analogous utilities from the GNU project, they can be compiled with a simple `Makefile`.
+of standard UNIX utilities derived from code by Caldera and Sun. Differently
+from the analogous utilities from the GNU project, they can be compiled with a
+simple `Makefile`.
#### Part 19: bash 2.05b
@@ -257,40 +261,46 @@ cope here.
#### Part 20: m4 1.4.4
-`m4` is the first piece of software we need in the autotools suite and flex 2.6.4.
-It allows macros to be defined and files to be generated from those macros.
+`m4` is the first piece of software we need in the autotools suite and flex
+2.6.4. It allows macros to be defined and files to be generated from those
+macros.
#### Part 21: flex 2.5.11
-`flex` is a tool for generating lexers or scanners: programs that recognize lexical patters.
+`flex` is a tool for generating lexers or scanners: programs that recognize
+lexical patters.
Unfortunately `flex` also depends on itself for compiling its own scanner, so
-first flex 2.5.11 is compiled, with its scanner definition manually modified so that
-it can be processed by lex for the Heirloom project (the required modifications
-are mostly syntactical, plus a few workarounds to avoid some flex advanced features).
+first flex 2.5.11 is compiled, with its scanner definition manually modified so
+that it can be processed by lex for the Heirloom project (the required
+modifications are mostly syntactical, plus a few workarounds to avoid some flex
+advanced features).
-#### Part 22 musl 1.1.24
+#### Part 22: musl 1.1.24
-`musl` is a C standard library that is lightweight, fast, simple, free, and strives to be correct
-in the sense of standards-conformance and safety. `musl` is used by some distributions of GNU/Linux
-as their C library. Our previous Mes C library was incomplete which prevented us from building many
-newer or more complex programs.
+`musl` is a C standard library that is lightweight, fast, simple, free, and
+strives to be correct in the sense of standards-conformance and safety. `musl`
+is used by some distributions of GNU/Linux as their C library. Our previous Mes
+C library was incomplete which prevented us from building many newer or more
+complex programs.
-`tcc` has slight problems when building and linking `musl`, so we apply a few patches. In particular,
-we replace all weak symbols with strong symbols and will patch `tcc` in the next step to ignore duplicate
-symbols.
+`tcc` has slight problems when building and linking `musl`, so we apply a few
+patches. In particular, we replace all weak symbols with strong symbols and will
+patch `tcc` in the next step to ignore duplicate symbols.
-#### Part 23 tcc 0.9.27 (musl)
+#### Part 23: tcc 0.9.27 (musl)
-We recompile `tcc` against musl. This is a two stage process. First we build tcc-0.9.27 that itself
-links to Mes C library but produces binaries linked to musl. Then we recompile newly produced tcc
-with itself. Interestingly, tcc-0.9.27 linked against musl is self hosting.
+We recompile `tcc` against musl. This is a two stage process. First we build
+tcc-0.9.27 that itself links to Mes C library but produces binaries linked to
+musl. Then we recompile newly produced tcc with itself. Interestingly,
+tcc-0.9.27 linked against musl is self hosting.
-#### Part 24 flex 2.6.14
+#### Part 24: flex 2.6.14
-We recompile unpatched GNU `flex` using older flex 2.5.11. This is again two stage process,
-first compile flex using scanner generated by old flex, then recompile scan.l using the new version
-of flex to remove any buggy artificats from the old flex.
+We recompile unpatched GNU `flex` using older flex 2.5.11. This is again a two
+stage process, first compiling flex using `scan.c` (from `scan.l`) created by
+old flex, then recompile `scan.c` using the new version of flex to remove any
+buggy artifacts from the old flex.
#### Part 25: grep 2.4
