Source

illumos-userland /

Filename Size Date modified Message
components
doc
make-rules
tools
transforms
63 B
1.3 KB
1.4 KB
4.1 KB
	    Getting started with illumos userland 


Getting Started

    This README provides a very brief overview of the gate, how to retrieve
    a copy, and how to build it.  Detailed documentation about the Userland
    gate can be found at

	http://wiki.openindiana.org/oi/Building+with+illumos-userland

    The project issue tracker can be found out at

	https://www.illumos.org/projects/illumos-userland

    Questions or comments about the gate can be addressed to
    userland@lists.illumos.org.

Overview

    The main Mercurial gate is located at

	ssh://anonhg@hg.illumos.org/illumos-userland/
    
    This gate contains build recipies, patches, IPS manifests, etc. necessary
    to download, prep, build, test, package and publish open source software.
    In order to build the contents of illumos-userland, you need to clone it.
    If you are reading this, you probably already have.

Getting the Bits

    As mentioned, the gate is stored in a Mercurial repository.  In order to
    build or develop in the gate, you will need to clone it.  You can do so
    with the following command
    
      $ hg clone ssh://anonhg@hg.illumos.org/illumos-userland/

    There is also a development branch that stores work-in-progress. You can
    clone that repository with the following command

      $ hg clone ssh://hg@hg.bitbucket.org/illumos_userland/illumos-userland

    This will create a replica of the various pieces that are checked into the
    source code management system, but it does not retrieve the community
    source archives associated with the gate content.  To download the
    community source associated with your cloned workspace, you will need to
    execute the following:

      $ cd illumos-userland/components
      $ gmake download

    This will use GNU make and the downloading tool in the gate to walk through
    all of the component directories downloading and validating the community
    source archives from the gate machine or their canonical source repository.

    If you wish to keep a local cache of source, you can use the following
    command:

      $ cd <cache-dir>
      $ wget -m -nH -l 1 --no-parent -c --cut-dirs=2 \
	http://dlc.openindiana.org/oi-build/source-archives
      $ export ARCHIVE_MIRROR=<cache-dir>

    Some operations (e.g. gmake clobber) can cause source to be deleted from 
    the workspace. Having a cache means that you will retain a copy of the 
    source outside the workspace and only need to copy it back. It also means
    that you can build without network access if cache and workspace are both
    up-to-date.

    There are two variation to this that you may find interesting.  First, you
    can cause gmake(1) to perform it's work in parallel by adding '-j (jobs)'
    to the command line.  Second, if you are only interested in working on a
    particular component, you can change directories to that component's
    directory and use 'gmake download' from that to only get its source
    archive.

Building the Bits.

    You can build individual components or the contents of the entire gate.

  Component build

    If you are only working on a single component, you can just build it using
    following:

      setup the workspace for building components

        $ cd (your-workspace)/components ; gmake setup

      build the individual component

        $ cd (component-dir) ; gmake publish

  Complete Top Down build  

    Complete top down builds are also possible by simply running

      $ cd (your-workspace)/components
      $ gmake publish

    The 'publish' target will build each component and publish it to the
    workspace IPS repo.
    Tools to help facilitate build zone creation will be integrated
    shortly.  If the zone you create to build your workspace in does not have
    networking enabled, you can pre-download any community source archives into
    your workspace from the global with:

      $ cd (your-workspace)/components
      $ gmake download

  You can add parallelism to your builds by adding '-j (jobs)' to your gmake
  command line arguments.

  The gate should only incrementally build what it needs to based on what has
  changed since you last built it.