- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
introduction/welcome/conventions.xml
r4a570af1 r3f2db3a6 9 9 <?dbhtml filename="conventions.html"?> 10 10 11 <sect1info>12 <date>$Date$</date>13 </sect1info>14 11 15 12 <title>Conventions Used in this Book</title> … … 17 14 <sect2> 18 15 <title>Typographical Conventions</title> 19 <para>To make things easy to follow, there are a number of conventionsused20 throughout the book. Followingare some examples:</para>16 <para>To make things easy to follow, a number of conventions are used 17 throughout the book. Here are some examples:</para> 21 18 22 19 <screen><userinput>./configure --prefix=/usr</userinput></screen> 23 20 24 21 <blockquote> 25 <para>This form of text is designed to be typed exactly as seen unless22 <para>This form of text should be typed exactly as shown unless 26 23 otherwise noted in the surrounding text. It is also used to identify 27 24 references to specific commands.</para> … … 32 29 33 30 <blockquote> 34 <para>This form of text (fixed width text) is showingscreen35 output, probably a result fromissuing a command. It is also used to31 <para>This form of text (fixed width font) shows screen 32 output, probably the result of issuing a command. It is also used to 36 33 show filenames such as <filename>/boot/grub/grub.conf</filename></para> 37 34 </blockquote> … … 40 37 41 38 <blockquote> 42 <para>This form of text is used for several purposes in the43 b ook but mainly to emphasize important points or to give examples as to39 <para>This form of text is used for several purposes, 40 but mainly to emphasize important points, or to give examples of 44 41 what to type.</para> 45 42 </blockquote> … … 49 46 <blockquote> 50 47 <para>This form of text is used for hypertext links external to 51 the book such as HowTos, download locations, websites, etc.</para>48 the book, such as HowTos, download locations, websites, etc.</para> 52 49 </blockquote> 53 50 … … 56 53 <blockquote> 57 54 <para>This form of text is used for links internal to 58 the book such as another section describing a different package.</para>55 the book, such as another section describing a different package.</para> 59 56 </blockquote> 60 57 … … 66 63 67 64 <blockquote> 68 <para>This type of section is used mainlywhen creating configuration65 <para>This style is mainly used when creating configuration 69 66 files. The first command (in bold) tells the system to create 70 67 the file <filename>$LFS/etc/group</filename> from whatever is typed on the 71 following lines until the sequence EOF is encountered. 72 Therefore, this whole section is generally typed as seen.</para> 68 following lines, until the sequence EOF is encountered. 69 Therefore, this whole section is usually typed exactly as shown. 70 Remember, copy and paste is your friend!</para> 73 71 </blockquote> 74 72 … … 77 75 <blockquote> 78 76 <para>This form of text is used to encapsulate text that should be 79 modified and is not to be typed as seen, or copy and pasted. Note that80 the square brackets are not part of the text, but should be substituted81 for as well.</para>77 modified, and is not to be typed as shown, or copied and pasted. 78 The angle brackets are not part of the literal text; they are part of the 79 substitution.</para> 82 80 </blockquote> 83 81 … … 89 87 </blockquote> 90 88 89 <para> </para> <!-- add extra white space to improve readability --> 91 90 </sect2> 92 91 … … 94 93 <title>Conventions Used for Package Dependencies</title> 95 94 96 <para>When packages are created, theauthors depend on prior work. In97 order to build a package in BLFS, these dependencies must be built prior to98 the desired package . For each package, any prerequisite packages are listed95 <para>When new packages are created, the software's authors depend on prior work. In 96 order to build a package in BLFS, these dependencies must be built before 97 the desired package can be compiled. For each package, prerequisites are listed 99 98 in one or more separate sections: Required, Recommended, and Optional.</para> 100 99 101 100 <bridgehead renderas="sect3">Required Dependencies</bridgehead> 102 101 103 <para>These dependencies are the minimum prerequisite packages required to 104 build the package. Omitted from the list are packages in LFS and required 105 dependencies of other required packages.</para> 102 <para>These dependencies are the bare minimum needed to 103 build the package. Packages in LFS, and the required 104 dependencies of these required packages, are omitted from this list. 105 Always remember to check for nested dependencies.</para> 106 106 107 107 <bridgehead renderas="sect3">Recommended Dependencies</bridgehead> 108 108 109 <para>These dependencies are those thatthe BLFS editors have determined109 <para>These are dependencies the BLFS editors have determined 110 110 are important to give the package reasonable capabilities. Package 111 111 installation instructions assume they are installed. If a recommended 112 package is not desired, the instructions may need to be modifiedto112 package is not installed, the instructions may require modification, to 113 113 accommodate the missing package.</para> 114 114 115 115 <bridgehead renderas="sect3">Optional Dependencies</bridgehead> 116 116 117 <para>These dependencies are those that the package may use. Integration 118 of optional dependencies may be automatic by the package or may need 119 additional instructions not presented by BLFS. Optional packages may be 120 listed without corresponding BLFS instructions. In this case it is up to 121 the user to determine appropriate installation instructions. </para> 122 117 <para>These are dependencies the package <emphasis>may</emphasis> use. Integration 118 of optional dependencies may be automatic by the package, or 119 additional steps not presented by BLFS may be necessary. Optional dependencies are 120 sometimes listed without explicit BLFS instructions. In this case you must 121 determine how to perform the installation yourself. </para> 122 123 <para> </para> <!-- add extra white space to improve readability --> 123 124 </sect2> 124 125 … … 126 127 <title>Conventions Used for Kernel Configuration Options</title> 127 128 128 <para>Some packages have specific needs regarding the kernel configuration.129 The general layout is the following:</para>129 <para>Some packages require specific kernel configuration options. 130 The general layout for these looks like this:</para> 130 131 131 132 <screen><literal>Master section ---> … … 139 140 140 141 <para>[CONFIG_...] on the right gives the name of the option, so you can 141 easily check whether it is set in your <filename> config</filename> file.142 easily check whether it is set in your <filename>.config</filename> file. 142 143 The meaning of the various entries is: 143 144 … … 157 158 <emphasis role="bold">Required parameter</emphasis></entry> 158 159 <entry> 159 the option c ould be either built-inor not selected: it must be160 the option can either be built-in, or not selected: it must be 160 161 selected 161 162 </entry> … … 167 168 </entry> 168 169 <entry> 169 the option c ould be either built-in, module, or not selected:170 the option can be built-in, a module, or not selected (tri-state): 170 171 it must be selected as built-in 171 172 </entry> … … 177 178 </entry> 178 179 <entry> 179 the option c ould be either built-in,module, or not selected:180 it must be selected, either as built-in or module180 the option can be built-in, a module, or not selected: 181 it must be selected, either as built-in or as a module 181 182 </entry> 182 183 </row> … … 186 187 </entry> 187 188 <entry> 188 rarely used: the option c ould be either built-in,module, or not189 selected: it may be se lected at will189 rarely used: the option can be built-in, a module, or not 190 selected: it may be set any way you wish 190 191 </entry> 191 192 </row> … … 195 196 </entry> 196 197 <entry> 197 the option c ould be eitherbuilt-in or not selected: it must198 the option can either be built-in or not selected: it must 198 199 <emphasis>not</emphasis> be selected 199 200 </entry> … … 204 205 </entry> 205 206 <entry> 206 the option c ould be either built-in,module, or not selected:207 the option can be built-in, a module, or not selected: 207 208 it must <emphasis>not</emphasis> be selected 208 209 </entry> … … 213 214 214 215 <para>Note that, depending on other selections, the angle brackets 215 (<>) may appear as braces ({}),if the option cannot be unselected,216 or even dashes (-*- or -M-), when the choice is imposed.217 The help text aboutthe option specifies the other selections on which this216 (<>) in the configuration menu may appear as braces ({}) if the option cannot be unselected, 217 or even as dashes (-*- or -M-), when the choice is imposed. 218 The help text describing the option specifies the other selections on which this 218 219 option relies, and how those other selections are set.</para> 219 220 221 <para> </para> <!-- add extra white space to improve readability --> 220 222 </sect2> 221 223 … … 225 227 <para>As in LFS, each package in BLFS has a build time listed in Standard 226 228 Build Units (SBUs). These times are relative to the time it took to build 227 binutils in LFS and are intended to provide some insight into how long it229 binutils in LFS, and are intended to provide some insight into how long it 228 230 will take to build a package. Most times listed are for a single processor 229 231 or core to build the package. In some cases, large, long running builds … … 232 234 multiple cores. Note that while this speeds up the build on systems with 233 235 the appropriate hardware, the speedup is not linear and to some extent 234 depends on the individual package and specific hardware used. </para>235 236 <para>For packages which use ninja ( e.g.anything using meson) or rust, by237 default all cores are used sosimilar comments will be seen on such packages236 depends on the individual package and the specific hardware used. </para> 237 238 <para>For packages which use ninja (i.e., anything using meson) or rust, by 239 default all cores are used; similar comments will be seen on such packages 238 240 even when the build time is minimal.</para> 239 241 … … 241 243 machines the time may be considerably greater even when the build does not 242 244 use swap. In particular, different micro-architectures will build some 243 files at different relative speeds and this can introduce delays when245 files at different relative speeds, and this can introduce delays when 244 246 certain make targets wait for another file to be created. Where a large 245 247 build uses a lot of C++ files, processors with Simultaneous Multi Threading … … 248 250 other cores idle).</para> 249 251 250 <para>Some packages do not support parallel builds and using -j1 forthe251 make command is required. Packages that are known to have such limits are252 marked as suchin the text.</para>252 <para>Some packages do not support parallel builds; for these, the 253 make command must specify -j1. Packages that are known to impose such limits are 254 so marked in the text.</para> 253 255 254 256 </sect2>
Note:
See TracChangeset
for help on using the changeset viewer.