# HG changeset patch # User Nicolas Chauvat # Date 1229969438 -3600 # Node ID 843e0b1bf9916908d65b6bcb4cd563d03e17ad2e # Parent 97361ddaf342528e5c10c57e4814b179788ad45d [doc] simpler install and mercurial instructions diff -r 97361ddaf342 -r 843e0b1bf991 doc/book/en/C011-installation.en.txt --- a/doc/book/en/C011-installation.en.txt Mon Dec 22 19:06:36 2008 +0100 +++ b/doc/book/en/C011-installation.en.txt Mon Dec 22 19:10:38 2008 +0100 @@ -5,21 +5,29 @@ Installation ============ -Installation of `Cubicweb` and its dependancies +Installation of `Cubicweb` and its dependencies ----------------------------------------------- -`CubicWeb` is available as a debian package as well as an archive. -We will detail here the two easiest way to set-up `CubciWeb` -environment. +`CubicWeb` is packaged for Debian and Ubuntu, but can be installed from source +using a tarball or the Mercurial version control system. Debian and Ubuntu packages ``````````````````````````` Depending on the distribution you are using, add the appropriate line to your list -of sources (for example by editing ``/etc/apt/sources.list``) :: +of sources (for example by editing ``/etc/apt/sources.list``). + +For Debian Lenny:: deb http://ftp.logilab.org/dists/ lenny/ + +For Debian Sid:: + + deb http://ftp.logilab.org/dists/ sid/ + +For Ubuntu Hardy:: + deb http://ftp.logilab.org/dists/ hardy/ - deb http://ftp.logilab.org/dists/ sid/ + You can now install the required packages with the following command: :: @@ -27,29 +35,28 @@ This is it! -``tar.gz`` archive -`````````````````` +Install from source +``````````````````` -You can download our sources at: :: +You can download the archive containing the sources from our `ftp site`_ at: :: http://ftp.logilab.org/pub/cubicweb/ -Unpack the sources - - - +.. _`ftp site`: http://ftp.logilab.org/pub/cubicweb/ -.. note:: - `CubicWeb` is also available as a Mercurial repository using the forest - extension (see :ref:`MercurialForestInstall` for more details). +or keep up to date with on-going development by using Mercurial and its forest +extension:: + hg fclone http://www.logilab.org/hg/forests/cubicweb + +See :ref:`MercurialPresentation` for more details about Mercurial. Postgres installation ````````````````````` -Please refer to the project online documentation Postgres_. +Please refer to the `Postgresql project online documentation`_. -.. _Postgres: http://www.postgresql.org/ +.. _`Postgres project online documentation`: http://www.postgresql.org/ You need to install the three following packages: `postgres-8.3`, `postgres-contrib-8.3` and `postgresql-plpython-8.3`. diff -r 97361ddaf342 -r 843e0b1bf991 doc/book/en/D060-mercurial.en.txt --- a/doc/book/en/D060-mercurial.en.txt Mon Dec 22 19:06:36 2008 +0100 +++ b/doc/book/en/D060-mercurial.en.txt Mon Dec 22 19:10:38 2008 +0100 @@ -16,6 +16,7 @@ It is also possible to get revisions from another repository or to export its own revisions from the local repository to another repository. +.. _Mercurial: http://www.selenic.com/mercurial/ In contrast to CVS/Subversion, we usually create a repository by project to manage. @@ -30,7 +31,7 @@ `````````````` * Create a local repository:: - hg clone ssh://orion//home/src/private/rep + hg clone ssh://myhost//home/src/repo * See the contents of the local repository (graphical tool in Tk):: @@ -38,7 +39,7 @@ * Add a sub-directory or file in the current directory:: - hg add rep + hg add subdir * Move to the working directory a specific revision (or last revision) from the local repository:: @@ -49,8 +50,8 @@ * Get in its local repository, the tree of revisions contained in a remote repository (this does not change the local directory):: - hg pull ssh://orion//home/src/private/rep - hg pull-u ssh://orion//home/src/private/rep # equivalent to pull + update + hg pull ssh://myhost//home/src/repo + hg pull -u ssh://myhost//home/src/repo # equivalent to pull + update * See what are the heads of branches of the local repository if a `pull` returned a new branch:: @@ -72,15 +73,15 @@ * Export to a remote repository, the tree of revisions in its content local respository (this does not change the local directory):: - hg push ssh://orion//home/src/private/rep + hg push ssh://myhost//home/src/repo * See what local revisions are not in another repository:: - hg outgoing ssh://orion//home/src/private/rep + hg outgoing ssh://myhost//home/src/repo * See what are the revisions of a repository not found locally:: - hg incoming ssh://orion//home/src/private/rep + hg incoming ssh://myhost//home/src/repo * See what is the revision of the local repository which has been taken out from the working directory and amended:: @@ -97,18 +98,36 @@ Best Practices `````````````` -* Think of making a `hg pull -u` regularly, and particularly before +* Remember to `hg pull -u` regularly, and particularly before a `hg commit`. -* Think of a `hg push` when your repository contains a version +* Remember to `hg push` when your repository contains a version relatively stable of your changes. -* If a `hg pull u` created a new branch head: +* If a `hg pull -u` created a new branch head: - 1. identify its identifier with `hg head` + 1. find its identifier with `hg head` 2. merge with `hg merge` 3. `hg ci` 4. `hg push` +Installation of the forest extension +```````````````````````````````````` -.. include:: D061-mercurial-forest.en.txt +Set up the forest extension by getting a copy of the sources +from http://hg.akoha.org/hgforest/ and adding the following +lines to your ``~/.hgrc``: :: + + [extensions] + hgext.forest= + # or, if forest.py is not in the hgext dir: + # forest=/path/to/forest.py + + +More information +```````````````` + +For more information about Mercurial, please refer to the Mercurial project online documentation_. + +.. _documentation: http://www.selenic.com/mercurial/wiki/ + diff -r 97361ddaf342 -r 843e0b1bf991 doc/book/en/D061-mercurial-forest.en.txt --- a/doc/book/en/D061-mercurial-forest.en.txt Mon Dec 22 19:06:36 2008 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,52 +0,0 @@ -.. -*- coding: utf-8 -*- - -.. _MercurialForestInstall: - -Installation of `CubicWeb` with Mercurial -========================================= - -`CubicWeb` is available as a Mercurial repository using the forest extension. -First make sure Mercurial is installed and that the forest extension is -available. - -Mercurial installation -`````````````````````` - -Please refer to the project online documentation Mercurial_. - -.. _Mercurial: http://www.selenic.com/mercurial/wiki/ - -We also provide in this book a quick guide on how to use -Mercurial (:ref:`MercurialPresentation`). - - -Installation of the forest extension -```````````````````````````````````` - -Set up the forest extension by getting a copy of the sources -from http://hg.akoha.org/hgforest/ and adding the following -lines to your ``~/.hgrc``: :: - - [extensions] - hgext.forest= - # or, if forest.py is not in the hgext dir: - # forest=/path/to/forest.py - -Get `CubicWeb` source code -`````````````````````````` - -Clone the forest in you working directory. - -:: - - hg fclone http://www.logilab.org/hg/forests/cubicweb - -.. note:: - We recommand you to create a symbolic link to the command ``cubicweb-ctl`` - as you will use it pretty often. - - :: - - $ ln -s /path/to/forest/cubicweb/bin/cubicweb-ctl ~/bin - -