{"action":"opened","issue":{"url":"https://api.github.com/repos/cyrusimap/cyrus-imapd/issues/2395","repository_url":"https://api.github.com/repos/cyrusimap/cyrus-imapd","labels_url":"https://api.github.com/repos/cyrusimap/cyrus-imapd/issues/2395/labels{/name}","comments_url":"https://api.github.com/repos/cyrusimap/cyrus-imapd/issues/2395/comments","events_url":"https://api.github.com/repos/cyrusimap/cyrus-imapd/issues/2395/events","html_url":"https://github.com/cyrusimap/cyrus-imapd/issues/2395","id":332274552,"node_id":"MDU6SXNzdWUzMzIyNzQ1NTI=","number":2395,"title":"Use consistently 'configdirectory'","user":{"login":"dilyanpalauzov","id":4992947,"node_id":"MDQ6VXNlcjQ5OTI5NDc=","avatar_url":"https://avatars0.githubusercontent.com/u/4992947?v=4","gravatar_id":"","url":"https://api.github.com/users/dilyanpalauzov","html_url":"https://github.com/dilyanpalauzov","followers_url":"https://api.github.com/users/dilyanpalauzov/followers","following_url":"https://api.github.com/users/dilyanpalauzov/following{/other_user}","gists_url":"https://api.github.com/users/dilyanpalauzov/gists{/gist_id}","starred_url":"https://api.github.com/users/dilyanpalauzov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dilyanpalauzov/subscriptions","organizations_url":"https://api.github.com/users/dilyanpalauzov/orgs","repos_url":"https://api.github.com/users/dilyanpalauzov/repos","events_url":"https://api.github.com/users/dilyanpalauzov/events{/privacy}","received_events_url":"https://api.github.com/users/dilyanpalauzov/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-06-14T07:00:11Z","updated_at":"2018-06-14T07:00:11Z","closed_at":null,"author_association":"NONE","body":"Instead of interchanging configdir, confdir and configdirectory.\r\n```diff\r\ndiff --git a/doc/internal/namelocks.html b/doc/internal/namelocks.html\r\n--- a/doc/internal/namelocks.html\r\n+++ b/doc/internal/namelocks.html\r\n@@ -46,7 +46,7 @@ meaning other users on the local server would never see it existing.</p>\r\n \r\n <h2>Implementation</h2>\r\n \r\n-It's a simple matter of having a file under $confdir/lock - in a\r\n+It's a simple matter of having a file under $configdirectory/lock - in a\r\n directory tree using the same hashing structure as the mailbox tree.\r\n This directory can be symlinked or mounted to a tmpfs since the locks\r\n need not persist across restarts.  Due to race conditions while\r\ndiff --git a/doc/legacy/changes.html b/doc/legacy/changes.html\r\n--- a/doc/legacy/changes.html\r\n+++ b/doc/legacy/changes.html\r\n@@ -569,7 +569,7 @@ complains if this isn&#8217;t allowed.</p>\r\n   injection vulnerability</li>\r\n <li>Bug #3382 Added \"failedloginpause\" config option</li>\r\n <li>Bugs #3383/3385 Removed some obsolete config options</li>\r\n-<li>Bug #3389 $confdir/proc not created on the fly</li>\r\n+<li>Bug #3389 $configdirectory/proc not created on the fly</li>\r\n <li>Bug #3394 fix imtest parsing of MECHLIST</li>\r\n <li>Bug #3399 fix with_ldap option default</li>\r\n <li>Bug #3307 fix mbpath crash on remote mailbox</li>\r\ndiff --git a/docsrc/imap/developer/guidance/namelocks.rst b/docsrc/imap/developer/guidance/namelocks.rst\r\n--- a/docsrc/imap/developer/guidance/namelocks.rst\r\n+++ b/docsrc/imap/developer/guidance/namelocks.rst\r\n@@ -42,7 +42,7 @@ the local server would never see it existing.\r\n Implementation\r\n --------------\r\n \r\n-It's a simple matter of having a file under $confdir/lock - in a\r\n+It's a simple matter of having a file under $configdirectory/lock - in a\r\n directory tree using the same hashing structure as the mailbox tree.\r\n This directory can be symlinked or mounted to a tmpfs since the locks\r\n need not persist across restarts. Due to race conditions while cleaning\r\ndiff --git a/docsrc/imap/download/installation/http/caldav.rst b/docsrc/imap/download/installation/http/caldav.rst\r\n--- a/docsrc/imap/download/installation/http/caldav.rst\r\n+++ b/docsrc/imap/download/installation/http/caldav.rst\r\n@@ -346,7 +346,7 @@ Configuration\r\n        :end-before: endblob zoneinfo_db\r\n \r\n This module stores time zone data in the ``zoneinfo/`` subdirectory of the Cyrus\r\n-configuration directory (as specified by the ``configdir`` option). The data is\r\n+configuration directory (as specified by the ``configdirectory`` option). The data is\r\n indexed by a database whose location is specified by the ``zoneinfo_db_path``\r\n option, using the format specified by the ``zoneinfo_db`` option.\r\n \r\n@@ -371,14 +371,14 @@ The steps to populate the Cyrus ``zoneinfo/`` directory are:\r\n \r\n 3. Expand the downloaded time zone data into a temporary directory of your choice.\r\n \r\n-4. Populate ``configdir/zoneinfo/`` with iCalendar data:\r\n+4. Populate ``<configdirectory>/zoneinfo/`` with iCalendar data:\r\n \r\n    *Initial Install Only*\r\n \r\n    a. Convert the raw data into iCalendar format by running vzic as follows:\r\n-      ``vzic --pure --olson-dir <location-of-raw-data> --output-dir <configdir>/zoneinfo``\r\n+      ``vzic --pure --olson-dir <location-of-raw-data> --output-dir <configdirectory>/zoneinfo``\r\n \r\n-      This will create and install iCalendar data directly into the configdir/zoneinfo/ directory.\r\n+      This will create and install iCalendar data directly into the ``<configdirectory>/zoneinfo/`` directory.\r\n \r\n    *Updating Data Only*\r\n \r\n@@ -388,7 +388,7 @@ The steps to populate the Cyrus ``zoneinfo/`` directory are:\r\n       This will create a zoneinfo/ subdirectory in your current location\r\n       (which should be `tools/vzic/`).\r\n \r\n-   c. Merge new/updated iCalendar data into the configdir/zoneinfo/ directory\r\n+   c. Merge new/updated iCalendar data into the ``<configdirectory>/zoneinfo/`` directory\r\n       by running vzic-merge.pl in your current location:\r\n       ``vzic-merge.pl``\r\n \r\ndiff --git a/docsrc/imap/download/release-notes/2.4/x/2.4.7.rst b/docsrc/imap/download/release-notes/2.4/x/2.4.7.rst\r\n--- a/docsrc/imap/download/release-notes/2.4/x/2.4.7.rst\r\n+++ b/docsrc/imap/download/release-notes/2.4/x/2.4.7.rst\r\n@@ -23,7 +23,7 @@ Changes to the Cyrus IMAP Server since 2.4.6\r\n *   Fixed bug #3423 - STARTTLS plaintext command injection vulnerability\r\n *   Bug #3382 Added \"failedloginpause\" config option\r\n *   Bugs #3383/3385 Removed some obsolete config options\r\n-*   Bug #3389 $confdir/proc not created on the fly\r\n+*   Bug #3389 $configdirectory/proc not created on the fly\r\n *   Bug #3394 fix imtest parsing of MECHLIST\r\n *   Bug #3399 fix with_ldap option default\r\n *   Bug #3307 fix mbpath crash on remote mailbox\r\ndiff --git a/docsrc/imap/download/upgrade.rst b/docsrc/imap/download/upgrade.rst\r\n--- a/docsrc/imap/download/upgrade.rst\r\n+++ b/docsrc/imap/download/upgrade.rst\r\n@@ -241,12 +241,12 @@ DAEMON section.\r\n \r\n     On old install, prior to migration::\r\n \r\n-       cvt_cyrusdb /<confdir>mailboxes.db berkeley /tmp/new-mailboxes.db skiplist\r\n+       cvt_cyrusdb /<configdirectory>mailboxes.db berkeley /tmp/new-mailboxes.db skiplist\r\n \r\n     If you don't want to use flat or skiplist for 3.0, you can use the\r\n     new 3.0 :cyrusman:`cvt_cyrusdb(8)` to swap to new format::\r\n \r\n-       cvt_cyrusdb /tmp/new-mailboxes.db skiplist /<confdir>/mailboxes.db <new file format>\r\n+       cvt_cyrusdb /tmp/new-mailboxes.db skiplist /<configdirectory>/mailboxes.db <new file format>\r\n \r\n .. note::\r\n     The :cyrusman:`cvt_cyrusdb(8)` command does not accept relative paths.\r\ndiff --git a/docsrc/imap/reference/admin/locations/configuration-state.rst b/docsrc/imap/reference/admin/locations/configuration-state.rst\r\n--- a/docsrc/imap/reference/admin/locations/configuration-state.rst\r\n+++ b/docsrc/imap/reference/admin/locations/configuration-state.rst\r\n@@ -13,8 +13,8 @@ configuration file to use.  For example:\r\n \r\n     **ctl_mboxlist** **-C** */usr/local/etc/imapd.conf*  **-d** **-f** *mailboxes.dump*\r\n \r\n-The main configuration directory is referred to as ``<confdir>`` in\r\n-most Cyrus IMAP documentation, and is set via the ``configdirectory``\r\n+The main configuration directory is referred to as ``<configdirectory>``\r\n+in Cyrus IMAP documentation, and is set via the ``configdirectory``\r\n entry in :cyrusman:`imapd.conf(5)`:\r\n \r\n .. include:: /imap/reference/manpages/configs/imapd.conf.rst\r\n@@ -26,7 +26,7 @@ distributions use ``/var/lib/imap`` or ``/var/lib/cyrus``.\r\n \r\n State Databases\r\n ---------------\r\n-Despite the name, most of what's stored in ``<confdir>`` is state\r\n+Despite the name, most of what's stored in ``<configdirectory>`` is state\r\n information.  Here's a list of files typically located therein:\r\n \r\n     * :ref:`imap-concepts-deployment-db-annotations`\r\n@@ -179,7 +179,7 @@ Per-user State Directories\r\n \r\n There are several things tracked per-user, and the data files for these\r\n items, such as subscriptions and seen state, are stored in\r\n-<confdir>/user.  These files may not be relocated from <confdir>.  They\r\n+<configdirectory>/user.  These files may not be relocated from <configdirectory>.  They\r\n are:\r\n \r\n     * :ref:`imap-concepts-deployment-db-seen`\r\ndiff --git a/docsrc/imap/reference/faqs/o-configdir-tempfs.rst b/docsrc/imap/reference/faqs/o-configdir-tempfs.rst\r\n--- a/docsrc/imap/reference/faqs/o-configdir-tempfs.rst\r\n+++ b/docsrc/imap/reference/faqs/o-configdir-tempfs.rst\r\n@@ -1,4 +1,4 @@\r\n-Is it safe to put configdir/proc and configdir/lock on a tmpfs filesystem?\r\n+Is it safe to put <configdirectory>/proc and <configdirectory>/lock on a tmpfs filesystem?\r\n --------------------------------------------------------------------------\r\n \r\n It's safe to put both of these in tmpfs, and since they're fairly busy \r\ndiff --git a/docsrc/imap/reference/faqs/o-telemetry.rst b/docsrc/imap/reference/faqs/o-telemetry.rst\r\n--- a/docsrc/imap/reference/faqs/o-telemetry.rst\r\n+++ b/docsrc/imap/reference/faqs/o-telemetry.rst\r\n@@ -10,8 +10,8 @@ The directory path is:\r\n \r\n .. code-block:: bash\r\n \r\n-    mkdir $confdir/log/$userid/             # for example /var/imap/log/darth\r\n-    chown cyrus $confdir/log/$userid/       # The cyrus user needs write access to this directory.\r\n+    mkdir $configdirectory/log/$userid/             # for example /var/imap/log/darth\r\n+    chown cyrus $configdirectory/log/$userid/       # The cyrus user needs write access to this directory.\r\n \r\n If you have virtdomains enabled, then the username is the login name. In this case if you login as ``darth@vader.net``, then the path is ``/var/imap/log/darth@vader.net/``\r\n \r\ndiff --git a/docsrc/imap/reference/manpages/systemcommands/mkimap.rst b/docsrc/imap/reference/manpages/systemcommands/mkimap.rst\r\n--- a/docsrc/imap/reference/manpages/systemcommands/mkimap.rst\r\n+++ b/docsrc/imap/reference/manpages/systemcommands/mkimap.rst\r\n@@ -28,7 +28,7 @@ directories that Cyrus IMAP would need to operate.\r\n \r\n Among these directories are:\r\n \r\n-    *   the ``configdir`` (from :cyrusman:`imapd.conf(5)`)\r\n+    *   the ``configdirectory`` (from :cyrusman:`imapd.conf(5)`)\r\n \r\n     *   the ``partition-$name`` directories (from :cyrusman:`imapd.conf(5)`)\r\n \r\ndiff --git a/lib/imapoptions b/lib/imapoptions\r\n--- a/lib/imapoptions\r\n+++ b/lib/imapoptions\r\n@@ -185,7 +185,7 @@ are listed with ``<none>''.\r\n \r\n { \"annotation_db_path\", NULL, STRING }\r\n /* The absolute path to the annotations db file.  If not specified,\r\n-   will be confdir/annotations.db */\r\n+   will be configdirectory/annotations.db */\r\n \r\n { \"anyoneuseracl\", 1, SWITCH }\r\n /* Should non-admin users be allowed to set ACLs for the 'anyone'\r\n@@ -483,7 +483,7 @@ Blank lines and lines beginning with ``#'' are ignored.\r\n \r\n { \"backup_db_path\", NULL, STRING }\r\n /* The absolute path to the backup db file.  If not specified,\r\n-   will be confdir/backups.db */\r\n+   will be configdirectory/backups.db */\r\n \r\n { \"backup_keep_previous\", 0, SWITCH }\r\n /* Whether the \\fBctl_backups compact\\fR and \\fBctl_backups reindex\\fR\r\n@@ -765,7 +765,7 @@ Blank lines and lines beginning with ``#'' are ignored.\r\n \r\n { \"duplicate_db_path\", NULL, STRING }\r\n /* The absolute path to the duplicate db file.  If not specified,\r\n-   will be confdir/deliver.db */\r\n+   will be configdirectory/deliver.db */\r\n \r\n { \"duplicatesuppression\", 1, SWITCH }\r\n /* If enabled, lmtpd will suppress delivery of a message to a mailbox if\r\n@@ -1369,7 +1369,7 @@ Blank lines and lines beginning with ``#'' are ignored.\r\n \r\n { \"mboxlist_db_path\", NULL, STRING }\r\n /* The absolute path to the mailboxes db file.  If not specified\r\n-   will be confdir/mailboxes.db */\r\n+   will be configdirectory/mailboxes.db */\r\n \r\n { \"mboxname_lockpath\", NULL, STRING }\r\n /* Path to mailbox name lock files (default $conf/lock) */\r\n@@ -1527,7 +1527,7 @@ Blank lines and lines beginning with ``#'' are ignored.\r\n \r\n { \"newsrc_db_path\", NULL, STRING }\r\n /* The absolute path to the newsrc db file.  If not specified,\r\n-   will be confdir/fetchnews.db */\r\n+   will be configdirectory/fetchnews.db */\r\n \r\n { \"nntptimeout\", 3, INT }\r\n /* Set the length of the NNTP server's inactivity autologout timer,\r\n@@ -1689,7 +1689,7 @@ If all partitions are over that limit, this feature is not used anymore.\r\n \r\n { \"proc_path\", NULL, STRING }\r\n /* Path to proc directory.  Default is NULL - must be an absolute path\r\n-   if specified.  If not specified, the path $confdir/proc/ will be\r\n+   if specified.  If not specified, the path $configdirectory/proc/ will be\r\n    used. */\r\n \r\n { \"prometheus_enabled\", 0, SWITCH }\r\n@@ -1705,7 +1705,7 @@ If all partitions are over that limit, this feature is not used anymore.\r\n { \"prometheus_stats_dir\", NULL, STRING }\r\n /* Directory to use for gathering prometheus statistics.  If specified,\r\n    must be an absolute path.  If not specified, the default path\r\n-   $confdir/stats/ will be used.  It may be advantageous to locate this\r\n+   $configdirectory/stats/ will be used.  It may be advantageous to locate this\r\n    directory on ephemeral storage. */\r\n \r\n { \"proxy_authname\", \"proxy\", STRING }\r\n@@ -1752,14 +1752,14 @@ If all partitions are over that limit, this feature is not used anymore.\r\n \r\n { \"ptloader_sock\", NULL, STRING }\r\n /* Unix domain socket that ptloader listens on.\r\n-   (defaults to configdir/ptclient/ptsock) */\r\n+   (defaults to configdirectory/ptclient/ptsock) */\r\n \r\n { \"ptscache_db\", \"twoskip\", STRINGLIST(\"skiplist\", \"twoskip\")}\r\n /* The cyrusdb backend to use for the pts cache. */\r\n \r\n { \"ptscache_db_path\", NULL, STRING }\r\n /* The absolute path to the ptscache db file.  If not specified,\r\n-   will be confdir/ptscache.db */\r\n+   will be configdirectory/ptscache.db */\r\n \r\n { \"ptscache_timeout\", 10800, INT }\r\n /* The timeout (in seconds) for the PTS cache database when using the\r\n@@ -1785,7 +1785,7 @@ If all partitions are over that limit, this feature is not used anymore.\r\n { \"quota_db_path\", NULL, STRING }\r\n /* The absolute path for the quota database (if you choose a single-file\r\n    quota DB type - or the base path if you choose quotalegacy).  If\r\n-   not specified will be confdir/quotas.db or confdir/quota/ */\r\n+   not specified will be configdirectory/quotas.db or configdirectory/quota/ */\r\n \r\n { \"quotawarn\", 90, INT }\r\n /* The percent of quota utilization over which the server generates\r\n@@ -2279,7 +2279,7 @@ product version in the capabilities\r\n \r\n { \"statuscache_db_path\", NULL, STRING }\r\n /* The absolute path to the statuscache db file.  If not specified,\r\n-   will be confdir/statuscache.db */\r\n+   will be configdirectory/statuscache.db */\r\n \r\n { \"sync_authname\", NULL, STRING }\r\n /* The authentication name to use when authenticating to a sync server.\r\n@@ -2492,7 +2492,7 @@ product version in the capabilities\r\n \r\n { \"tls_sessions_db_path\", NULL, STRING }\r\n /* The absolute path to the TLS sessions db file. If not specified,\r\n-   will be confdir/tls_sessions.db */\r\n+   will be configdirectory/tls_sessions.db */\r\n \r\n { \"tls_session_timeout\", 1440, INT }\r\n /* The length of time (in minutes) that a TLS session will be cached\r\n@@ -2519,7 +2519,7 @@ product version in the capabilities\r\n \r\n { \"userdeny_db_path\", NULL, STRING }\r\n /* The absolute path to the userdeny db file.  If not specified,\r\n-   will be confdir/user_deny.db */\r\n+   will be configdirectory/user_deny.db */\r\n \r\n { \"username_tolower\", 1, SWITCH }\r\n /* Convert usernames to all lowercase before login/authentication.  This\r\n@@ -2579,7 +2579,7 @@ product version in the capabilities\r\n \r\n { \"zoneinfo_db_path\", NULL, STRING }\r\n /* The absolute path to the zoneinfo db file.  If not specified,\r\n-   will be confdir/zoneinfo.db */\r\n+   will be configdirectory/zoneinfo.db */\r\n \r\n { \"object_storage_enabled\", 0, SWITCH }\r\n /* Is Object storage enabled for this server.  You also need to have\r\n```"}}
{"actor":{"display_login":"dilyanpalauzov"}}