Skip to content

Commit

Permalink
docs: minimal tweaks for new cassandane location
Browse files Browse the repository at this point in the history
This needs proper revision, but it's also going to keep changing
as we polish up the cassandane integration, so I don't want to burn
a lot of effort right now when it's about to change again anyway.
  • Loading branch information
elliefm committed Jan 24, 2022
1 parent ce7b639 commit 1a5c251
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
15 changes: 8 additions & 7 deletions docsrc/imap/developer/developer-testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ This assumes you have your :ref:`basic server running <installing>` and you've m
Installing Cassandane
=====================

Cassandane is a Perl-based integration test suite for Cyrus. `Cassandane documentation <https://github.com/cyrusimap/cassandane/tree/master/doc>`_ includes information on setting up tests and writing new tests.
Cassandane is a Perl-based integration test suite for Cyrus.
`Cassandane documentation <https://github.com/cyrusimap/cyrus-imapd/tree/master/cassandane/doc>`_
includes information on setting up tests and writing new tests.

Why "Cassandane"? Wikipedia indicates that Cassandane_ was the name of
the consort of King Cyrus the Great of Persia, founder of the Achaemenid
Expand All @@ -22,9 +24,8 @@ Persian Empire. So that's kinda cool.
Install and configure Cassandane
--------------------------------

1. Clone the Cassandane repository

* ``git clone https://github.com/cyrusimap/cassandane.git``
1. You already have it -- it's in the "cassandane" subdirectory of the cyrus-imapd
sources.

2. Install dependencies

Expand Down Expand Up @@ -61,10 +62,10 @@ Install and configure Cassandane

.. code-block:: bash
cd /path/to/cassandane
cd /path/to/cyrus-imapd/cassandane
make
4. Copy ``cassandane.ini.example`` to ``cassandane.ini``
4. Copy ``cassandane.ini.example`` to ``cassandane.ini`` in your home directory

5. Edit ``cassandane.ini`` to set up your cassandane environment.

Expand Down Expand Up @@ -172,7 +173,7 @@ As user ``cyrus``, run the tests.

.. code-block:: bash
cd /path/to/cassandane
cd /path/to/cyrus-imapd/cassandane
sudo -u cyrus ./testrunner.pl -f pretty -j 8
Debugging and stacktraces
Expand Down
2 changes: 1 addition & 1 deletion docsrc/imap/developer/github-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ you can `generate a new key <https://help.github.com/articles/generating-a-new-s
----------------------

Whether you're contributing to `Cyrus <https://github.com/cyrusimap/cyrus-imapd>`_ (source, or documentation),
contributing to tests with `Cassandane <https://github.com/cyrusimap/cassandane>`_ or into helping out with `SASL <https://github.com/cyrusimap/cyrus-sasl>`_ or
or into helping out with `SASL <https://github.com/cyrusimap/cyrus-sasl>`_ or
any of the other `Cyrus component projects <https://github.com/cyrusimap>`_, use the Fork button to make a copy of the repository into your own GitHub work space.

GitHub has more information on `how to fork a repository <https://help.github.com/articles/fork-a-repo/>`_.
Expand Down
4 changes: 2 additions & 2 deletions docsrc/imap/reference/faqs/o-gdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ How to run gdb on Cyrus components
imapd, lmtpd (and some others), but does *not* include the command line
tools.

An easy way to debug something in a service daemon is to write a `Cassandane
<https://github.com/cyrusimap/cassandane>`_ test that tries to reproduce the
An easy way to debug something in a service daemon is to write a
:ref:`Cassandane test <developer-testing>` that tries to reproduce the
bug. Cassandane has a ``[gdb]`` section in cassandane.ini which allows for
starting service daemons in a debugger.

Expand Down

0 comments on commit 1a5c251

Please sign in to comment.