Tree [12c935] master /
History



File Date Author Commit
bin 2011-06-19 Dirk Wallenstein Dirk Wallenstein [dfe803] shell: Use the module-db to create a prompt sign
hooks 2010-11-03 Dirk Wallenstein Dirk Wallenstein [b5b9cb] Implement callback with main command line option
lib 2012-03-31 Dirk Wallenstein Dirk Wallenstein [12c935] CheckpointDictionary: Fix default dict fallback...
lib-run-from-source 2010-10-08 Dirk Wallenstein Dirk Wallenstein [5b2803] Allow to run xjhbuild from the source directory
plugins 2012-03-31 Dirk Wallenstein Dirk Wallenstein [dcd65d] switch: Fail for invalid configuration token
var 2011-06-21 Dirk Wallenstein Dirk Wallenstein [b04eb2] Example prompt without bold foreground
.gitignore 2010-10-08 Dirk Wallenstein Dirk Wallenstein [5b2803] Allow to run xjhbuild from the source directory
.gitmodules 2011-04-10 Dirk Wallenstein Dirk Wallenstein [c84ea3] gitmodules: Use the official git-python repository
COPYING 2010-05-06 Dirk Wallenstein Dirk Wallenstein [e1fd80] Initial version 0.1
Makefile 2011-05-18 Dirk Wallenstein Dirk Wallenstein [ef55ff] Add a documented example extension-moduleset
README 2010-11-16 Dirk Wallenstein Dirk Wallenstein [c4d3e4] README: Update for the next release
xjhrc.example 2011-08-31 Dirk Wallenstein Dirk Wallenstein [0e591c] xjhrc.example: Correct the recursive alias expa...

Read Me

X-JHBuild
=========

# Copyright 2010 Dirk Wallenstein

X-JHBuild is a framework for building and working with X.org modules.
It makes use of JHBuild and is specialized for working with modules that
use Git as VCS.

The goal is to let a user easily build a complete set of bleeding edge modules,
but it also offers a lot of possibilities for customization, to ease up
development.

This is work in progress, and until there is nice documentation, you are
encouraged to rummage through the commit messages, release mails, and
help output of subcommands.

Requirements
------------
A Git version >= 1.7 is recommended. Otherwise, it is not possible to use the
sign in the prompt, the navigation helper, and the CWD-Module adaption.
A Python-2 version >= 2.6 is required.

Installing X-JHBuild
--------------------
To install X-JHBuild and private versions of JHBuild [1] and Git-Python [4]
execute the following commands:
    $> git clone git://x-jhbuild.git.sourceforge.net/gitroot/x-jhbuild/x-jhbuild
    $> cd x-jhbuild
    $> make install
It creates ~/.x-jhbuild where it is possible to customize global aspects of
X-JHBuild. The '.internal' subdirectory is a temporary installation location --
files in there will be overwritten and possibly wiped out when updating
X-JHBuild.
The main script must be accessible in PATH. It's located at:
  ~/.local/bin/xjh
There are useful shell helpers in:
  ~/.local/share/x-jhbuild/shell-utility-functions.sh

Building
--------
If all you want is to quickly build all bleeding edge X.org modules, just
navigate to a (possibly new) directory where you want to have all the sources
and execute:
  xjh init
  xjh build
If you want to build the xorg-server and all drivers, while following the
progress in a nice HTML log, execute the following:
  xjh tinderwrap start xorg-drivers

Help
----
Get main help and a list of all X-JHBuild subcommands:
  xjh -h
Get a list of all JHBuild subcommands (this only works in an initialized
repository group):
  xjh help
All subcommands support the -h/--help options:
  xjh <subcommand> -h

This is work in progress and in particular the documentation will improve in
the future. Please use the references for more help. In particular the JHBuild
documentation [2] [3] will be helpful.

Old Mails:
----------
There are some ancient mails which might give a bit of context, but
there is also a lot of obsolete information in them:
http://lists.freedesktop.org/archives/xorg-devel/2010-May/008111.html
http://lists.freedesktop.org/archives/xorg-devel/2010-May/008478.html
http://lists.freedesktop.org/archives/xorg-devel/2010-June/009990.html

References
----------
[1] http://live.gnome.org/Jhbuild
[2] http://library.gnome.org/devel/jhbuild/unstable/
[3] http://www.x.org/wiki/JhBuildInstructions
[4] http://packages.python.org/GitPython/0.3/index.html