From a3ebe8aa2b3bd19ec757706269fd7e15e5c9c55b Mon Sep 17 00:00:00 2001 From: David Bryant Date: Thu, 8 Dec 2022 17:23:07 -0600 Subject: [PATCH 1/7] Corrected capitalization of the package name. This was hard to do because some references appear to refer to the program itself, and not to the package. Corrected English idiom here and there. --- chapter08/ninja.xml | 24 ++++++++++++------------ chapter08/wheel.xml | 2 +- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/chapter08/ninja.xml b/chapter08/ninja.xml index 4f3a25e88..7c72b9598 100644 --- a/chapter08/ninja.xml +++ b/chapter08/ninja.xml @@ -36,10 +36,10 @@ - This section is not strictly required for LFS if not using - systemd. On the other hand, ninja associated to meson makes + This section is not strictly required when LFS does not use + systemd. On the other hand, Ninja, along with Meson, makes a powerful build system combination, - which is expected to be used more and more often. It is required for + which will probably be used more and more often. It is required for several packages in the BLFS book. @@ -49,12 +49,12 @@ Installation of Ninja - When run, ninja normally runs a maximum number of processes - in parallel. By default this is the number of cores on the system - plus two. In some cases this can overheat a CPU or run a system out - of memory. If run from the command line, passing a -jN parameter - will limit the number of parallel processes, but some packages - embed the execution of ninja and do not pass a -j parameter. + When run, ninja normally utilizes the greatest possible number of processes + in parallel. By default this is the number of cores on the system, + plus two. This may overheat the CPU, or make the system run out + of memory. When ninja is invoked from the command line, passing the -jN parameter + will limit the number of parallel processes. Some packages + embed the execution of ninja, and do not pass the -j parameter on to it. Using the optional procedure below allows a user to limit the number of parallel processes via an environment variable, @@ -64,8 +64,8 @@ will limit ninja to four parallel processes. - If desired, add the capability to use the environment variable - NINJAJOBS by running: + If desired, make ninja recognize the environment variable + NINJAJOBS by running the stream editor: sed -i '/int Guess/a \ int j = 0;\ @@ -84,7 +84,7 @@ --bootstrap - This parameter forces ninja to rebuild itself for the current + This parameter forces Ninja to rebuild itself for the current system. diff --git a/chapter08/wheel.xml b/chapter08/wheel.xml index 7ab14426a..57457dacc 100644 --- a/chapter08/wheel.xml +++ b/chapter08/wheel.xml @@ -128,7 +128,7 @@ wheel - is a utility to unpack, pack, or convert wheel packages + is a utility to unpack, pack, or convert wheel archives wheel From 3c07bb94887c2bed937289ade14ad208a87802a7 Mon Sep 17 00:00:00 2001 From: Xi Ruoyao Date: Fri, 9 Dec 2022 15:35:05 +0800 Subject: [PATCH 2/7] libtool: libldtl is for dynamic loading, not dynamic linking On wikipedia, "dlopen" redirects to "dynamic loading" and there is a specific warning: "Dynamically loaded library" redirects here. Not to be confused with dynamically linked library. --- chapter08/libtool.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/chapter08/libtool.xml b/chapter08/libtool.xml index 5f1d3c36d..d21d0b751 100644 --- a/chapter08/libtool.xml +++ b/chapter08/libtool.xml @@ -123,7 +123,7 @@ libltdl - Hides the various difficulties of opening dynamically linked libraries + Hides the various difficulties of opening dynamically loaded libraries libltdl From 30f5283fab13237eb27c9736dc45d697f1aa8daf Mon Sep 17 00:00:00 2001 From: Xi Ruoyao Date: Fri, 9 Dec 2022 15:38:15 +0800 Subject: [PATCH 3/7] python: style "libffi.so" correctly --- chapter08/python.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/chapter08/python.xml b/chapter08/python.xml index 5b80fa339..1ac1b538a 100644 --- a/chapter08/python.xml +++ b/chapter08/python.xml @@ -66,7 +66,7 @@ --with-system-ffi This switch enables linking against the system version of - libffi.so. + libffi.so. From 4640b37d9680598de7979b830c0c9dc05615d9cd Mon Sep 17 00:00:00 2001 From: Xi Ruoyao Date: Fri, 9 Dec 2022 15:40:14 +0800 Subject: [PATCH 4/7] ninja: style "ninja" (for the program) with Or the mix up of "ninja" and "Ninja" will seem puzzling... --- chapter08/ninja.xml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/chapter08/ninja.xml b/chapter08/ninja.xml index 7c72b9598..74626e30c 100644 --- a/chapter08/ninja.xml +++ b/chapter08/ninja.xml @@ -49,12 +49,12 @@ Installation of Ninja - When run, ninja normally utilizes the greatest possible number of processes - in parallel. By default this is the number of cores on the system, + When run, ninja normally utilizes the greatest + possible number of processes in parallel. By default this is the number of cores on the system, plus two. This may overheat the CPU, or make the system run out - of memory. When ninja is invoked from the command line, passing the -jN parameter + of memory. When ninja is invoked from the command line, passing the -jN parameter will limit the number of parallel processes. Some packages - embed the execution of ninja, and do not pass the -j parameter on to it. + embed the execution of ninja, and do not pass the -j parameter on to it. Using the optional procedure below allows a user to limit the number of parallel processes via an environment variable, @@ -62,9 +62,9 @@ export NINJAJOBS=4 - will limit ninja to four parallel processes. + will limit ninja to four parallel processes. - If desired, make ninja recognize the environment variable + If desired, make ninja recognize the environment variable NINJAJOBS by running the stream editor: sed -i '/int Guess/a \ From 02912947e8a276c61d192157406c7dfb63f048cf Mon Sep 17 00:00:00 2001 From: Xi Ruoyao Date: Fri, 9 Dec 2022 16:05:26 +0800 Subject: [PATCH 5/7] perl: use "MAJOR.MINOR" instead of "Major.Minor", and explain "patch level" We are already using "MAJOR" and "MINOR" in OpenSSL, do the same here. The semantic versioning documentation (https://semver.org/) always use "patch level", not "Patch level". But let's explain it a little to prevent puzzling people. --- chapter08/perl.xml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/chapter08/perl.xml b/chapter08/perl.xml index 112780c4a..b56e0e5e2 100644 --- a/chapter08/perl.xml +++ b/chapter08/perl.xml @@ -123,9 +123,10 @@ export BUILD_BZIP2=0 These settings define where Perl looks for installed modules. The LFS editors chose to put them in a directory structure - based on the Major.Minor version of Perl (&perl-version-min;) which - allows upgrading Perl to newer Patch levels (&perl-version;) without - reinstalling all of the modules. + based on the MAJOR.MINOR version of Perl (&perl-version-min;) which + allows upgrading Perl to newer patch levels (the patch level is + the last dot separated part in the full version string like + &perl-version;) without reinstalling all of the modules. From 75d64be391e2cc7dcffffd4f2af7fe61391dfcb2 Mon Sep 17 00:00:00 2001 From: David Bryant Date: Fri, 9 Dec 2022 14:27:24 -0600 Subject: [PATCH 6/7] Improve English idiom. Use the indicative mood. --- chapter08/meson.xml | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/chapter08/meson.xml b/chapter08/meson.xml index 0bde43856..1d9c9e3a7 100644 --- a/chapter08/meson.xml +++ b/chapter08/meson.xml @@ -23,7 +23,7 @@ - <para>Meson is an open source build system meant to be both extremely fast + <para>Meson is an open source build system designed to be both extremely fast and as user friendly as possible.</para> <segmentedlist> @@ -36,9 +36,10 @@ </segmentedlist> <tip revision="sysv"> - <para>This section is not strictly required for LFS if not using - systemd. On the other hand, meson/ninja is a powerful build system, - which is expected to be used more and more often. It is required for + <para>This section is not strictly required when LFS does not use + systemd. On the other hand, Meson, along with Ninja, makes + a powerful build system combination, + which will probably be used more and more often. It is required for several packages in <ulink url="&blfs-book;">the BLFS book</ulink>.</para> </tip> @@ -56,7 +57,7 @@ <screen><userinput remap="make">pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen> - <para>The test suite requires some packages out of the scope of LFS.</para> + <para>The test suite requires some packages outside the scope of LFS.</para> <para>Install the package:</para> @@ -70,7 +71,7 @@ install -vDm644 data/shell-completions/zsh/_meson /usr/share/zsh/site-functions/ <varlistentry> <term><parameter>-w dist</parameter></term> <listitem> - <para>Put the created wheels into the + <para>Puts the created wheels into the <filename class='directory'>dist</filename> directory.</para> </listitem> </varlistentry> @@ -78,7 +79,7 @@ install -vDm644 data/shell-completions/zsh/_meson /usr/share/zsh/site-functions/ <varlistentry> <term><parameter>--find-links dist</parameter></term> <listitem> - <para>Install wheels from the + <para>Installs wheels from the <filename class='directory'>dist</filename> directory.</para> </listitem> </varlistentry> From f8ac129f73959ad54ea6dd177c4541e1e77f58d0 Mon Sep 17 00:00:00 2001 From: David Bryant <davidbryant@gvtc.com> Date: Fri, 9 Dec 2022 15:45:13 -0600 Subject: [PATCH 7/7] Corrected English idiom throughout. Clarified the description of the package. Modified some program descriptions to improve their accuracy, or to correct clumsiness of style. --- chapter08/coreutils.xml | 42 ++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/chapter08/coreutils.xml b/chapter08/coreutils.xml index 3d2138026..34a41163e 100644 --- a/chapter08/coreutils.xml +++ b/chapter08/coreutils.xml @@ -23,8 +23,8 @@ <sect2 role="package"> <title/> - <para>The Coreutils package contains utilities for showing and setting the - basic system characteristics.</para> + <para>The Coreutils package contains the basic utility programs + needed by every operating system.</para> <segmentedlist> <segtitle>&buildtime;</segtitle> @@ -48,9 +48,9 @@ <screen><userinput remap="pre">patch -Np1 -i ../&coreutils-i18n-patch;</userinput></screen> <note> - <para>In the past, many bugs were found in this patch. When reporting new - bugs to Coreutils maintainers, please check first if they are reproducible - without this patch.</para> + <para>Many bugs have been found in this patch. When reporting new + bugs to the Coreutils maintainers, please check first to see if + those bugs are reproducible without this patch.</para> </note> <!-- this has been fixed in upstream gnulib, when a new version of @@ -75,8 +75,8 @@ FORCE_UNSAFE_CONFIGURE=1 ./configure \ <term><command>autoreconf</command></term> <listitem> <para>The patch for internationalization has modified the - building system of the package, so the configuration files have - to be regenerated.</para> + build system, so the configuration files must + be regenerated.</para> </listitem> </varlistentry> @@ -84,7 +84,7 @@ FORCE_UNSAFE_CONFIGURE=1 ./configure \ <term><envar>FORCE_UNSAFE_CONFIGURE=1</envar></term> <listitem> <para>This environment variable allows the package to be - built as the <systemitem class="username">root</systemitem> user. + built by the <systemitem class="username">root</systemitem> user. </para> </listitem> </varlistentry> @@ -93,7 +93,7 @@ FORCE_UNSAFE_CONFIGURE=1 ./configure \ <term><parameter>--enable-no-install-program=kill,uptime</parameter></term> <listitem> <para>The purpose of this switch is to prevent Coreutils from - installing binaries that will be installed by other packages later. + installing programs that will be installed by other packages. </para> </listitem> </varlistentry> @@ -181,7 +181,7 @@ sed -i 's/"1"/"8"/' /usr/share/man/man8/chroot.8</userinput></screen> <varlistentry id="lbracket"> <term><command>[</command></term> <listitem> - <para>Is an actual command, /usr/bin/[, that is a synonym + <para>Is an actual command, /usr/bin/[; it is a synonym for the <command>test</command> command</para> <indexterm zone="ch-system-coreutils lbracket"> <primary sortas="b-111">[</primary> @@ -275,7 +275,7 @@ sed -i 's/"1"/"8"/' /usr/share/man/man8/chroot.8</userinput></screen> <term><command>chmod</command></term> <listitem> <para>Changes the permissions of each file to the given mode; the mode - can be either a symbolic representation of the changes to make or an + can be either a symbolic representation of the changes to be made, or an octal number representing the new permissions</para> <indexterm zone="ch-system-coreutils chmod"> <primary sortas="b-chmod">chmod</primary> @@ -341,7 +341,7 @@ sed -i 's/"1"/"8"/' /usr/share/man/man8/chroot.8</userinput></screen> <term><command>csplit</command></term> <listitem> <para>Splits a given file into several new files, separating them - according to given patterns or line numbers and outputting the byte + according to given patterns or line numbers, and outputting the byte count of each new file</para> <indexterm zone="ch-system-coreutils csplit"> <primary sortas="b-csplit">csplit</primary> @@ -363,8 +363,8 @@ sed -i 's/"1"/"8"/' /usr/share/man/man8/chroot.8</userinput></screen> <varlistentry id="date"> <term><command>date</command></term> <listitem> - <para>Displays the current time in the given format, or sets the - system date</para> + <para>Displays the current dae and time in the given format, or sets the + system date and time</para> <indexterm zone="ch-system-coreutils date"> <primary sortas="b-date">date</primary> </indexterm> @@ -420,7 +420,7 @@ sed -i 's/"1"/"8"/' /usr/share/man/man8/chroot.8</userinput></screen> <varlistentry id="dirname"> <term><command>dirname</command></term> <listitem> - <para>Strips the non-directory suffix from a file name</para> + <para>Extracts the directory portion(s) of the given name(s)</para> <indexterm zone="ch-system-coreutils dirname"> <primary sortas="b-dirname">dirname</primary> </indexterm> @@ -482,7 +482,7 @@ sed -i 's/"1"/"8"/' /usr/share/man/man8/chroot.8</userinput></screen> <varlistentry id="factor"> <term><command>factor</command></term> <listitem> - <para>Prints the prime factors of all specified integer numbers</para> + <para>Prints the prime factors of the specified integers</para> <indexterm zone="ch-system-coreutils factor"> <primary sortas="b-factor">factor</primary> </indexterm> @@ -587,7 +587,7 @@ sed -i 's/"1"/"8"/' /usr/share/man/man8/chroot.8</userinput></screen> <varlistentry id="link"> <term><command>link</command></term> <listitem> - <para>Creates a hard link with the given name to a file</para> + <para>Creates a hard link (with the given name) to a file</para> <indexterm zone="ch-system-coreutils link"> <primary sortas="b-link">link</primary> </indexterm> @@ -647,8 +647,8 @@ sed -i 's/"1"/"8"/' /usr/share/man/man8/chroot.8</userinput></screen> <varlistentry id="mkfifo"> <term><command>mkfifo</command></term> <listitem> - <para>Creates First-In, First-Outs (FIFOs), a "named - pipe" in UNIX parlance, with the given names</para> + <para>Creates First-In, First-Outs (FIFOs), "named + pipes" in UNIX parlance, with the given names</para> <indexterm zone="ch-system-coreutils mkfifo"> <primary sortas="b-mkfifo">mkfifo</primary> </indexterm> @@ -1230,7 +1230,7 @@ sed -i 's/"1"/"8"/' /usr/share/man/man8/chroot.8</userinput></screen> <term><command>wc</command></term> <listitem> <para>Reports the number of lines, words, and bytes for each given - file, as well as a total line when more than one file is given</para> + file, as well as grand totals when more than one file is given</para> <indexterm zone="ch-system-coreutils wc"> <primary sortas="b-wc">wc</primary> </indexterm> @@ -1261,7 +1261,7 @@ sed -i 's/"1"/"8"/' /usr/share/man/man8/chroot.8</userinput></screen> <varlistentry id="yes"> <term><command>yes</command></term> <listitem> - <para>Repeatedly outputs <quote>y</quote> or a given string until + <para>Repeatedly outputs <quote>y</quote>, or a given string, until killed</para> <indexterm zone="ch-system-coreutils yes"> <primary sortas="b-yes">yes</primary>