Changeset 23277f0c

Timestamp:

04/21/2022 03:23:18 PM (2 years ago)

Author:

William Harrington <kb0iic@…>

Branches:

arm

Children:

3e8a788

Parents:

8b8ad95

git-author:

Xi Ruoyao <xry111@…> (04/18/2022 04:59:52 AM)

git-committer:

William Harrington <kb0iic@…> (04/21/2022 03:23:18 PM)

Message:

text fixes for wheel change

• Add description for "wheel" command
• Explain why pip3 warning does not matter for us
• Format and typo fixes

Location:

chapter08

Files:

• meson.xml (modified) (2 diffs)
• python.xml (modified) (1 diff)
• wheel.xml (modified) (3 diffs)

chapter08/meson.xml

@@ -71 +71 @@
         <term><parameter>-w dist</parameter></term>
         <listitem>
-           <para>Put the created wheels into the `dist` directory.</para>
+           <para>Put the created wheels into the
+           <filename class='directory'>dist</filename> directory.</para>
         </listitem>
       </varlistentry>
@@ -78 +79 @@
         <term><parameter>--find-links dist</parameter></term>
         <listitem>
-           <para>Install wheels from the 'dist' directory.</para>
+           <para>Install wheels from the
+           <filename class='directory'>dist</filename> directory.</para>
         </listitem>
       </varlistentry>

chapter08/python.xml

@@ -94 +94 @@
 
     <para>In serveral places we use the <command>pip3</command> command to
-    install Python 3 programs and modules for all users as root. This conflicts
-    with the Python developers recommendation to build packages in a virtual
-    environment as a regular user. To this end, a multi-line warning is
-    written when using <command>pip3</command> as the root user.  If desired,
-    supress this warning by running the following command:</para>
+    install Python 3 programs and modules for all users as
+    <systemitem class='username'>root</systemitem>. This conflicts
+    with the Python developers recommendation to install packages into a
+    virtual environment or the home directory of a regular user (by running
+    <command>pip3</command> as this user). To this end, a multi-line warning
+    is written when using <command>pip3</command> as the
+    <systemitem class='username'>root</systemitem> user.  The main reason
+    of this recommendation is for avoiding a conflict with the system
+    package manager (<command>dpkg</command> for example), but LFS does not
+    have a system-wide package manager so this is not a problem.  If desired,
+    suppress this warning by running the following command:</para>
 
 <screen><userinput remap="install">sed -e '/def warn_if_run_as_root/a\    return' \

chapter08/wheel.xml

@@ -24 +24 @@
     <title/>
 
-    <para>Wheel is a Python library that implements the reference
+    <para>Wheel is a Python library that is the reference
     implementation of the Python wheel packaging standard.</para>
 
@@ -51 +51 @@
         <term><command>install</command></term>
         <listitem>
-           <para>Install the package</para>
+           <para>Install the package.</para>
         </listitem>
       </varlistentry>
@@ -80 +80 @@
 
     <segmentedlist>
-      <segtitle>Installed module</segtitle>
+      <segtitle>Installed program</segtitle>
       <segtitle>Installed directory</segtitle>
 
       <seglistitem>
-        <seg>wheel.py</seg>
+        <seg>wheel</seg>
         <seg>/usr/lib/python&python-minor;/site-packages/wheel</seg>
       </seglistitem>
+    </segmentedlist>
 
-    </segmentedlist>
+    <variablelist>
+      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
+      <?dbfo list-presentation="list"?>
+      <?dbhtml list-presentation="table"?>
+
+      <varlistentry id="wheel-wheel">
+        <term><command>wheel</command></term>
+        <listitem>
+          <para>
+            is an utility to unpack, pack, or convert wheel packages
+          </para>
+          <indexterm zone="ch-system-wheel">
+            <primary sortas="b-wheel">wheel</primary>
+          </indexterm>
+        </listitem>
+      </varlistentry>
+    </variablelist>
 
   </sect2>