~mnordhoff/loggerhead/cheezum

« back to all changes in this revision

Viewing changes to docs/index.rst

  • Committer: Tres Seaver
  • Date: 2010-03-25 10:25:13 UTC
  • mto: (164.107.60 trunk-rich)
  • mto: This revision was merged to the branch mainline in revision 456.
  • Revision ID: tseaver@agendaless.com-20100325102513-imvok1jbu36cxg0t
Use 'Loggerhead' as the display name;  fix typos.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
loggerhead:  A web viewer for ``bzr`` branches
 
1
Loggerhead:  A web viewer for ``bzr`` branches
2
2
==============================================
3
3
 
4
4
Loggerhead is a web viewer for projects in bazaar. It can be used to navigate 
5
5
a branch history, annotate files, view patches, perform searches, etc.
6
 
oggerhead is heavily based on `bazaar-webserve
 
6
Loggerhead is heavily based on `bazaar-webserve
7
7
<https://launchpad.net/bzr-webserve>`_, which was, in turn, loosely
8
8
based on `hgweb <http://mercurial.selenic.com/wiki/HgWebDirStepByStep>`_.
9
9
 
75
75
Running Loggerhead as a Daemon
76
76
------------------------------
77
77
 
78
 
To run loggerhead as a linux daemon:
 
78
To run Loggerhead as a linux daemon:
79
79
 
80
80
1) Copy the ``loggerheadd`` scipt to ``/etc/init.d``
81
81
 
83
83
 
84
84
   $ sudo cp ./loggerheadd /etc/init.d
85
85
 
86
 
2) Edit the file to configure where your loggerhead is installed, and which
 
86
2) Edit the file to configure where your Loggerhead is installed, and which
87
87
   serve-branches options you would like.
88
88
 
89
89
.. code-block:: sh
92
92
 
93
93
3) Register the service
94
94
 
95
 
a) on upstart based systems like Ubuntu run: 
96
 
 
97
95
.. code-block:: sh
98
96
 
 
97
   # on upstart based systems like Ubuntu run: 
99
98
   $ sudo update-rc.d loggerheadd defaults
100
99
 
101
 
b) on Sysvinit based systems like Centos or SuSE run:
102
 
 
103
 
.. code-block:: sh
104
 
 
 
100
   # on Sysvinit based systems like Centos or SuSE run:
105
101
   $ sudo chkconfig --add loggerheadd
106
102
 
107
103
 
191
187
Hacking
192
188
-------
193
189
 
194
 
To run loggerhead tests, you will need to install the package ``python-nose``,
195
 
and run its :command:`nosetests` script in the loggerhead directory:
 
190
To run Loggerhead tests, you will need to install the package ``python-nose``,
 
191
and run its :command:`nosetests` script in the Loggerhead directory:
196
192
 
197
193
.. code-block:: sh
198
194