text fixes for wheel change

* Add description for "wheel" command
* Explain why pip3 warning does not matter for us
* Format and typo fixes
This commit is contained in:
Xi Ruoyao 2022-04-18 12:59:52 +08:00
parent 9749744481
commit ee16e55d20
No known key found for this signature in database
GPG Key ID: D95E4716CCBB34DC
3 changed files with 37 additions and 12 deletions

View File

@ -70,14 +70,16 @@ install -vDm644 data/shell-completions/zsh/_meson /usr/share/zsh/site-functions/
<varlistentry> <varlistentry>
<term><parameter>-w dist</parameter></term> <term><parameter>-w dist</parameter></term>
<listitem> <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> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><parameter>--find-links dist</parameter></term> <term><parameter>--find-links dist</parameter></term>
<listitem> <listitem>
<para>Install wheels from the 'dist' directory.</para> <para>Install wheels from the
<filename class='directory'>dist</filename> directory.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>

View File

@ -93,11 +93,17 @@
<screen><userinput remap="install">make install</userinput></screen> <screen><userinput remap="install">make install</userinput></screen>
<para>In serveral places we use the <command>pip3</command> command to <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 install Python 3 programs and modules for all users as
with the Python developers recommendation to build packages in a virtual <systemitem class='username'>root</systemitem>. This conflicts
environment as a regular user. To this end, a multi-line warning is with the Python developers recommendation to install packages into a
written when using <command>pip3</command> as the root user. If desired, virtual environment or the home directory of a regular user (by running
supress this warning by running the following command:</para> <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' \ <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 -i /usr/lib/python3.10/site-packages/pip/_internal/cli/req_command.py

View File

@ -23,7 +23,7 @@
<sect2 role="package"> <sect2 role="package">
<title/> <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> implementation of the Python wheel packaging standard.</para>
<segmentedlist> <segmentedlist>
@ -50,7 +50,7 @@
<varlistentry> <varlistentry>
<term><command>install</command></term> <term><command>install</command></term>
<listitem> <listitem>
<para>Install the package</para> <para>Install the package.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -79,16 +79,33 @@
<title>Contents of Wheel</title> <title>Contents of Wheel</title>
<segmentedlist> <segmentedlist>
<segtitle>Installed module</segtitle> <segtitle>Installed program</segtitle>
<segtitle>Installed directory</segtitle> <segtitle>Installed directory</segtitle>
<seglistitem> <seglistitem>
<seg>wheel.py</seg> <seg>wheel</seg>
<seg>/usr/lib/python&python-minor;/site-packages/wheel</seg> <seg>/usr/lib/python&python-minor;/site-packages/wheel</seg>
</seglistitem> </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> </sect2>
</sect1> </sect1>