Re: README used by NonGNU packages "remotely" even though it's ignored

[Philip Kaludercic <philipk@posteo.net>]

Daniel Semyonov <daniel@dsemy.com> writes:

>>>>>> Philip Kaludercic writes:
>
>     > Ignored files specify what files should not be added to the
>     > package tarball.
>
>     > See [0].  By default the README file is used.  If you prefer to,
>     > it is possible to configure using the commentary section.
>
>     > [0]
>     > https://git.savannah.gnu.org/cgit/emacs/elpa.git/tree/README?h=elpa-admin#n132,
>
> Thanks, I previously read the first few paragraphs of the elpa-admin
> README and made the (incorrect) assumption that it wasn't very relevant
> to me as a package author.

There is certainly potential to improve the documentation.

> Attached is a patch updating my packages to use the commentary.

Thanks, it has been pushed.

> From 7be993e60bdc7c69a8dd8444f0bca6e5c108957f Mon Sep 17 00:00:00 2001
> From: Daniel Semyonov <daniel@dsemy.com>
> Date: Wed, 8 Jun 2022 00:54:29 +0300
> Subject: [PATCH] * elpa-packages (vcomplete, swsw): Use commentary for
>  ':readme'
>
> ---
>  elpa-packages | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/elpa-packages b/elpa-packages
> index 034ed41c01..a6bf3ffd8f 100644
> --- a/elpa-packages
> +++ b/elpa-packages
> @@ -531,6 +531,7 @@
>    :ignored-files ("COPYING" "scripts" "test" "Eldev" "Makefile"))
>  
>   ("swsw"		:url "https://git.sr.ht/~dsemy/swsw"
> +  :readme ignore
>    :doc "swsw.texi"
>    :news "NEWS")
>  
> @@ -563,6 +564,7 @@
>   ("vc-fossil"		:url "https://github.com/venks1/emacs-fossil")
>  
>   ("vcomplete"		:url "https://git.sr.ht/~dsemy/vcomplete"
> +  :readme ignore
>    :doc "vcomplete.texi"
>    :news "NEWS")