[7152faa] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[b06ca36] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[673b0d8] | 4 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 | ]>
|
---|
[6a3b6af] | 7 |
|
---|
[725ef3b] | 8 | <sect1 id="ch-preps-settingenviron">
|
---|
[6a3b6af] | 9 | <?dbhtml filename="settingenvironment.html"?>
|
---|
| 10 |
|
---|
| 11 | <title>Setting Up the Environment</title>
|
---|
[673b0d8] | 12 |
|
---|
[6a3b6af] | 13 | <para>Set up a good working environment by creating two new startup files
|
---|
| 14 | for the <command>bash</command> shell. While logged in as user
|
---|
| 15 | <systemitem class="username">lfs</systemitem>, issue the following command
|
---|
| 16 | to create a new <filename>.bash_profile</filename>:</para>
|
---|
[81fd230] | 17 |
|
---|
[05616e2] | 18 | <screen><userinput>cat > ~/.bash_profile << "EOF"
|
---|
[d72e04a] | 19 | <literal>exec env -i HOME=$HOME TERM=$TERM PS1='\u:\w\$ ' /bin/bash</literal>
|
---|
[55851d6] | 20 | EOF</userinput></screen>
|
---|
[673b0d8] | 21 |
|
---|
[4e26453] | 22 | <para>When logged on as user <systemitem class="username">lfs</systemitem>,
|
---|
| 23 | or when switched to the &lfs-user; user using an <command>su</command> command
|
---|
| 24 | with the <quote><parameter>-</parameter></quote> option,
|
---|
[aa9ade1] | 25 | the initial shell is a <emphasis>login</emphasis> shell which reads
|
---|
[6a3b6af] | 26 | the <filename>/etc/profile</filename> of the host (probably containing some
|
---|
| 27 | settings and environment variables) and then <filename>.bash_profile</filename>.
|
---|
| 28 | The <command>exec env -i.../bin/bash</command> command in the
|
---|
| 29 | <filename>.bash_profile</filename> file replaces the running shell with a new
|
---|
| 30 | one with a completely empty environment, except for the <envar>HOME</envar>,
|
---|
| 31 | <envar>TERM</envar>, and <envar>PS1</envar> variables. This ensures that no
|
---|
| 32 | unwanted and potentially hazardous environment variables from the host system
|
---|
[4e26453] | 33 | leak into the build environment.</para>
|
---|
[81fd230] | 34 |
|
---|
[6a3b6af] | 35 | <para>The new instance of the shell is a <emphasis>non-login</emphasis>
|
---|
[ec7b0466] | 36 | shell, which does not read, and execute, the contents of the <filename>/etc/profile</filename> or
|
---|
[630308d] | 37 | <filename>.bash_profile</filename> files, but rather reads, and executes, the
|
---|
[6a3b6af] | 38 | <filename>.bashrc</filename> file instead. Create the
|
---|
| 39 | <filename>.bashrc</filename> file now:</para>
|
---|
[81fd230] | 40 |
|
---|
[b3f1ebb3] | 41 | <screen arch="default"><userinput>cat > ~/.bashrc << "EOF"
|
---|
[d72e04a] | 42 | <literal>set +h
|
---|
[673b0d8] | 43 | umask 022
|
---|
| 44 | LFS=/mnt/lfs
|
---|
| 45 | LC_ALL=POSIX
|
---|
[4e82d47] | 46 | LFS_TGT=$(uname -m)-lfs-linux-gnu
|
---|
[6dfcfecc] | 47 | PATH=/usr/bin
|
---|
| 48 | if [ ! -L /bin ]; then PATH=/bin:$PATH; fi
|
---|
| 49 | PATH=$LFS/tools/bin:$PATH
|
---|
[2d66549] | 50 | CONFIG_SITE=$LFS/usr/share/config.site
|
---|
| 51 | export LFS LC_ALL LFS_TGT PATH CONFIG_SITE</literal>
|
---|
[b3f1ebb3] | 52 | EOF</userinput></screen>
|
---|
[fd48baa] | 53 | <screen arch="ml_32,ml_x32,ml_all"><userinput>cat > ~/.bashrc << "EOF"
|
---|
[b3f1ebb3] | 54 | <literal>set +h
|
---|
| 55 | umask 022
|
---|
| 56 | LFS=/mnt/lfs
|
---|
| 57 | LC_ALL=POSIX
|
---|
| 58 | LFS_TGT=x86_64-lfs-linux-gnu
|
---|
| 59 | LFS_TGT32=i686-lfs-linux-gnu
|
---|
| 60 | LFS_TGTX32=x86_64-lfs-linux-gnux32
|
---|
[6dfcfecc] | 61 | PATH=/usr/bin
|
---|
| 62 | if [ ! -L /bin ]; then PATH=/bin:$PATH; fi
|
---|
| 63 | PATH=$LFS/tools/bin:$PATH
|
---|
[185615a] | 64 | CONFIG_SITE=$LFS/usr/share/config.site
|
---|
[b3f1ebb3] | 65 | export LFS LC_ALL LFS_TGT LFS_TGT32 LFS_TGTX32 PATH</literal>
|
---|
[55851d6] | 66 | EOF</userinput></screen>
|
---|
[673b0d8] | 67 |
|
---|
[630308d] | 68 | <variablelist>
|
---|
[6dfcfecc] | 69 | <title>The meaning of the settings in <filename>.bashrc</filename></title>
|
---|
[630308d] | 70 |
|
---|
| 71 | <varlistentry>
|
---|
| 72 | <term><parameter>set +h</parameter></term>
|
---|
| 73 | <listitem>
|
---|
[6a3b6af] | 74 | <para>The <command>set +h</command> command turns off
|
---|
| 75 | <command>bash</command>'s hash function. Hashing is ordinarily a useful
|
---|
| 76 | feature—<command>bash</command> uses a hash table to remember the
|
---|
[ec7b0466] | 77 | full path to executable files to avoid searching the <envar>PATH</envar>
|
---|
[6a3b6af] | 78 | time and again to find the same executable. However, the new tools should
|
---|
[ec7b0466] | 79 | be used as soon as they are installed. Switching off the hash function forces
|
---|
| 80 | the shell to search the <envar>PATH</envar> whenever a program is to
|
---|
[6a3b6af] | 81 | be run. As such, the shell will find the newly compiled tools in
|
---|
[490dc153] | 82 | <filename class="directory">$LFS/tools/bin</filename> as soon as they are
|
---|
| 83 | available without remembering a previous version of the same program
|
---|
| 84 | provided by the host distro, in
|
---|
| 85 | <filename class='directory'>/usr/bin</filename> or
|
---|
| 86 | <filename class='directory'>/bin</filename>.</para>
|
---|
[630308d] | 87 | </listitem>
|
---|
| 88 | </varlistentry>
|
---|
[81fd230] | 89 |
|
---|
[630308d] | 90 | <varlistentry>
|
---|
| 91 | <term><parameter>umask 022</parameter></term>
|
---|
| 92 | <listitem>
|
---|
[6a3b6af] | 93 | <para>Setting the user file-creation mask (umask) to 022 ensures that newly
|
---|
| 94 | created files and directories are only writable by their owner, but are
|
---|
| 95 | readable and executable by anyone (assuming default modes are used by the
|
---|
[ea93c11] | 96 | <ulink role='man' url='&man;open.2'>open(2)</ulink> system call, new files
|
---|
| 97 | will end up with permission mode 644 and directories with mode 755).</para>
|
---|
[630308d] | 98 | </listitem>
|
---|
| 99 | </varlistentry>
|
---|
[81fd230] | 100 |
|
---|
[630308d] | 101 | <varlistentry>
|
---|
| 102 | <term><parameter>LFS=/mnt/lfs</parameter></term>
|
---|
| 103 | <listitem>
|
---|
[6a3b6af] | 104 | <para>The <envar>LFS</envar> variable should be set to the chosen mount
|
---|
| 105 | point.</para>
|
---|
[630308d] | 106 | </listitem>
|
---|
| 107 | </varlistentry>
|
---|
[81fd230] | 108 |
|
---|
[630308d] | 109 | <varlistentry>
|
---|
| 110 | <term><parameter>LC_ALL=POSIX</parameter></term>
|
---|
| 111 | <listitem>
|
---|
[6a3b6af] | 112 | <para>The <envar>LC_ALL</envar> variable controls the localization of certain
|
---|
| 113 | programs, making their messages follow the conventions of a specified country.
|
---|
[448e226] | 114 | Setting <envar>LC_ALL</envar> to <quote>POSIX</quote> or <quote>C</quote>
|
---|
| 115 | (the two are equivalent) ensures that everything will work as expected in
|
---|
[4e26453] | 116 | the cross-compilation environment.</para>
|
---|
[630308d] | 117 | </listitem>
|
---|
| 118 | </varlistentry>
|
---|
[81fd230] | 119 |
|
---|
[630308d] | 120 | <varlistentry>
|
---|
[2d6ced8] | 121 | <term><parameter>LFS_TGT=$(uname -m)-lfs-linux-gnu</parameter></term>
|
---|
[630308d] | 122 | <listitem>
|
---|
[4e82d47] | 123 | <para>The <envar>LFS_TGT</envar> variable sets a non-default, but compatible machine
|
---|
[4e26453] | 124 | description for use when building our cross-compiler and linker and when
|
---|
| 125 | cross-compiling our temporary toolchain. More information is provided by
|
---|
[4e82d47] | 126 | <xref linkend="ch-tools-toolchaintechnotes" role=""/>.</para>
|
---|
[630308d] | 127 | </listitem>
|
---|
| 128 | </varlistentry>
|
---|
[4e82d47] | 129 |
|
---|
[630308d] | 130 | <varlistentry>
|
---|
[6dfcfecc] | 131 | <term><parameter>PATH=/usr/bin</parameter></term>
|
---|
[630308d] | 132 | <listitem>
|
---|
[ec7b0466] | 133 | <para>Many modern Linux distributions have merged <filename
|
---|
[6dfcfecc] | 134 | class="directory">/bin</filename> and <filename
|
---|
| 135 | class="directory">/usr/bin</filename>. When this is the case, the standard
|
---|
[ec7b0466] | 136 | <envar>PATH</envar> variable should be set to <filename
|
---|
[6dfcfecc] | 137 | class="directory">/usr/bin/</filename> for the <xref
|
---|
| 138 | linkend="chapter-temporary-tools"/> environment. When this is not the
|
---|
| 139 | case, the following line adds <filename class="directory">/bin</filename>
|
---|
| 140 | to the path.</para>
|
---|
| 141 | </listitem>
|
---|
| 142 | </varlistentry>
|
---|
| 143 |
|
---|
| 144 | <varlistentry>
|
---|
| 145 | <term><parameter>if [ ! -L /bin ]; then PATH=/bin:$PATH; fi</parameter></term>
|
---|
| 146 | <listitem>
|
---|
| 147 | <para>If <filename class="directory">/bin</filename> is not a symbolic
|
---|
[4e26453] | 148 | link, it must be added to the <envar>PATH</envar> variable.</para>
|
---|
[6dfcfecc] | 149 | </listitem>
|
---|
| 150 | </varlistentry>
|
---|
| 151 |
|
---|
| 152 | <varlistentry>
|
---|
| 153 | <term><parameter>PATH=$LFS/tools/bin:$PATH</parameter></term>
|
---|
| 154 | <listitem>
|
---|
| 155 | <para>By putting <filename class="directory">$LFS/tools/bin</filename> ahead of the
|
---|
| 156 | standard <envar>PATH</envar>, the cross-compiler installed at the beginning
|
---|
| 157 | of <xref linkend="chapter-cross-tools"/> is picked up by the shell
|
---|
| 158 | immediately after its installation. This, combined with turning off hashing,
|
---|
[ec7b0466] | 159 | limits the risk that the compiler from the host is used instead of the
|
---|
[6dfcfecc] | 160 | cross-compiler.</para>
|
---|
[630308d] | 161 | </listitem>
|
---|
| 162 | </varlistentry>
|
---|
| 163 |
|
---|
| 164 | <varlistentry>
|
---|
[2d66549] | 165 | <term><parameter>CONFIG_SITE=$LFS/usr/share/config.site</parameter></term>
|
---|
| 166 | <listitem>
|
---|
| 167 | <para>In <xref linkend="chapter-cross-tools"/> and
|
---|
| 168 | <xref linkend="chapter-temporary-tools"/>, if this variable is not set,
|
---|
| 169 | <command>configure</command> scripts
|
---|
| 170 | may attempt to load configuration items specific to some distributions from
|
---|
| 171 | <filename>/usr/share/config.site</filename> on the host system. Override
|
---|
| 172 | it to prevent potential contamination from the host.</para>
|
---|
| 173 | </listitem>
|
---|
| 174 | </varlistentry>
|
---|
| 175 |
|
---|
| 176 | <varlistentry>
|
---|
| 177 | <term><parameter>export ...</parameter></term>
|
---|
[630308d] | 178 | <listitem>
|
---|
[4e26453] | 179 | <para>While the preceding commands have set some variables, in order
|
---|
[6dfcfecc] | 180 | to make them visible within any sub-shells, we export them.</para>
|
---|
[630308d] | 181 | </listitem>
|
---|
| 182 | </varlistentry>
|
---|
| 183 |
|
---|
| 184 | </variablelist>
|
---|
[81fd230] | 185 |
|
---|
[6dfcfecc] | 186 | <important>
|
---|
| 187 |
|
---|
[4e26453] | 188 | <para>Several commercial distributions add an undocumented instantiation
|
---|
[6dfcfecc] | 189 | of <filename>/etc/bash.bashrc</filename> to the initialization of
|
---|
| 190 | <command>bash</command>. This file has the potential to modify the
|
---|
| 191 | <systemitem class="username">lfs</systemitem>
|
---|
| 192 | user's environment in ways that can affect the building of critical LFS
|
---|
| 193 | packages. To make sure the <systemitem class="username">lfs</systemitem>
|
---|
[d7e0db5] | 194 | user's environment is clean, check for the
|
---|
[6dfcfecc] | 195 | presence of <filename>/etc/bash.bashrc</filename> and, if present, move it
|
---|
| 196 | out of the way. As the <systemitem class="username">root</systemitem>
|
---|
| 197 | user, run:</para>
|
---|
| 198 |
|
---|
[707c4d3] | 199 | <screen role="nodump"><userinput>[ ! -e /etc/bash.bashrc ] || mv -v /etc/bash.bashrc /etc/bash.bashrc.NOUSE</userinput></screen>
|
---|
[6dfcfecc] | 200 |
|
---|
[4e26453] | 201 | <para>When the <systemitem class="username">lfs</systemitem>
|
---|
| 202 | user is no longer needed (at the beginning of <xref
|
---|
| 203 | linkend="chapter-chroot-temporary-tools"/>), you may safely restore
|
---|
[c37e846] | 204 | <filename>/etc/bash.bashrc</filename> (if desired).</para>
|
---|
[6dfcfecc] | 205 |
|
---|
| 206 | <para>Note that the LFS Bash package we will build in
|
---|
| 207 | <xref linkend="ch-system-bash"/> is not configured to load or execute
|
---|
| 208 | <filename>/etc/bash.bashrc</filename>, so this file is useless on a
|
---|
| 209 | completed LFS system.</para>
|
---|
| 210 | </important>
|
---|
| 211 |
|
---|
[a0a803c] | 212 | <para>
|
---|
| 213 | For many modern systems with multiple processors (or cores) the
|
---|
| 214 | compilation time for a package can be reduced by performing a "parallel
|
---|
| 215 | make" by telling the make program how many processors are available via
|
---|
| 216 | a command line option or an environment variable. For instance, an Intel
|
---|
| 217 | Core i9-13900K processor has 8 P (performance) cores and
|
---|
| 218 | 16 E (efficiency) cores, and a P core can simultaneously run two threads
|
---|
| 219 | so each P core are modeled as two logical cores by the Linux kernel.
|
---|
| 220 | As the result there are 32 logical cores in total. One obvious way to
|
---|
| 221 | use all these logical cores is allowing <command>make</command> to spawn
|
---|
| 222 | up to 32 build jobs. This can be done by passing the
|
---|
| 223 | <parameter>-j32</parameter> option to <command>make</command>:
|
---|
| 224 | </para>
|
---|
| 225 |
|
---|
| 226 | <screen role='nodump'><userinput>make -j32</userinput></screen>
|
---|
| 227 |
|
---|
| 228 | <para>
|
---|
| 229 | Or set the <envar>MAKEFLAGS</envar> environment variable and its
|
---|
| 230 | content will be automatically used by <command>make</command> as
|
---|
| 231 | command line options:
|
---|
| 232 | </para>
|
---|
| 233 |
|
---|
| 234 | <screen role='nodump'><userinput>export MAKEFLAGS=-j32</userinput></screen>
|
---|
| 235 |
|
---|
| 236 | <important>
|
---|
| 237 | <para>
|
---|
| 238 | Never pass a <parameter>-j</parameter> option without a number to
|
---|
| 239 | <command>make</command> or set such an option in
|
---|
| 240 | <envar>MAKEFLAGS</envar>. Doing so will allow <command>make</command>
|
---|
[6554500] | 241 | to spawn infinite build jobs and cause system stability problems.
|
---|
[a0a803c] | 242 | </para>
|
---|
| 243 | </important>
|
---|
| 244 |
|
---|
| 245 | <para>
|
---|
| 246 | To use all logical cores available for building packages in
|
---|
| 247 | <xref linkend='chapter-cross-tools'/> and
|
---|
| 248 | <xref linkend='chapter-temporary-tools'/>, set <envar>MAKEFLAGS</envar>
|
---|
| 249 | now in <filename>.bashrc</filename>:
|
---|
| 250 | </para>
|
---|
| 251 |
|
---|
| 252 | <screen><userinput>cat >> ~/.bashrc << "EOF"
|
---|
| 253 | <literal>export MAKEFLAGS=-j<replaceable>$(nproc)</replaceable></literal>
|
---|
| 254 | EOF</userinput></screen>
|
---|
| 255 |
|
---|
| 256 | <para>
|
---|
| 257 | Replace <replaceable>$(nproc)</replaceable> with the number of logical
|
---|
| 258 | cores you want to use if you don't want to use all the logical cores.
|
---|
| 259 | </para>
|
---|
| 260 |
|
---|
[4e26453] | 261 | <para>Finally, to ensure the environment is fully prepared for building the
|
---|
[ec7b0466] | 262 | temporary tools, force the <command>bash</command> shell to read
|
---|
| 263 | the new user profile:</para>
|
---|
[81fd230] | 264 |
|
---|
[673b0d8] | 265 | <screen><userinput>source ~/.bash_profile</userinput></screen>
|
---|
| 266 |
|
---|
| 267 | </sect1>
|
---|