From 4a90d67eb6837c2a32f245985a0a2f166d9d1786 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Sat, 18 Feb 2023 13:00:04 +0100 Subject: [PATCH] Slightly improve hashcash documentation * lisp/mail/hashcash.el: Improve Commentary. (hashcash-program): * lisp/gnus/message.el (message-generate-hashcash): Improve docstring. --- lisp/gnus/message.el | 5 +++-- lisp/mail/hashcash.el | 18 +++++++++++------- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/lisp/gnus/message.el b/lisp/gnus/message.el index c697b8d7a7f..f4cfffa2e8a 100644 --- a/lisp/gnus/message.el +++ b/lisp/gnus/message.el @@ -1926,9 +1926,10 @@ no, only reply back to the author." "Whether to generate X-Hashcash: headers. If t, always generate hashcash headers. If `opportunistic', only generate hashcash headers if it can be done without the user -waiting (i.e., only asynchronously). +waiting (i.e., only asynchronously). If nil, don't generate +hashcash headers. -You must have the \"hashcash\" binary installed, see `hashcash-path'." +You must have the \"hashcash\" binary installed, see `hashcash-program'." :version "24.1" :group 'message-headers :link '(custom-manual "(message)Mail Headers") diff --git a/lisp/mail/hashcash.el b/lisp/mail/hashcash.el index 72d532d6f62..ecc03bfb537 100644 --- a/lisp/mail/hashcash.el +++ b/lisp/mail/hashcash.el @@ -25,16 +25,16 @@ ;; The hashcash binary is at http://www.hashcash.org/. ;; -;; Call mail-add-payment to add a hashcash payment to a mail message +;; Call `mail-add-payment' to add a hashcash payment to a mail message ;; in the current buffer. ;; -;; Call mail-add-payment-async after writing the addresses but before -;; writing the mail to start calculating the hashcash payment +;; Call `mail-add-payment-async' after writing the addresses but +;; before writing the mail to start calculating the hashcash payment ;; asynchronously. ;; -;; The easiest way to do this automatically for all outgoing mail -;; is to set `message-generate-hashcash' to t. If you want more -;; control, try the following hooks. +;; The easiest way to do this automatically for all outgoing mail is +;; to set `message-generate-hashcash' to `opportunistic' or t. If you +;; want more control, try the following hooks. ;; ;; To automatically add payments to all outgoing mail when sending: ;; (add-hook 'message-send-hook 'mail-add-payment) @@ -44,6 +44,8 @@ ;; ;; To check whether calculations are done before sending: ;; (add-hook 'message-send-hook 'hashcash-wait-or-cancel) +;; +;; For more information, see Info node `(gnus) Hashcash'. ;;; Code: @@ -87,7 +89,9 @@ is used instead." (define-obsolete-variable-alias 'hashcash-path 'hashcash-program "24.4") (defcustom hashcash-program "hashcash" "The name of the hashcash executable. -If this is not in your PATH, specify an absolute file name." +If this is not in your PATH, specify an absolute file name. + +See also `message-generate-hashcash'." :type '(choice (const nil) file)) (defcustom hashcash-extra-generate-parameters '("-Z2") -- 2.39.2