~pkal/public-inbox

This thread contains a patchset. You're looking at the original emails, but you may wish to use the patch review UI. Review patch
6 2

[PATCH] Updating README to document integration with all supported

Details
Message ID
<20201228230433.3139-1-swflint@flintfam.org>
DKIM signature
missing
Download raw message
Hello,

In your README, you present a configuration for using rmail, and
leaves other users to dig into code do discover what hooks to add
autocrypt-mode to.  To correct this, I've added a small bit to the
README that can (hopefully) help clear it up.

Thanks,

Sam

[PATCH] Include documentation for all hooks

Details
Message ID
<20201228230433.3139-2-swflint@flintfam.org>
In-Reply-To
<20201228230433.3139-1-swflint@flintfam.org> (view parent)
DKIM signature
missing
Download raw message
Patch: +8 -0
---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 213b57a..1ff54b8 100644
--- a/README.md
+++ b/README.md
@@ -40,6 +40,14 @@ command. In case you want to manually configure your setup, customise
the `autocrypt-accounts` option. Note that configuring a key is
necessary for `autocrypt.el` to function properly.

`autocrypt-mode` may be added to the following hooks (if not using
`use-package`):

- `gnus-load-hook`
- `message-mode-hook`
- `mu4e-main-mode-hook`
- `rmail-mode-hook`

Bug reports and patches should be sent to my [public inbox].

Copying
-- 
Samuel W. Flint
4096R/FA13D704
     (F50D 862B 4F65 5943 A8C2  EF0E 86C9 3E7A FA13 D704)
λs.(s s) λs.(s s)
   ** I choose to use plain-text email.  It is universally supported,
   ** please be courteous and do so yourself: useplaintext.email

Re: [PATCH] Include documentation for all hooks

Details
Message ID
<87pn2tle5u.fsf@flintfam.org>
In-Reply-To
<20201228230433.3139-2-swflint@flintfam.org> (view parent)
DKIM signature
missing
Download raw message
Please ignore the initial patch -- I managed to mangle a setting.

Sam


-- 
Samuel W. Flint
4096R/FA13D704
      (F50D 862B 4F65 5943 A8C2  EF0E 86C9 3E7A FA13 D704)
λs.(s s) λs.(s s)
    ** I choose to use plain-text email.  It is universally supported,
    ** please be courteous and do so yourself: useplaintext.email
Details
Message ID
<87sg7pv7vm.fsf@posteo.net>
In-Reply-To
<20201228230433.3139-1-swflint@flintfam.org> (view parent)
DKIM signature
missing
Download raw message
"Samuel W. Flint" <swflint@flintfam.org> writes:

> Hello,
>
> In your README, you present a configuration for using rmail, and
> leaves other users to dig into code do discover what hooks to add
> autocrypt-mode to.  To correct this, I've added a small bit to the
> README that can (hopefully) help clear it up.

Honestly, looking at the README, I think it's better to just rewrite the
entire "how to use section". I have stopped using use-package, and have
since realized that this convenience for some might not be that
appreciated by others. And in general, it would be nice to have a
minimal configuration for all supported mail systems.

> Thanks,
>
> Sam
>

-- 
	Philip K.
Details
Message ID
<87czytldla.fsf@flintfam.org>
In-Reply-To
<87sg7pv7vm.fsf@posteo.net> (view parent)
DKIM signature
missing
Download raw message
Sorry for sending this to you twice.
>>>>> Philip K writes:

    PK> "Samuel W. Flint" <swflint@flintfam.org> writes:
    >> Hello,
    >> 
    >> In your README, you present a configuration for using rmail, and
    >> leaves other users to dig into code do discover what hooks to add
    >> autocrypt-mode to.  To correct this, I've added a small bit to
    >> the README that can (hopefully) help clear it up.

    PK> Honestly, looking at the README, I think it's better to just
    PK> rewrite the entire "how to use section". I have stopped using
    PK> use-package, and have since realized that this convenience for
    PK> some might not be that appreciated by others. And in general, it
    PK> would be nice to have a minimal configuration for all supported
    PK> mail systems.

In that case, I can start on some for GNUS and re-submit the patch.

    >> Thanks,
    >> 
    >> Sam
    >> 

    PK> -- Philip K.

Sam

-- 
Samuel W. Flint
4096R/FA13D704
      (F50D 862B 4F65 5943 A8C2  EF0E 86C9 3E7A FA13 D704)
λs.(s s) λs.(s s)
    ** I choose to use plain-text email.  It is universally supported,
    ** please be courteous and do so yourself: useplaintext.email

[PATCH v2] Include documentation for all hooks

Details
Message ID
<20201229003956.12514-1-swflint@flintfam.org>
In-Reply-To
<87czytldla.fsf@flintfam.org> (view parent)
DKIM signature
missing
Download raw message
Patch: +16 -7
---
 README.md | 23 ++++++++++++++++-------
 1 file changed, 16 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 213b57a..0cb2b27 100644
--- a/README.md
+++ b/README.md
@@ -26,13 +26,8 @@ integration is welcomed.
How to use
----------

This package is published on [MELPA]. Using `use-package`, one might
configure `autocrypt.el` to read headers using Rmail and inject
headers using `message-mode` as follows:

	(use-package autocrypt
	  :hook ((rmail-mode . autocrypt-mode)
	         (message-mode . autocrypt-mode)))
This package is published on [MELPA].  It may also be installed
directly.

Autocrypt recommends using a new or separate key pair for signing and
encrypting. If you wish to do so, call the `autocrypt-create-account`
@@ -40,6 +35,20 @@ command. In case you want to manually configure your setup, customise
the `autocrypt-accounts` option. Note that configuring a key is
necessary for `autocrypt.el` to function properly.

`autocrypt-accounts` is a list of triples, taking the form `(MAIL
FINGERPRINT PREFERENCE)`.  `FINGERPRINT` is the key fingerprint used
by `MAIL`, and `PREFERENCE` is what preference should be used, either
`'mutual`, `'no-preference` or `'none` normally; `nil` may be used to
temporarily disable the account.

To enable autocrypt, add `autocrypt-mode` to the relevant hooks shown
below:

- `gnus-load-hook`
- `message-mode-hook`
- `mu4e-main-mode-hook`
- `rmail-mode-hook`

Bug reports and patches should be sent to my [public inbox].

Copying
-- 
2.29.2

Re: [PATCH v2] Include documentation for all hooks

Details
Message ID
<87im8kvp63.fsf@posteo.net>
In-Reply-To
<20201229003956.12514-1-swflint@flintfam.org> (view parent)
DKIM signature
missing
Download raw message
"Samuel W. Flint" <swflint@flintfam.org> writes:

> ---
>  README.md | 23 ++++++++++++++++-------
>  1 file changed, 16 insertions(+), 7 deletions(-)
>
> diff --git a/README.md b/README.md
> index 213b57a..0cb2b27 100644
> --- a/README.md
> +++ b/README.md
> @@ -26,13 +26,8 @@ integration is welcomed.
>  How to use
>  ----------
>  
> -This package is published on [MELPA]. Using `use-package`, one might
> -configure `autocrypt.el` to read headers using Rmail and inject
> -headers using `message-mode` as follows:
> -
> -	(use-package autocrypt
> -	  :hook ((rmail-mode . autocrypt-mode)
> -	         (message-mode . autocrypt-mode)))
> +This package is published on [MELPA].  It may also be installed
> +directly.
>  
>  Autocrypt recommends using a new or separate key pair for signing and
>  encrypting. If you wish to do so, call the `autocrypt-create-account`
> @@ -40,6 +35,20 @@ command. In case you want to manually configure your setup, customise
>  the `autocrypt-accounts` option. Note that configuring a key is
>  necessary for `autocrypt.el` to function properly.
>  
> +`autocrypt-accounts` is a list of triples, taking the form `(MAIL
> +FINGERPRINT PREFERENCE)`.  `FINGERPRINT` is the key fingerprint used
> +by `MAIL`, and `PREFERENCE` is what preference should be used, either
> +`'mutual`, `'no-preference` or `'none` normally; `nil` may be used to
> +temporarily disable the account.

There is really no need to document this in the README. First of all, it
is not the primary documentation, second of all, this is an internal
representation (defvar instead of defcustom), that the user shouldn't
have to worry about. It might even change between versions, so it's
certainly not something that should be promoted.

> +To enable autocrypt, add `autocrypt-mode` to the relevant hooks shown
> +below:
> +
> +- `gnus-load-hook`
> +- `message-mode-hook`
> +- `mu4e-main-mode-hook`
> +- `rmail-mode-hook`

I was thinking of just writing out the code for every mode. So something
like

        **Gnus**

                (add-hook 'gnus-load-hook #'autocrypt-mode)

        ...

>  Bug reports and patches should be sent to my [public inbox].
>  
>  Copying

-- 
	Philip K.
Reply to thread Export thread (mbox)