Getting started with the Userland Consolidation
This README provides a very brief overview of the gate (i.e., source
code repository), how to retrieve a copy, and how to build it. Detailed
documentation about the Userland gate can be found in the
The Userland consolidation maintains a project at
That repo contains build recipes, patches, IPS (i.e., pkg(7)) manifests, and other files necessary to download, prep, build, test, package and publish open source software. The build infrastructure makes use of hierarchical Makefiles which provide dependency and recipe information for building the components. In order to build the contents of the Userland gate, you need to clone it. Since you are reading this, you may already have.
Getting the Bits
The canonical repository internal to Oracle is stored in Mercurial, and is mirrored to an external Git repository on GitHub. In order to build or develop in the gate, you will need to clone it. You can do so with one of the following commands. Internal:
$ hg clone ssh://email@example.com//gates/gate /scratch/clone
$ git clone https://github.com/oracle/solaris-userland /scratch/clone
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 /scratch/clone/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.
There are two variation to this that you may find interesting. First, you
can cause gmake(1) to perform its work in parallel by adding
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
Building the Bits.
You can build individual components or the contents of the entire gate.
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
publish target will build each component and publish it to the
workspace IPS repo.
- 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.
Copyright (c) 2010, 2017, Oracle and/or its affiliates. All rights reserved.