From 1a5c251860f4bfe25292d2753ebda27212c2848f Mon Sep 17 00:00:00 2001 From: ellie timoney Date: Wed, 24 Nov 2021 10:37:15 +1100 Subject: [PATCH] docs: minimal tweaks for new cassandane location 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. --- docsrc/imap/developer/developer-testing.rst | 15 ++++++++------- docsrc/imap/developer/github-guide.rst | 2 +- docsrc/imap/reference/faqs/o-gdb.rst | 4 ++-- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docsrc/imap/developer/developer-testing.rst b/docsrc/imap/developer/developer-testing.rst index ae51daba21..fcc51cc35c 100644 --- a/docsrc/imap/developer/developer-testing.rst +++ b/docsrc/imap/developer/developer-testing.rst @@ -11,7 +11,9 @@ This assumes you have your :ref:`basic server running ` and you've m Installing Cassandane ===================== -Cassandane is a Perl-based integration test suite for Cyrus. `Cassandane documentation `_ includes information on setting up tests and writing new tests. +Cassandane is a Perl-based integration test suite for Cyrus. +`Cassandane documentation `_ +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 @@ -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 @@ -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. @@ -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 diff --git a/docsrc/imap/developer/github-guide.rst b/docsrc/imap/developer/github-guide.rst index d7809c8aa8..41e16fe2f8 100644 --- a/docsrc/imap/developer/github-guide.rst +++ b/docsrc/imap/developer/github-guide.rst @@ -42,7 +42,7 @@ you can `generate a new key `_ (source, or documentation), -contributing to tests with `Cassandane `_ or into helping out with `SASL `_ or +or into helping out with `SASL `_ or any of the other `Cyrus component projects `_, 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 `_. diff --git a/docsrc/imap/reference/faqs/o-gdb.rst b/docsrc/imap/reference/faqs/o-gdb.rst index b39d1e53da..f87b602796 100644 --- a/docsrc/imap/reference/faqs/o-gdb.rst +++ b/docsrc/imap/reference/faqs/o-gdb.rst @@ -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 -`_ test that tries to reproduce the +An easy way to debug something in a service daemon is to write a +:ref:`Cassandane test ` that tries to reproduce the bug. Cassandane has a ``[gdb]`` section in cassandane.ini which allows for starting service daemons in a debugger.