Attachment #165078 for bug #232903




<body>

<p>
A profile is a set of files which specify default values for CHOST, CFLAGS, USE
and other important variables, it also locks the system to a certain range of
package versions. Gentoo uses cascading profiles. Each file that defines base
defaults for your system, like <c>make.defaults</c>, <c>packages</c>, etc.  can
inherit the contents of like files from parent directories. Files named
<c>parent</c> within the selected profile hierarchy specify which directories
contain files to use to assemble the final profile. Values specified in files
from profile sub-directories take precedence over values specified at a higher
level. This is all maintained by the Gentoo developers and you don't need to
edit profile files directly but sometimes there may be certain situations in
which you may decide a profile change is necessary.
</p>

<warn>
Do <e>not</e> edit the profile files directly. Gentoo provides other means to 
customize and extend these settings.
</warn>

<p>
You can see what profile you are currently using with the following command:




<ul>
  <li>
    CFLAGS &amp; CXXFLAGS define the desired compiler flags for C and C++
    compiling
  </li>
  <li>
    CHOST defines the build host information for the application's configure 

  <li>
    MAKEOPTS is passed to the <c>make</c> command and is usually set to define
    the amount of parallelism used during the compilation. More information
    about the make options can be found in the <c>make</c> man page
  </li>
</ul>



<ul>
  <li>
    GENTOO_MIRRORS defines a list of server locations which contain source code
    (distfiles)
  </li>
  <li>
    PORTAGE_BINHOST defines a particular server location containing prebuilt

    PORTAGE_RSYNC_OPTS sets a number of default variables used during sync,
    each space-separated. These shouldn't be changed unless you know
    <e>exactly</e> what you're doing. Note that certain absolutely required
    options will always be used even if PORTAGE_RSYNC_OPTS is empty
  </li>
  <li>
    PORTAGE_RSYNC_EXTRA_OPTS can be used to set additional options when
    syncing. Each option should be space separated
    <ul>
      <li>
	--timeout=&lt;number&gt;: This defines the number of seconds an rsync
	connection can idle before rsync sees the connection as timed-out. This
	variable defaults to 180 but dialup users or individuals with slow
	computers might want to set this to 300 or higher
      </li>
      <li>
	--exclude-from=/etc/portage/rsync_excludes: This points to a file

	update process. In this case, it points to
	<path>/etc/portage/rsync_excludes</path>. Please read <uri
	link="?part=3&amp;chap=5">Using a Portage Tree Subset</uri> for the
	syntax of this file
      </li>
      <li>--quiet: Reduces output to the screen</li>
      <li>--verbose: Prints a complete filelist</li>

  <li>
    PORTAGE_RSYNC_RETRIES defines how many times rsync should try connecting to
    the mirror pointed to by the SYNC variable before bailing out. This
    variable defaults to 3
  </li>
</ul>





    <ul>
      <li>
	<c>save</c>: This saves one log per package in
	<path>$PORT_LOGDIR/elog/</path>, or <path>/var/log/portage/elog/</path>
	if $PORT_LOGDIR is not defined
      </li>
      <li>
	<c>custom</c>: Passes all messages to a user-defined command in
	$PORTAGE_ELOG_COMMAND; this will be discussed later
      </li>
      <li>
	<c>syslog</c>: Sends all messages to the installed system logger
      </li>
      <li>
	<c>mail</c>: Passes all messages to a user-defined mailserver in
	$PORTAGE_ELOG_MAILURI; this will be discussed later. The mail features
	of elog require &gt;=<c>portage-2.1.1</c>
      </li>
      <li>
	<c>save_summary</c>: Similar to <c>save</c>, but it merges all messages
	in <path>$PORT_LOGDIR/elog/summary.log</path>, or
	<path>/var/log/portage/elog/summary.log</path> if $PORT_LOGDIR is not
	defined
      </li>
      <li>
	<c>mail_summary</c>: Similar to <c>mail</c>, but it sends all messages
	in a single mail when emerge exits
      </li>
    </ul>
  </li>

  <li>
    PORTAGE_ELOG_MAILURI: This contains settings for the <c>mail</c> module
    such as address, user, password, mailserver, and port number. The default
    setting is "root@localhost localhost"
  </li>
  <li>
    Here's an example for an smtp server that requires username and

  </li>
  <li>
    PORTAGE_ELOG_MAILFROM: Allows you to set the "from" address of log mails;
    defaults to "portage" if unset
  </li>
  <li>
    PORTAGE_ELOG_MAILSUBJECT: Allows you to create a subject line for log
    mails. Note that you can make use of two variables: ${PACKAGE} will display
    the package name and version, while ${HOST} is the fully qualified domain
    name of the host Portage is running on
  </li>
  <li>
    Here's one possible use:

Return to bug 232903

Lines 189-208 Link Here

(-)hb-install-system.xml (-14 / +17 lines)
189	<body>	189	<body>
190		190
191	<p>	191	<p>
192	First, a small definition is in place.	192	A profile is a set of files which specify default values for CHOST, CFLAGS, USE
193	</p>	193	and other important variables, it also locks the system to a certain range of
194		194	package versions. Gentoo uses cascading profiles. Each file that defines base
195	<p>	195	defaults for your system, like <c>make.defaults</c>, <c>packages</c>, etc. can
196	A profile is a building block for any Gentoo system. Not only does it specify	196	inherit the contents of like files from parent directories. Files named
197	default values for CHOST, CFLAGS and other important variables, it also locks	197	<c>parent</c> within the selected profile hierarchy specify which directories
198	the system to a certain range of package versions. This is all maintained by the	198	contain files to use to assemble the final profile. Values specified in files
199	Gentoo developers.	199	from profile sub-directories take precedence over values specified at a higher
200	</p>	200	level. This is all maintained by the Gentoo developers and you don't need to
201		201	edit profile files directly but sometimes there may be certain situations in
202	<p>	202	which you may decide a profile change is necessary.
203	Previously, such a profile was untouched by the users. However, there may be	203	</p>
204	certain situations in which you may decide a profile change is necessary.	204
205	</p>	205	<warn>
		206	Do <e>not</e> edit the profile files directly. Gentoo provides other means to
		207	customize and extend these settings.
		208	</warn>
206		209
207	<p>	210	<p>
208	You can see what profile you are currently using with the following command:	211	You can see what profile you are currently using with the following command:

Lines 48-54 Link Here

(-)hb-portage-configuration.xml (-9 / +9 lines)
48	<ul>	48	<ul>
49	<li>	49	<li>
50	CFLAGS & CXXFLAGS define the desired compiler flags for C and C++	50	CFLAGS & CXXFLAGS define the desired compiler flags for C and C++
51	compiling.	51	compiling
52	</li>	52	</li>
53	<li>	53	<li>
54	CHOST defines the build host information for the application's configure	54	CHOST defines the build host information for the application's configure
Lines 57-63 Link Here
57	<li>	57	<li>
58	MAKEOPTS is passed to the <c>make</c> command and is usually set to define	58	MAKEOPTS is passed to the <c>make</c> command and is usually set to define
59	the amount of parallelism used during the compilation. More information	59	the amount of parallelism used during the compilation. More information
60	about the make options can be found in the <c>make</c> man page.	60	about the make options can be found in the <c>make</c> man page
61	</li>	61	</li>
62	</ul>	62	</ul>
63		63
Lines 153-160 Link Here
153		153
154	<ul>	154	<ul>
155	<li>	155	<li>
156	GENTOO_MIRRORS defines a list of server locations which	156	GENTOO_MIRRORS defines a list of server locations which contain source code
157	contain source code (distfiles)	157	(distfiles)
158	</li>	158	</li>
159	<li>	159	<li>
160	PORTAGE_BINHOST defines a particular server location containing prebuilt	160	PORTAGE_BINHOST defines a particular server location containing prebuilt
Lines 233-249 Link Here
233	PORTAGE_RSYNC_OPTS sets a number of default variables used during sync,	233	PORTAGE_RSYNC_OPTS sets a number of default variables used during sync,
234	each space-separated. These shouldn't be changed unless you know	234	each space-separated. These shouldn't be changed unless you know
235	<e>exactly</e> what you're doing. Note that certain absolutely required	235	<e>exactly</e> what you're doing. Note that certain absolutely required
236	options will always be used even if PORTAGE_RSYNC_OPTS is empty.	236	options will always be used even if PORTAGE_RSYNC_OPTS is empty
237	</li>	237	</li>
238	<li>	238	<li>
239	PORTAGE_RSYNC_EXTRA_OPTS can be used to set additional options when	239	PORTAGE_RSYNC_EXTRA_OPTS can be used to set additional options when
240	syncing. Each option should be space separated.	240	syncing. Each option should be space separated
241	<ul>	241	<ul>
242	<li>	242	<li>
243	--timeout=<number>: This defines the number of seconds an rsync	243	--timeout=<number>: This defines the number of seconds an rsync
244	connection can idle before rsync sees the connection as timed-out. This	244	connection can idle before rsync sees the connection as timed-out. This
245	variable defaults to 180 but dialup users or individuals with slow	245	variable defaults to 180 but dialup users or individuals with slow
246	computers might want to set this to 300 or higher.	246	computers might want to set this to 300 or higher
247	</li>	247	</li>
248	<li>	248	<li>
249	--exclude-from=/etc/portage/rsync_excludes: This points to a file	249	--exclude-from=/etc/portage/rsync_excludes: This points to a file
Lines 251-257 Link Here
251	update process. In this case, it points to	251	update process. In this case, it points to
252	<path>/etc/portage/rsync_excludes</path>. Please read <uri	252	<path>/etc/portage/rsync_excludes</path>. Please read <uri
253	link="?part=3&chap=5">Using a Portage Tree Subset</uri> for the	253	link="?part=3&chap=5">Using a Portage Tree Subset</uri> for the
254	syntax of this file.	254	syntax of this file
255	</li>	255	</li>
256	<li>--quiet: Reduces output to the screen</li>	256	<li>--quiet: Reduces output to the screen</li>
257	<li>--verbose: Prints a complete filelist</li>	257	<li>--verbose: Prints a complete filelist</li>
Lines 261-267 Link Here
261	<li>	261	<li>
262	PORTAGE_RSYNC_RETRIES defines how many times rsync should try connecting to	262	PORTAGE_RSYNC_RETRIES defines how many times rsync should try connecting to
263	the mirror pointed to by the SYNC variable before bailing out. This	263	the mirror pointed to by the SYNC variable before bailing out. This
264	variable defaults to 3.	264	variable defaults to 3
265	</li>	265	</li>
266	</ul>	266	</ul>
267		267

Lines 313-342 Link Here

(-)hb-portage-files.xml (-10 / +10 lines)
313	<ul>	313	<ul>
314	<li>	314	<li>
315	<c>save</c>: This saves one log per package in	315	<c>save</c>: This saves one log per package in
316	<path>$PORT_LOGDIR/elog</path>, or <path>/var/log/portage/elog</path> if	316	<path>$PORT_LOGDIR/elog/</path>, or <path>/var/log/portage/elog/</path>
317	$PORT_LOGDIR is not defined.	317	if $PORT_LOGDIR is not defined
318	</li>	318	</li>
319	<li>	319	<li>
320	<c>custom</c>: Passes all messages to a user-defined command in	320	<c>custom</c>: Passes all messages to a user-defined command in
321	$PORTAGE_ELOG_COMMAND; this will be discussed later.	321	$PORTAGE_ELOG_COMMAND; this will be discussed later
322	</li>	322	</li>
323	<li>	323	<li>
324	<c>syslog</c>: Sends all messages to the installed system logger.	324	<c>syslog</c>: Sends all messages to the installed system logger
325	</li>	325	</li>
326	<li>	326	<li>
327	<c>mail</c>: Passes all messages to a user-defined mailserver in	327	<c>mail</c>: Passes all messages to a user-defined mailserver in
328	$PORTAGE_ELOG_MAILURI; this will be discussed later. The mail features	328	$PORTAGE_ELOG_MAILURI; this will be discussed later. The mail features
329	of elog require >=<c>portage-2.1.1</c>.	329	of elog require >=<c>portage-2.1.1</c>
330	</li>	330	</li>
331	<li>	331	<li>
332	<c>save_summary</c>: Similar to <c>save</c>, but it merges all messages	332	<c>save_summary</c>: Similar to <c>save</c>, but it merges all messages
333	in <path>$PORT_LOGDIR/elog/summary.log</path>, or	333	in <path>$PORT_LOGDIR/elog/summary.log</path>, or
334	<path>/var/log/portage/elog/summary.log</path> if $PORT_LOGDIR is not	334	<path>/var/log/portage/elog/summary.log</path> if $PORT_LOGDIR is not
335	defined.	335	defined
336	</li>	336	</li>
337	<li>	337	<li>
338	<c>mail_summary</c>: Similar to <c>mail</c>, but it sends all messages	338	<c>mail_summary</c>: Similar to <c>mail</c>, but it sends all messages
339	in a single mail when emerge exits.	339	in a single mail when emerge exits
340	</li>	340	</li>
341	</ul>	341	</ul>
342	</li>	342	</li>
Lines 355-361 Link Here
355	<li>	355	<li>
356	PORTAGE_ELOG_MAILURI: This contains settings for the <c>mail</c> module	356	PORTAGE_ELOG_MAILURI: This contains settings for the <c>mail</c> module
357	such as address, user, password, mailserver, and port number. The default	357	such as address, user, password, mailserver, and port number. The default
358	setting is "root@localhost localhost".	358	setting is "root@localhost localhost"
359	</li>	359	</li>
360	<li>	360	<li>
361	Here's an example for an smtp server that requires username and	361	Here's an example for an smtp server that requires username and
Lines 370-382 Link Here
370	</li>	370	</li>
371	<li>	371	<li>
372	PORTAGE_ELOG_MAILFROM: Allows you to set the "from" address of log mails;	372	PORTAGE_ELOG_MAILFROM: Allows you to set the "from" address of log mails;
373	defaults to "portage" if unset.	373	defaults to "portage" if unset
374	</li>	374	</li>
375	<li>	375	<li>
376	PORTAGE_ELOG_MAILSUBJECT: Allows you to create a subject line for log	376	PORTAGE_ELOG_MAILSUBJECT: Allows you to create a subject line for log
377	mails. Note that you can make use of two variables: ${PACKAGE} will display	377	mails. Note that you can make use of two variables: ${PACKAGE} will display
378	the package name and version, while ${HOST} is the fully qualified domain	378	the package name and version, while ${HOST} is the fully qualified domain
379	name of the host Portage is running on.	379	name of the host Portage is running on
380	</li>	380	</li>
381	<li>	381	<li>
382	Here's one possible use:	382	Here's one possible use: