README
author John Beck <John.Beck@Oracle.COM>
Wed, 09 Oct 2013 07:10:15 -0700
branchs11-update
changeset 2785 b6f5c5d1d0b7
parent 151 f9e42a3f7095
child 3836 56af60eb6020
permissions -rw-r--r--
PSARC 2013/140 greenlet version 0.4.0 - Python coroutines module PSARC 2013/142 iso8601 version 0.1.4 - Python date parsing module PSARC 2013/143 jsonpointer PSARC 2013/145 tempita version 0.5.1 - Python templating language module PSARC 2013/149 httplib2 version 0.8 PSARC 2013/150 prettytable version 0.7.2 PSARC 2013/151 jsonpatch PSARC 2013/152 repoze.lru version 0.6 PSARC 2013/153 Paste version 1.7.5.1 PSARC 2013/154 jsonschema PSARC 2013/156 webob version 1.2.3 PSARC 2013/157 routes version 1.13 PSARC 2013/161 anyjson PSARC 2013/164 paste.deploy version 1.5.0 PSARC 2013/165 FormEncode version 1.2.6 PSARC 2013/168 py-amqp version 1.0.11 PSARC 2013/170 eventlet PSARC 2013/171 passlib PSARC 2013/172 warlock PSARC 2013/173 sqlalchemy PSARC 2013/174 sqlalchemy-migrate PSARC 2013/175 rabbitmq PSARC 2013/176 pyrabbit PSARC 2013/177 librabbitmq PSARC 2013/179 filechunkio version 1.5 PSARC 2013/180 boto version 2.9.2 PSARC 2013/183 python-ldap version 2.4.10 PSARC 2013/187 Kombu version 2.5.10 PSARC 2013/241 six version 1.3.0 PSARC 2013/242 d2to1 version 0.2.10 PSARC 2013/245 stevedore version 0.10 PSARC 2013/246 pbr version 0.5.18 PSARC 2013/250 pyparsing version 1.5.7 PSARC 2013/251 cliff version 1.4 PSARC 2013/252 cmd2 version 0.6.5.1 PSARC 2013/253 suds version 0.4 PSARC 2013/254 alembic version 0.5.0 PSARC 2013/255 requests version 1.2.3 PSARC 2013/256 markupsafe version 0.18 PSARC 2013/279 importlib version 1.0.2 PSARC 2013/280 ordereddict version 1.1 16665240 The Python greenlet module should be added to Userland 16667497 add the Python eventlet module to Userland 16672571 The Python iso8601 module should be added to Userland 16679500 The Python prettytable module should be added to Userland 16682029 add the Python jsonschema module to Userland 16682050 add the Python anyjson module to Userland 16685766 The Python tempita module should be added to Userland 16688436 add the Python passlib module to Userland 16693200 The Python repoze.lru module should be added to Userland 16699958 The Python webob module should be added to Userland 16699986 The Python paste module should be added to Userland 16710493 The Python paste.deploy module should be added to Userland 16724221 The Python routes module should be added to Userland 16732554 add the Python jsonpatch module to Userland 16732628 add the Python jsonpointer module to Userland 16732673 add the Python warlock module to Userland 16734803 The Python formencode module should be added to Userland 16734806 The Python kombu module should be added to Userland 16734807 The Python httplib2 module should be added to Userland 16734808 The Python boto module should be added to Userland 16734812 The Python py-amqp module should be added to Userland 16740335 add the Python sqlalchemy module to Userland 16740866 add the Python sqlalchemy-migrate module to Userland 16746942 The python-ldap module should be added to Userland 16756023 The Python filechunkio module should be added to Userland 16776524 add RabbitMQ to Userland 16783170 add the Python librabbitmq module to Userland 16789370 add the Python pyrabbit module to Userland 17079852 The Python six module should be added to Userland 17081922 The Python pbr module should be added to Userland 17081941 The Python stevedore module should be added to Userland 17081952 The Python d2to1 module should be added to Userland 17171265 The Python pyparsing module should be added to Userland 17171761 The Python cliff module should be added to Userland 17171787 The Python cmd2 module should be added to Userland 17171805 The Python suds module should be added to Userland 17171821 The Python alembic module should be added to Userland 17171836 The Python requests module should be added to Userland 17171847 The Python markupsafe module should be added to Userland 17285026 The Python importlib module should be added to Userland 17285066 The Python ordereddict module should be added to Userland


	    Getting started with the Userland Consolidation


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 in the 'doc' directory.  Questions or comments about
    the gate can be addressed to [email protected].

Overview

    The Userland consolidation maintains a Mercurial gate at

        ssh://[email protected]//hg/userland/gate

    This gate contains build recipies, patches, IPS manifests, etc. necessary
    to download, prep, build, test, package and publish open source software.
    The build infrastructure is similiar to that of the SFW consolidation in
    that it makes use of herarchical 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 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://[email protected]//hg/userland/gate /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 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 it's 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.