# HG changeset patch # User Sandrine Ribeau # Date 1227143134 28800 # Node ID 8a62d2db3392c38486b4c69e98bf8842f2844c77 # Parent 9f9ae864d0ccad428c23242781174f348bb97218 [doc] Reorganization of Appendix : includes now mercurial presentation and splits modules in two sets. diff -r 9f9ae864d0cc -r 8a62d2db3392 doc/book/en/03-04-mercurial.en.txt --- a/doc/book/en/03-04-mercurial.en.txt Thu Nov 20 00:15:19 2008 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,114 +0,0 @@ -.. -*- coding: utf-8 -*- - -.. _Mercurial: - -Présentation de Mercurial -------------------------- - -Introduction -```````````` -Mercurial_ gère un ensemble distribué d'entrepôts contenant des arbres de -révisions (chaque révision indique les changements à effectuer pour obtenir la -version suivante, et ainsi de suite). Localement, on dispose d'un entrepôt -contenant un arbre de révisions, et d'un répertoire de travail. Il est possible -de mettre dans son répertoire de travail, une des versions issue de son entrepôt -local, de la modifier puis de la verser dans son entrepôt. Il est également -possible de récuprer dans son entrepôt local des révisions venant d'un autre -entrepôt, ou d'exporter ses propres révisions depuis son entrepôt local vers un -autre entrepôt. - -A noter que contrairement à CVS/Subversion, on crée généralement un entrepôt par -projet à gérer. - -Lors d'un développement collaboratif, on crée généralement un entrepôt central -accessible à tout les développeurs du projet. Ces entrepôts centraux servent de -référence. Selon ses besoins, chacun peut ensuite disposer d'un entrepôt local, -qu'il faudra penser à synchroniser avec l'entrepôt central de temps à autre. - - -Principales commandes -````````````````````` -* Créer un entrepôt local :: - - hg clone ssh://orion//home/src/prive/rep - -* Voir le contenu de l'entrepôt local (outil graphique en Tk) :: - - hg view - -* Ajouter un sous-répertoire ou un fichier dans le répertoire courant :: - - hg add rep - -* Placer dans son répertoire de travail une révision spécifique (ou la dernière - revision) issue de l'entrepôt local :: - - hg update [identifiant-revision] - hg up [identifiant-revision] - -* Récupérer dans son entrepôt local, l'arbre de révisions contenu dans un - entrepôt distant (cette opération ne modifie pas le répertoire local) :: - - hg pull ssh://orion//home/src/prive/rep - hg pull -u ssh://orion//home/src/prive/rep # équivalent à pull + update - -* Voir quelles sont les têtes de branches de l'entrepôt local si un `pull` a - tiré une nouvelle branche :: - - hg heads - -* Verser le répertoire de travail dans l'entrepôt local (et créer une nouvelle - révision) :: - - hg commit - hg ci - -* Fusionner, avec la révision mère du répertoire local, une autre révision issue - de l'entrepôt local (la nouvelle révision qui en résultera aura alors deux - révisions mères) :: - - hg merge identifiant-revision - -* Exporter dans un entrepôt distant, l'arbre de révisions contenu dans son - entrepôt local (cette opération ne modifie pas le répertoire local) :: - - hg push ssh://orion//home/src/prive/rep - -* Voir quelle sont les révisions locales non présentes dans un autre entrepôt :: - - hg outgoing ssh://orion//home/src/prive/rep - -* Voir quelle sont les révisions d'un autre entrepôt non présentes localement :: - - hg incoming ssh://orion//home/src/prive/rep - -* Voir quelle est la révision issue de l'entrepôt local qui a été sortie dans le - répertoire de travail et modifiée :: - - hg parent - -* Voir les différences entre le répertoire de travail et la révision mère de - l'entrepôt local, éventuellement permettant de les verser dans l'entrepôt - local :: - - hg diff - hg commit-tool - hg ct - - -Bonnes pratiques -```````````````` -* penser à faire un `hg pull -u` régulièrement et particulièrement avant de - faire un `hg commit` - -* penser à faire un `hg push` lorsque votre entrepôt contient une version - relativement stable de vos modifications - -* si un `hg pull -u` a créé une nouvelle tête de branche : - - 1. identifier l'identifiant de celle-ci avec `hg head` - 2. fusionner avec `hg merge` - 3. `hg ci` - 4. `hg push` - -.. _Mercurial: http://www.selenic.com/mercurial/ diff -r 9f9ae864d0cc -r 8a62d2db3392 doc/book/en/03-setup.en.txt --- a/doc/book/en/03-setup.en.txt Thu Nov 20 00:15:19 2008 +0100 +++ b/doc/book/en/03-setup.en.txt Wed Nov 19 17:05:34 2008 -0800 @@ -11,5 +11,4 @@ 03-01-installation.en.txt 03-02-create-instance.en.txt 03-03-cubicweb-ctl.en.txt - 03-04-mercurial.en.txt diff -r 9f9ae864d0cc -r 8a62d2db3392 doc/book/en/21-03-modules-stdlib.en.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/book/en/21-03-modules-stdlib.en.txt Wed Nov 19 17:05:34 2008 -0800 @@ -0,0 +1,158 @@ +.. -*- coding: utf-8 -*- + +================ +Standard library +================ + +:mod:`cubes.addressbook` +======================== + +.. automodule:: cubes.addressbook + :members: + +:mod:`cubes.basket` +======================== + +.. automodule:: cubes.basket + :members: + +:mod:`cubes.blog` +======================== + +.. automodule:: cubes.blog + :members: + +:mod:`cubes.book` +======================== + +.. automodule:: cubes.book + :members: + +:mod:`cubes.comment` +======================== + +.. automodule:: cubes.comment + :members: + +:mod:`cubes.company` +======================== + +.. automodule:: cubes.company + :members: + + +:mod:`cubes.conference` +======================== + +.. automodule:: cubes.conference + :members: + +:mod:`cubes.email` +======================== + +.. automodule:: cubes.email + :members: + +:mod:`cubes.event` +======================== + +.. automodule:: cubes.event + :members: + +:mod:`cubes.expense` +======================== + +.. automodule:: cubes.expense + :members: + + +:mod:`cubes.file` +======================== + +.. automodule:: cubes.file + :members: + +:mod:`cubes.folder` +======================== + +.. automodule:: cubes.folder + :members: + +:mod:`cubes.i18ncontent` +======================== + +.. automodule:: cubes.i18ncontent + :members: + +:mod:`cubes.invoice` +======================== + +.. automodule:: cubes.invoice + :members: + +:mod:`cubes.keyword` +======================== + +.. automodule:: cubes.keyword + :members: + +:mod:`cubes.link` +======================== + +.. automodule:: cubes.link + :members: + +:mod:`cubes.mailinglist` +======================== + +.. automodule:: cubes.mailinglist + :members: + +:mod:`cubes.person` +======================== + +.. automodule:: cubes.person + :members: + +:mod:`cubes.shopcart` +======================== + +.. automodule:: cubes.shopcart + :members: + +:mod:`cubes.skillmat` +======================== + +.. automodule:: cubes.skillmat + :members: + +:mod:`cubes.tag` +======================== + +.. automodule:: cubes.tag + :members: + +:mod:`cubes.task` +======================== + +.. automodule:: cubes.task + :members: + +:mod:`cubes.workcase` +======================== + +.. automodule:: cubes.workcase + :members: + +:mod:`cubes.workorder` +======================== + +.. automodule:: cubes.workorder + :members: + +:mod:`cubes.zone` +======================== + +.. automodule:: cubes.zone + :members: + diff -r 9f9ae864d0cc -r 8a62d2db3392 doc/book/en/21-03-modules.en.txt --- a/doc/book/en/21-03-modules.en.txt Thu Nov 20 00:15:19 2008 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,253 +0,0 @@ -.. -*- coding: utf-8 -*- - - -:mod:`cubes.addressbook` -======================== - -.. automodule:: cubes.addressbook - :members: - -:mod:`cubes.basket` -======================== - -.. automodule:: cubes.basket - :members: - -:mod:`cubes.blog` -======================== - -.. automodule:: cubes.blog - :members: - -:mod:`cubes.book` -======================== - -.. automodule:: cubes.book - :members: - -:mod:`cubes.comment` -======================== - -.. automodule:: cubes.comment - :members: - -:mod:`cubes.company` -======================== - -.. automodule:: cubes.company - :members: - - -:mod:`cubes.conference` -======================== - -.. automodule:: cubes.conference - :members: - -:mod:`cubes.email` -======================== - -.. automodule:: cubes.email - :members: - -:mod:`cubes.event` -======================== - -.. automodule:: cubes.event - :members: - -:mod:`cubes.expense` -======================== - -.. automodule:: cubes.expense - :members: - - -:mod:`cubes.file` -======================== - -.. automodule:: cubes.file - :members: - -:mod:`cubes.folder` -======================== - -.. automodule:: cubes.folder - :members: - -:mod:`cubes.i18ncontent` -======================== - -.. automodule:: cubes.i18ncontent - :members: - -:mod:`cubes.invoice` -======================== - -.. automodule:: cubes.invoice - :members: - -:mod:`cubes.keyword` -======================== - -.. automodule:: cubes.keyword - :members: - -:mod:`cubes.link` -======================== - -.. automodule:: cubes.link - :members: - -:mod:`cubes.mailinglist` -======================== - -.. automodule:: cubes.mailinglist - :members: - -:mod:`cubes.person` -======================== - -.. automodule:: cubes.person - :members: - -:mod:`cubes.shopcart` -======================== - -.. automodule:: cubes.shopcart - :members: - -:mod:`cubes.skillmat` -======================== - -.. automodule:: cubes.skillmat - :members: - -:mod:`cubes.tag` -======================== - -.. automodule:: cubes.tag - :members: - -:mod:`cubes.task` -======================== - -.. automodule:: cubes.task - :members: - -:mod:`cubes.workcase` -======================== - -.. automodule:: cubes.workcase - :members: - -:mod:`cubes.workorder` -======================== - -.. automodule:: cubes.workorder - :members: - -:mod:`cubes.zone` -======================== - -.. automodule:: cubes.zone - :members: - -:mod:`cubicweb` -=============== - -.. automodule:: cubicweb - :members: - -:mod:`cubicweb.common` -====================== - -.. automodule:: cubicweb.common - :members: - -:mod:`cubicweb.devtools` -======================== - -.. automodule:: cubicweb.devtools - :members: - -:mod:`cubicweb.entities` -======================== - -.. automodule:: cubicweb.entities - :members: - -:mod:`cubicweb.etwist` -====================== - -.. automodule:: cubicweb.etwist - :members: - -:mod:`cubicweb.goa` -=================== - -.. automodule:: cubicweb.goa - :members: - -:mod:`cubicweb.schemas` -======================= - -.. automodule:: cubicweb.schemas - :members: - -:mod:`cubicweb.server` -====================== - -.. automodule:: cubicweb.server - :members: - -:mod:`cubicweb.sobjects` -======================== - -.. automodule:: cubicweb.sobjects - :members: - -:mod:`cubicweb.web` -=================== - -.. automodule:: cubicweb.web - :members: - -:mod:`cubicweb.web.views` -========================= - -.. automodule:: cubicweb.web.views - :members: - - -:mod:`cubicweb.wsgi` -==================== - -.. automodule:: cubicweb.wsgi - :members: - -:mod:`indexer` -============== - -.. automodule:: indexer - :members: - -:mod:`logilab` -============== - -.. automodule:: logilab - :members: - - - -:mod:`rql` -========== - -.. automodule:: rql - :members: - -:mod:`yams` -=========== - -.. automodule:: yams - :members: diff -r 9f9ae864d0cc -r 8a62d2db3392 doc/book/en/21-04-modules-cbw-api.en.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/book/en/21-04-modules-cbw-api.en.txt Wed Nov 19 17:05:34 2008 -0800 @@ -0,0 +1,104 @@ +.. -*- coding: utf-8 -*- + +============ +CubicWeb API +============ + +:mod:`cubicweb` +=============== + +.. automodule:: cubicweb + :members: + +:mod:`cubicweb.common` +====================== + +.. automodule:: cubicweb.common + :members: + +:mod:`cubicweb.devtools` +======================== + +.. automodule:: cubicweb.devtools + :members: + +:mod:`cubicweb.entities` +======================== + +.. automodule:: cubicweb.entities + :members: + +:mod:`cubicweb.etwist` +====================== + +.. automodule:: cubicweb.etwist + :members: + +:mod:`cubicweb.goa` +=================== + +.. automodule:: cubicweb.goa + :members: + +:mod:`cubicweb.schemas` +======================= + +.. automodule:: cubicweb.schemas + :members: + +:mod:`cubicweb.server` +====================== + +.. automodule:: cubicweb.server + :members: + +:mod:`cubicweb.sobjects` +======================== + +.. automodule:: cubicweb.sobjects + :members: + +:mod:`cubicweb.web` +=================== + +.. automodule:: cubicweb.web + :members: + +:mod:`cubicweb.web.views` +========================= + +.. automodule:: cubicweb.web.views + :members: + + +:mod:`cubicweb.wsgi` +==================== + +.. automodule:: cubicweb.wsgi + :members: + +:mod:`indexer` +============== + +.. automodule:: indexer + :members: + +:mod:`logilab` +============== + +.. automodule:: logilab + :members: + + + +:mod:`rql` +========== + +.. automodule:: rql + :members: + +:mod:`yams` +=========== + +.. automodule:: yams + :members: diff -r 9f9ae864d0cc -r 8a62d2db3392 doc/book/en/21-05-mercurial.en.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/book/en/21-05-mercurial.en.txt Wed Nov 19 17:05:34 2008 -0800 @@ -0,0 +1,114 @@ +.. -*- coding: utf-8 -*- + +.. _Mercurial: + +Présentation de Mercurial +------------------------- + +Introduction +```````````` +Mercurial_ gère un ensemble distribué d'entrepôts contenant des arbres de +révisions (chaque révision indique les changements à effectuer pour obtenir la +version suivante, et ainsi de suite). Localement, on dispose d'un entrepôt +contenant un arbre de révisions, et d'un répertoire de travail. Il est possible +de mettre dans son répertoire de travail, une des versions issue de son entrepôt +local, de la modifier puis de la verser dans son entrepôt. Il est également +possible de récuprer dans son entrepôt local des révisions venant d'un autre +entrepôt, ou d'exporter ses propres révisions depuis son entrepôt local vers un +autre entrepôt. + +A noter que contrairement à CVS/Subversion, on crée généralement un entrepôt par +projet à gérer. + +Lors d'un développement collaboratif, on crée généralement un entrepôt central +accessible à tout les développeurs du projet. Ces entrepôts centraux servent de +référence. Selon ses besoins, chacun peut ensuite disposer d'un entrepôt local, +qu'il faudra penser à synchroniser avec l'entrepôt central de temps à autre. + + +Principales commandes +````````````````````` +* Créer un entrepôt local :: + + hg clone ssh://orion//home/src/prive/rep + +* Voir le contenu de l'entrepôt local (outil graphique en Tk) :: + + hg view + +* Ajouter un sous-répertoire ou un fichier dans le répertoire courant :: + + hg add rep + +* Placer dans son répertoire de travail une révision spécifique (ou la dernière + revision) issue de l'entrepôt local :: + + hg update [identifiant-revision] + hg up [identifiant-revision] + +* Récupérer dans son entrepôt local, l'arbre de révisions contenu dans un + entrepôt distant (cette opération ne modifie pas le répertoire local) :: + + hg pull ssh://orion//home/src/prive/rep + hg pull -u ssh://orion//home/src/prive/rep # équivalent à pull + update + +* Voir quelles sont les têtes de branches de l'entrepôt local si un `pull` a + tiré une nouvelle branche :: + + hg heads + +* Verser le répertoire de travail dans l'entrepôt local (et créer une nouvelle + révision) :: + + hg commit + hg ci + +* Fusionner, avec la révision mère du répertoire local, une autre révision issue + de l'entrepôt local (la nouvelle révision qui en résultera aura alors deux + révisions mères) :: + + hg merge identifiant-revision + +* Exporter dans un entrepôt distant, l'arbre de révisions contenu dans son + entrepôt local (cette opération ne modifie pas le répertoire local) :: + + hg push ssh://orion//home/src/prive/rep + +* Voir quelle sont les révisions locales non présentes dans un autre entrepôt :: + + hg outgoing ssh://orion//home/src/prive/rep + +* Voir quelle sont les révisions d'un autre entrepôt non présentes localement :: + + hg incoming ssh://orion//home/src/prive/rep + +* Voir quelle est la révision issue de l'entrepôt local qui a été sortie dans le + répertoire de travail et modifiée :: + + hg parent + +* Voir les différences entre le répertoire de travail et la révision mère de + l'entrepôt local, éventuellement permettant de les verser dans l'entrepôt + local :: + + hg diff + hg commit-tool + hg ct + + +Bonnes pratiques +```````````````` +* penser à faire un `hg pull -u` régulièrement et particulièrement avant de + faire un `hg commit` + +* penser à faire un `hg push` lorsque votre entrepôt contient une version + relativement stable de vos modifications + +* si un `hg pull -u` a créé une nouvelle tête de branche : + + 1. identifier l'identifiant de celle-ci avec `hg head` + 2. fusionner avec `hg merge` + 3. `hg ci` + 4. `hg push` + +.. _Mercurial: http://www.selenic.com/mercurial/ diff -r 9f9ae864d0cc -r 8a62d2db3392 doc/book/en/21-appendix.en.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/book/en/21-appendix.en.txt Wed Nov 19 17:05:34 2008 -0800 @@ -0,0 +1,16 @@ +.. -*- coding: utf-8 -*- + +.. _contents: + +Appendix +======== + +.. toctree:: + :maxdepth: 1 + + 21-01-architecture.en.txt + 21-02-querier.en.txt + 21-03-modules-stdlib.en.txt + 21-04-modules-cbw-api.en.txt + 21-05-mercurial.en.txt + diff -r 9f9ae864d0cc -r 8a62d2db3392 doc/book/en/21-references.en.txt --- a/doc/book/en/21-references.en.txt Thu Nov 20 00:15:19 2008 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,13 +0,0 @@ -.. -*- coding: utf-8 -*- - -.. _contents: - -Références -========== - -.. toctree:: - :maxdepth: 1 - - 21-01-architecture.en.txt - 21-02-querier.en.txt - 21-03-modules.en.txt diff -r 9f9ae864d0cc -r 8a62d2db3392 doc/book/en/index.txt --- a/doc/book/en/index.txt Thu Nov 20 00:15:19 2008 +0100 +++ b/doc/book/en/index.txt Wed Nov 19 17:05:34 2008 -0800 @@ -58,7 +58,7 @@ 18-tests.en.txt 19-i18n.en.txt 20-gae.en.txt - 21-references.en.txt + 21-appendix.en.txt 22-faq.en.txt