From: Michael M Slusarz Date: Tue, 11 Feb 2025 11:19:48 +0000 (-0700) Subject: global: Update documentation links in source code X-Git-Tag: 2.4.1~218 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2bdc88885d5ef2295c300f272a396d37b02d5fee;p=thirdparty%2Fdovecot%2Fcore.git global: Update documentation links in source code --- diff --git a/configure.ac b/configure.ac index d01b02c160..9c5468e532 100644 --- a/configure.ac +++ b/configure.ac @@ -265,10 +265,12 @@ AS_IF([echo "$PACKAGE_VERSION" | grep '^[[0-9]]*\.[[0-9]]*\.[[0-9]]'], [ AS_IF([test "$is_pro_build" = "yes"], [ SET_PRO_DEFINES AC_SUBST(DOVECOT_ASSET_URL, "doc.dovecotpro.com") + AC_DEFINE(DOVECOT_DOC_URL, "https://doc.dovecotpro.com/", [Documentation URL]) AC_SUBST(DOVECOT_PRO_BUILD, 1) ], [ AC_DEFINE_UNQUOTED(DOVECOT_NAME, "$PACKAGE_NAME", [Dovecot name]) AC_SUBST(DOVECOT_ASSET_URL, "doc.dovecot.org") + AC_DEFINE(DOVECOT_DOC_URL, "https://doc.dovecot.org/", [Documentation URL]) AC_SUBST(DOVECOT_PRO_BUILD, 0) ]) AC_DEFINE_UNQUOTED(DOVECOT_CONFIG_VERSION, "$DOVECOT_CONFIG_VERSION", [Dovecot configuration version]) diff --git a/src/lib-login/login-client.c b/src/lib-login/login-client.c index d801a7bb15..c49dbaf27c 100644 --- a/src/lib-login/login-client.c +++ b/src/lib-login/login-client.c @@ -9,6 +9,7 @@ #include "time-util.h" #include "master-service-private.h" #include "login-client.h" +#include "doc.h" #include #include @@ -233,7 +234,7 @@ void login_client_request(struct login_client_list *list, if (conn->fd == -1) { e_error(conn->event, "net_connect_unix(%s) failed: %m%s", conn->path, errno != EAGAIN ? "" : - " - https://doc.dovecot.org/admin_manual/errors/socket_unavailable/"); + " - " DOC_LINK("core/admin/errors.html#unix-socket-resource-temporarily-unavailable")); login_connection_deinit(&conn); return; } diff --git a/src/lib-login/login-server.c b/src/lib-login/login-server.c index f564e56629..6dcebfcc9a 100644 --- a/src/lib-login/login-server.c +++ b/src/lib-login/login-server.c @@ -12,6 +12,7 @@ #include "master-service-private.h" #include "login-server.h" #include "login-server-auth.h" +#include "doc.h" #include #include @@ -375,7 +376,7 @@ static int login_server_postlogin(struct login_server_request *request, if (fd == -1) { e_error(request->conn->event, "net_connect_unix(%s) failed: %m%s", socket_path, errno != EAGAIN ? "" : - " - https://doc.dovecot.org/admin_manual/errors/socket_unavailable/"); + " - " DOC_LINK("core/admin/errors.html#unix-socket-resource-temporarily-unavailable")); return -1; } diff --git a/src/lib-storage/index/mbox/mbox-storage.c b/src/lib-storage/index/mbox/mbox-storage.c index e86c4f07df..47ce6ebe3d 100644 --- a/src/lib-storage/index/mbox/mbox-storage.c +++ b/src/lib-storage/index/mbox/mbox-storage.c @@ -15,6 +15,7 @@ #include "istream-raw-mbox.h" #include "mail-copy.h" #include "index-mail.h" +#include "doc.h" #include @@ -196,7 +197,7 @@ mbox_storage_create(struct mail_storage *_storage, struct mail_namespace *ns, !S_ISDIR(st.st_mode)) { *error_r = t_strdup_printf( "mbox root directory can't be a file: %s " - "(https://doc.dovecot.org/configuration_manual/mail_location/mbox/)", + "(" DOC_LINK("core/config/mailbox/mail_location.html#mbox") ")", ns->list->mail_set->mail_path); return -1; } diff --git a/src/lib-storage/mail-storage-service.c b/src/lib-storage/mail-storage-service.c index df662e08d1..4580b6cc8b 100644 --- a/src/lib-storage/mail-storage-service.c +++ b/src/lib-storage/mail-storage-service.c @@ -20,6 +20,7 @@ #include "mail-namespace.h" #include "mail-storage.h" #include "mail-storage-service.h" +#include "doc.h" #include #include @@ -815,7 +816,7 @@ mail_storage_service_time_moved(const struct timeval *old_time, } diff = -diff; - const char *doc_ref = "https://doc.dovecot.org/admin_manual/errors/time_moved_backwards/"; + const char *doc_ref = DOC_LINK("core/admin/errors.html#time-moved-backwards-error"); if ((diff / 1000) > MAX_TIME_BACKWARDS_SLEEP_MSECS) { i_fatal("Time just moved backwards by %lld.%06lld seconds. " "This might cause a lot of problems, " diff --git a/src/lib/Makefile.am b/src/lib/Makefile.am index 4dbacee207..2981499e4d 100644 --- a/src/lib/Makefile.am +++ b/src/lib/Makefile.am @@ -218,6 +218,7 @@ headers = \ cpu-limit.h \ crc32.h \ data-stack.h \ + doc.h \ eacces-error.h \ env-util.h \ event-filter.h \ diff --git a/src/lib/doc.h b/src/lib/doc.h new file mode 100644 index 0000000000..0a864ed08a --- /dev/null +++ b/src/lib/doc.h @@ -0,0 +1,10 @@ +#ifndef DOC_H +#define DOC_H + +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif + +#define DOC_LINK(page) DOVECOT_DOC_URL "latest/" page + +#endif diff --git a/src/lib/eacces-error.c b/src/lib/eacces-error.c index e08be4922d..7befe33ee2 100644 --- a/src/lib/eacces-error.c +++ b/src/lib/eacces-error.c @@ -6,6 +6,7 @@ #include "ipwd.h" #include "restrict-access.h" #include "eacces-error.h" +#include "doc.h" #include #include @@ -312,7 +313,7 @@ const char *eperm_error_get_chgrp(const char *func, const char *path, if (gid_origin != NULL) str_printfa(errmsg, ", group based on %s", gid_origin); str_append(errmsg, - " - see https://doc.dovecot.org/admin_manual/errors/chgrp_no_perm/)"); + " - see " DOC_LINK("core/admin/errors.html#change-group-operation-not-permitted") ")"); errno = orig_errno; return str_c(errmsg); }