aboutsummaryrefslogtreecommitdiffstats
path: root/chapter08
diff options
context:
space:
mode:
authorXi Ruoyao <xry111@mengyan1223.wang>2022-04-18 12:59:52 +0800
committerXi Ruoyao <xry111@mengyan1223.wang>2022-04-18 12:59:52 +0800
commitee16e55d205ff326d585faeb1318a35cf5589586 (patch)
tree2078f83699edc72dca8f4a7e8f5d13d24e054f14 /chapter08
parent9749744481352f1d1fdc62a6a3275496b3deb6e6 (diff)
text fixes for wheel change
* Add description for "wheel" command * Explain why pip3 warning does not matter for us * Format and typo fixes
Diffstat (limited to 'chapter08')
-rw-r--r--chapter08/meson.xml6
-rw-r--r--chapter08/python.xml16
-rw-r--r--chapter08/wheel.xml27
3 files changed, 37 insertions, 12 deletions
diff --git a/chapter08/meson.xml b/chapter08/meson.xml
index 91b4b61bc..d2132b5a1 100644
--- a/chapter08/meson.xml
+++ b/chapter08/meson.xml
@@ -70,14 +70,16 @@ 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 `dist` directory.</para>
+ <para>Put the created wheels into the
+ <filename class='directory'>dist</filename> directory.</para>
</listitem>
</varlistentry>
<varlistentry>
<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>
diff --git a/chapter08/python.xml b/chapter08/python.xml
index 76530d782..1af9e0db9 100644
--- a/chapter08/python.xml
+++ b/chapter08/python.xml
@@ -93,11 +93,17 @@
<screen><userinput remap="install">make install</userinput></screen>
<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' \
-i /usr/lib/python3.10/site-packages/pip/_internal/cli/req_command.py
diff --git a/chapter08/wheel.xml b/chapter08/wheel.xml
index 78fa94fd8..f15824ad5 100644
--- a/chapter08/wheel.xml
+++ b/chapter08/wheel.xml
@@ -23,7 +23,7 @@
<sect2 role="package">
<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>
<segmentedlist>
@@ -50,7 +50,7 @@
<varlistentry>
<term><command>install</command></term>
<listitem>
- <para>Install the package</para>
+ <para>Install the package.</para>
</listitem>
</varlistentry>
@@ -79,16 +79,33 @@
<title>Contents of Wheel</title>
<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>
+ <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>
</sect1>