Difference between pages "Funtoo Profiles" and "Creating Profiles"

From Funtoo
(Difference between pages)
Jump to navigation Jump to search
 
 
Line 1: Line 1:
== What is a profile? ==
Want to create your own custom profiles? Thought up a mix-in that's not currently in the Funtoo profiles? Have an overlay with profiles and want to make it easy for people to use them? Well you've come to the right place. This article will show you how to easily add you own profiles. No more ugly hacking of parent files and other nonsense. Once you follow this guide, not only will portage easily recognize your profiles, they will also show up in eselect right along with the ones from the main tree.


In Gentoo and Funtoo Linux, profiles are used to define base system settings, and have historically had a lot of untapped potential. In Funtoo Linux, I wanted to take advantage of some of this potential to allow Funtoo Linux users to easily tailor their system for various types of roles. Enter the new Funtoo profile system.
== How to do it ==
=== Rules to follow ===
#You will need a version of [[Package:Eselect|eselect]] that supports Funtoo profiles (already integrated into Funtoo Linux.)
#Your overlay must have a profiles directory. It must include a repo_name file with the name of your overlay.  
#Your profiles must be inside of the profiles directory
#You need a profiles.eselect.desc file inside the profiles directory. See profiles.eselect.example in your Funtoo Portage tree for instructions.
#If you're creating profiles of types arch, build, flavor, or mix-ins, your profile must be inside a directory with same name, such as <tt>profiles/my_profile/flavor/new_profile</tt>, <tt>profiles/my_profile/mix-ins/subdir/profile</tt>.
# Currently <tt>NoMix</tt> (see <tt>profiles.eselect.example</tt>) is only supported for profiles in the same tree.
# If you're not using a standard Funtoo tree, you must ensure that your main Portage tree has <tt>profile-formats = portage-2</tt> set in <tt>metadata/layout.conf</tt> in order for portage to interpret the <repo_name>:<profile> syntax.


== What It Is ==
=== Example of how to set up ===
For our example we will create a mix-ins profile called 'fake_pro' in a local overlay called 'local_overlay'. fake_pro will set the 'dummy' USE flag globally and also set the 'fake' USE flag on sys-apps/not-exist. We will then add the profile to eselect so it's visible when running 'eselect profile'.


Historically, users have had to add a ton of settings to <tt>/etc/make.conf</tt> to customize their Gentoo or Funtoo Linux system, which made setup of the operating system more difficult than it should be.
==== Creating the profile ====
 
We will use ''<code>${OVERLAY_DIR}</code>'' as the path to local_overlay. These instructions assume the overlay exists.
In Gentoo Linux, it is possible to only define one ''system profile''. Think of a system profile as the default settings that Portage uses for building everything on your system.
If you haven't set a name for your overlay, do that first:
 
In Funtoo Linux, multiple profiles can be enabled at the same time. These include:
 
* '''arch''' - one arch profile is enabled, at build time, and is not changed. This defines CPU architecture-specific settings.
* '''build''' - one build profile is enabled, at build time, and is generally not changed. It defines the type of build, such as 'current' or 'stable', and associated settings.
* '''flavor''' - one flavor is enabled per system, and can be changed by the user. This defines the general use of the system, such as 'minimal', 'core', 'desktop', 'workstation'
* '''mix-in''' - zero or more mix-ins can be enabled that enable settings specific to a particular subset of features, such as 'gnome', 'kde', 'media', 'mate', 'X', 'hardened'
 
{{Fancynote|1=
See [[Flavors and Mix-ins]] for a complete list of all flavors and mix-ins available in Funtoo Linux, along with descriptions of what each one does.}}
 
=== Origins and Benefits ===
 
This new system is really a completion of the original cascading profile design that was designed by Daniel Robbins and implemented by Seemant Kulleen as part of Portage. Funtoo Profiles designed to leverage the existing cascading profile system and provide something much more useable and maintainable for users and developers alike. Here are some of its benefits:
 
* Fewer settings in /etc/make.conf. <tt>CHOST</tt> and <tt>ARCH</tt> no longer set in <tt>/etc/make.conf</tt>.
* Separation of concerns -- arch, build, and flavor-related settings are organized together.
* User flexibility - any number of mix-ins can be enabled to tweak masks or USE settings as needed.
 
{{fancynote|See [[Custom Profiles]] for information on how to extend the profile system.}}
 
== What It Looks Like ==
Here's a what a list of profiles looks like:
<console>
<console>
###i## eselect profile list
###i## echo "local_overlay" > ${OVERLAY_DIR}/profiles/repo_name
Currently available arch profiles:
  [1]  funtoo/1.0/linux-gnu/arch/x86-32bit
  [2]  funtoo/1.0/linux-gnu/arch/x86-64bit
Currently available build profiles:
  [3]  funtoo/1.0/linux-gnu/build/stable
  [4]  funtoo/1.0/linux-gnu/build/current
  [5]  funtoo/1.0/linux-gnu/build/experimental
Currently available flavor profiles:
  [6]  funtoo/1.0/linux-gnu/flavor/minimal
  [7]  funtoo/1.0/linux-gnu/flavor/core
  [8]  funtoo/1.0/linux-gnu/flavor/desktop
  [9]  funtoo/1.0/linux-gnu/flavor/workstation
Currently available mix-ins profiles:
  [10]  funtoo/1.0/linux-gnu/mix-ins/audio
  [11]  funtoo/1.0/linux-gnu/mix-ins/console-extras
  [12]  funtoo/1.0/linux-gnu/mix-ins/dvd
  [13]  funtoo/1.0/linux-gnu/mix-ins/gnome
  [14]  funtoo/1.0/linux-gnu/mix-ins/kde
  [15]  funtoo/1.0/linux-gnu/mix-ins/media
  [16]  funtoo/1.0/linux-gnu/mix-ins/print
  [17]  funtoo/1.0/linux-gnu/mix-ins/python3-only
  [18]  funtoo/1.0/linux-gnu/mix-ins/rhel5-compat
  [19]  funtoo/1.0/linux-gnu/mix-ins/server-db
  [20]  funtoo/1.0/linux-gnu/mix-ins/server-mail
  [21]  funtoo/1.0/linux-gnu/mix-ins/server-web
  [22]  funtoo/1.0/linux-gnu/mix-ins/X
  [23]  funtoo/1.0/linux-gnu/mix-ins/xfce
</console>
</console>
As you can see, there are multiple types of profiles to choose from.
Let's move on to how to start using it.


== Switch to the Funtoo 1.0 Profile ==
Next lets create a directory to store our profile. Since we're creating a 'mix-ins' profile we need to make sure our profile is inside a 'mix-ins' subdirectory. This is a requirement in order to ensure that the profile will show up in eselect. If your not planning on using eselect then there's no requirement to use 'mix-ins'
 
=== Using eselect ===
The preferred method of adding and removing profiles is to use [[eselect|eselect profile]]. This ensures that profiles are added correctly and in the proper order. The order is very important for things to work right.
For a list of options, run:
<console>
<console>
###i## eselect profile help
###i## install -d ${OVERLAY_DIR}/profiles/my_profiles/mix-ins/fake_pro
</console>
</console>


As stated by the previous command output, let's see the list of what profiles currently defined the option '''list''':
Now that we have a directory for our profile, lets go ahead and add our settings. Global USE settings go in ''<code>make.defaults</code>'', package specific USE settings go in ''<code>package.use</code>'':
 
<console>
<console>
###i## eselect profile list
###i## cd ${OVERLAY_DIR}/profiles/my_profiles/mix-ins/fake_pro
Currently available arch profiles:
###i## echo 'USE="$USE dummy"' >> make.defaults
  [1]  funtoo/1.0/linux-gnu/arch/x86-64bit *
###i## echo 'sys-apps/not-exist fake' >> package.use
Currently available build profiles:
  [2]  funtoo/1.0/linux-gnu/build/stable
  [3]  funtoo/1.0/linux-gnu/build/current *
  [4]  funtoo/1.0/linux-gnu/build/experimental
Currently available flavor profiles:
  [5]  funtoo/1.0/linux-gnu/flavor/minimal
  [6]  funtoo/1.0/linux-gnu/flavor/core
  [7]  funtoo/1.0/linux-gnu/flavor/desktop *
Currently available mix-ins profiles:
  [8]  funtoo/1.0/linux-gnu/mix-ins/dvd
  [9]  funtoo/1.0/linux-gnu/mix-ins/gnome
  [10]  funtoo/1.0/linux-gnu/mix-ins/kde
  [11]  funtoo/1.0/linux-gnu/mix-ins/media
  [12]  funtoo/1.0/linux-gnu/mix-ins/rhel5-compat
  [13]  funtoo/1.0/linux-gnu/mix-ins/server-db
  [14]  funtoo/1.0/linux-gnu/mix-ins/server-mail
  [15]  funtoo/1.0/linux-gnu/mix-ins/server-web
  [16]  funtoo/1.0/linux-gnu/mix-ins/workstation
  [17]  funtoo/1.0/linux-gnu/mix-ins/workstation-minimal
</console>
</console>
Note that no matter if your using funtoo or gentoo, profile settings all work the same. For more information please check the portage man page.


As in several other Funtoo utilities, a star on the right indicates an active item (your case may differ from the example above). To add, say, the mix-ins '''dvd''', '''kde''' and '''media''' you have to enter:
==== Adding to eselect ====
 
eselect reads from the file ''<code>profiles.eselect.desc</code>'' in your profiles/ directory. Format is "Type Name Status NoMix" space-separated. For more information look in ''<code>/usr/portage/profiles/profiles.eselect.example</code>'':
<console>
<console>
###i## eselect profile add 8
###i## echo 'mix-ins my_profiles/mix-ins/fake_pro testing' >> ${OVERLAY_DIR}/profiles/profiles.eselect.desc
###i## eselect profile add 10
###i## eselect profile add 11
</console>
</console>
 
Watch the result:
Or, in a one-shot:
 
<console>
<console>
###i## eselect profile add 8 10 11
###i## eselect profile list
</console>
 
Verification:
 
<console>
###i## eselect profile list
Currently available arch profiles:
  [1]  funtoo/1.0/linux-gnu/arch/x86-64bit *
Currently available build profiles:
  [2]  funtoo/1.0/linux-gnu/build/stable
  [3]  funtoo/1.0/linux-gnu/build/current *
  [4]  funtoo/1.0/linux-gnu/build/experimental
Currently available flavor profiles:
  [5]  funtoo/1.0/linux-gnu/flavor/minimal
  [6]  funtoo/1.0/linux-gnu/flavor/core
  [7]  funtoo/1.0/linux-gnu/flavor/desktop *
Currently available mix-ins profiles:
  [8]  funtoo/1.0/linux-gnu/mix-ins/dvd *
  [9]  funtoo/1.0/linux-gnu/mix-ins/gnome
  [10]  funtoo/1.0/linux-gnu/mix-ins/kde *
  [11]  funtoo/1.0/linux-gnu/mix-ins/media *
  [12]  funtoo/1.0/linux-gnu/mix-ins/rhel5-compat
  [13]  funtoo/1.0/linux-gnu/mix-ins/server-db
  [14]  funtoo/1.0/linux-gnu/mix-ins/server-mail
  [15]  funtoo/1.0/linux-gnu/mix-ins/server-web
  [16]  funtoo/1.0/linux-gnu/mix-ins/workstation
  [17]  funtoo/1.0/linux-gnu/mix-ins/workstation-minimal
</console>
 
{{Fancynote| You must use the numbers to reference the profiles bits you want.}}
 
No magic here, what you add is put by portage in the <tt>/etc/portage/make.profile/parent</tt> file. In the present case this file contains:
 
<console>
###i## cat /etc/portage/make.profile/parent
gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
gentoo:funtoo/1.0/linux-gnu/build/current
gentoo:funtoo/1.0/linux-gnu/flavor/desktop
gentoo:funtoo/1.0/linux-gnu/mix-ins/dvd
gentoo:funtoo/1.0/linux-gnu/mix-ins/gnome
gentoo:funtoo/1.0/linux-gnu/mix-ins/kde
gentoo:funtoo/1.0/linux-gnu/mix-ins/media
</console>
</console>


== For Developers ==
=== Define the profile sub-sets you will use ===
So far in Funtoo we have used the exact same profiles as Gentoo thus Funtoo/2008.0 was strictly the same thing as Gentoo/2008.0 or the barely the same 10.0. This (monolithic) profile was set though a symbolic link named '''/etc/make.profile''' pointing on a complex directory architecture located somewhere under '''/usr/portage/profiles'''. This is no longer valid with the Funtoo 1.0 profiles as they are split in several smaller bricks which are then glued together via the  '''/etc/portage/make.profile/parent''' file (You do not need to include everything, just use the "bricks" you need). Those bricks belongs to several categories:
1. MANDATORY -- An "arch" profile which defines settings for a particular architecture. You'll want to set this to whatever arch your system is and leave it alone. '''Setting it to a different arch than your system could severely break it.'''
2. MANDATORY -- A "build" profile which should match the tree you wish to use. '''Stable''', '''Current''' (~arch), or '''Experimental''' (use it if you are brave enough and find '''current''' too stable).
3. MANDATORY -- A "flavor" profile (what was previously known as ''profiles'' is still known as such in Gentoo) which describes the kind of system you want.
* minimal - Be warned, minimal is exactly what it says, the minimal profile stuff you need for a usable system, nothing else. This is really for people who know what they're doing.
* core - This is the core profile. This is for stuff that affects both desktops and servers.
* desktop - Exactly what it says. If you're using a desktop, you should set this as your flavor.
* server - If you're running a server, you should set this as your flavor.
4. OPTIONAL -- One or more "mix-ins" profiles which describe optional add-ons. 'mix-ins' are the heart of the Funtoo 1.0 profiles. Unlike the monolithic profiles which sets a massive amount of use flags and options for you, we've split them into logical add-on profiles. For instance if you want support for gnome, you would add the gnome mix-in to your current profiles. That mix-in sets all the proper use flags and such for gnome. Same with others. Want dvd support? Add that one in. Using a rhel5 kernel which requires special versions of packages such as udev? There's a mix-in for that too. Run a mail server? web server? There's mix-ins for those also. Expect this category to grow in the future as new mix-ins are created.
The contents of '''/etc/portage/make.profile/parent''' for a basic setup might look like this:
<pre>
gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
gentoo:funtoo/1.0/linux-gnu/build/current
gentoo:funtoo/1.0/linux-gnu/flavor/core
</pre>
A more rounded setup for a desktop might look like this:
<pre>
gentoo:funtoo/1.0/linux-gnu/arch/x86-64bit
gentoo:funtoo/1.0/linux-gnu/build/current
gentoo:funtoo/1.0/linux-gnu/flavor/desktop
gentoo:funtoo/1.0/linux-gnu/mix-ins/dvd
gentoo:funtoo/1.0/linux-gnu/mix-ins/media
</pre>
== Related ==
* [[Flavors and Mix-ins]]
[[Category:Funtoo features]]
[[Category:Portage]]
[[Category:Portage]]
[[Category:Labs]]
[[Category:Labs]]
[[Category:HOWTO]]
[[Category:HOWTO]]
[[Category:Official Documentation]]
[[Category:Featured]]

Revision as of 04:00, July 4, 2014

Want to create your own custom profiles? Thought up a mix-in that's not currently in the Funtoo profiles? Have an overlay with profiles and want to make it easy for people to use them? Well you've come to the right place. This article will show you how to easily add you own profiles. No more ugly hacking of parent files and other nonsense. Once you follow this guide, not only will portage easily recognize your profiles, they will also show up in eselect right along with the ones from the main tree.

How to do it

Rules to follow

  1. You will need a version of eselect that supports Funtoo profiles (already integrated into Funtoo Linux.)
  2. Your overlay must have a profiles directory. It must include a repo_name file with the name of your overlay.
  3. Your profiles must be inside of the profiles directory
  4. You need a profiles.eselect.desc file inside the profiles directory. See profiles.eselect.example in your Funtoo Portage tree for instructions.
  5. If you're creating profiles of types arch, build, flavor, or mix-ins, your profile must be inside a directory with same name, such as profiles/my_profile/flavor/new_profile, profiles/my_profile/mix-ins/subdir/profile.
  6. Currently NoMix (see profiles.eselect.example) is only supported for profiles in the same tree.
  7. If you're not using a standard Funtoo tree, you must ensure that your main Portage tree has profile-formats = portage-2 set in metadata/layout.conf in order for portage to interpret the <repo_name>:<profile> syntax.

Example of how to set up

For our example we will create a mix-ins profile called 'fake_pro' in a local overlay called 'local_overlay'. fake_pro will set the 'dummy' USE flag globally and also set the 'fake' USE flag on sys-apps/not-exist. We will then add the profile to eselect so it's visible when running 'eselect profile'.

Creating the profile

We will use ${OVERLAY_DIR} as the path to local_overlay. These instructions assume the overlay exists. If you haven't set a name for your overlay, do that first:

root # echo "local_overlay" > ${OVERLAY_DIR}/profiles/repo_name

Next lets create a directory to store our profile. Since we're creating a 'mix-ins' profile we need to make sure our profile is inside a 'mix-ins' subdirectory. This is a requirement in order to ensure that the profile will show up in eselect. If your not planning on using eselect then there's no requirement to use 'mix-ins'

root # install -d ${OVERLAY_DIR}/profiles/my_profiles/mix-ins/fake_pro

Now that we have a directory for our profile, lets go ahead and add our settings. Global USE settings go in make.defaults, package specific USE settings go in package.use:

root # cd ${OVERLAY_DIR}/profiles/my_profiles/mix-ins/fake_pro
root # echo 'USE="$USE dummy"' >> make.defaults
root # echo 'sys-apps/not-exist fake' >> package.use

Note that no matter if your using funtoo or gentoo, profile settings all work the same. For more information please check the portage man page.

Adding to eselect

eselect reads from the file profiles.eselect.desc in your profiles/ directory. Format is "Type Name Status NoMix" space-separated. For more information look in /usr/portage/profiles/profiles.eselect.example:

root # echo 'mix-ins my_profiles/mix-ins/fake_pro testing' >> ${OVERLAY_DIR}/profiles/profiles.eselect.desc

Watch the result:

root # eselect profile list