Re: Add plz-media-type and plz-event-source to GNU ELPA when stabilised

[Roman Scherer <roman.scherer@burningswell.com>]

[-- Attachment #1.1: Type: text/plain, Size: 1215 bytes --]


Hi Philip,

I splitted the README and the manual. I attached 2 new patches which I
created from adding the packages to the elpa repository locally.

I also declare the ignored files now in the .elpaignore file of the
repositories.

The tarballs now cintain this:

 -rw-rw-r--   roman/roman     30814 plz-media-type-0.1pre0.20240501.111146/plz-media-type.el
 -rw-rw-r--   roman/roman      1825 plz-media-type-0.1pre0.20240501.111146/README-elpa
 -rw-rw-r--   roman/roman       429 plz-media-type-0.1pre0.20240501.111146/plz-media-type-pkg.el
 -rw-rw-r--   roman/roman      1329 plz-media-type-0.1pre0.20240501.111146/README.org
 -rw-rw-r--   roman/roman     19165 plz-media-type-0.1pre0.20240501.111146/plz-media-type.info

 -rw-rw-r--   roman/roman      4390 plz-event-source-0.1pre0.20240501.111443/plz-event-source.info
 -rw-rw-r--   roman/roman      1689 plz-event-source-0.1pre0.20240501.111443/README-elpa
 -rw-rw-r--   roman/roman      1140 plz-event-source-0.1pre0.20240501.111443/README.org
 -rw-rw-r--   roman/roman     18249 plz-event-source-0.1pre0.20240501.111443/plz-event-source.el
 -rw-rw-r--   roman/roman       436 plz-event-source-0.1pre0.20240501.111443/plz-event-source-pkg.el

Thanks, Roman.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: v2-0001-Add-plz-media-type.patch --]
[-- Type: text/x-diff, Size: 852 bytes --]

From cc4ccc8bf5a66e30ba40d3b0d355284ad26d5243 Mon Sep 17 00:00:00 2001
Message-ID: <cc4ccc8bf5a66e30ba40d3b0d355284ad26d5243.1714562298.git.roman@burningswell.com>
From: Roman Scherer <roman@burningswell.com>
Date: Sun, 28 Apr 2024 14:35:20 +0200
Subject: [PATCH v2 1/2] Add plz-media-type

---
 elpa-packages | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/elpa-packages b/elpa-packages
index 4a0c1bd..a56cc6f 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -587,6 +587,8 @@
   :release-branch "stable"
   :ignored-files ("LICENSE")
   :doc "README.org")
+ (plz-media-type        :url "https://github.com/r0man/plz-media-type"
+  :doc "plz-media-type.org")
  (plz-see		:url "https://github.com/astoff/plz-see.el"
   :readme "README.org")
  (poke			:url "https://git.savannah.gnu.org/git/poke/poke-el.git"
-- 
2.41.0


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.3: v2-0002-Add-plz-event-source.patch --]
[-- Type: text/x-diff, Size: 1059 bytes --]

From 1ba92029324d61a1457df8c1540e3bc73debb7e3 Mon Sep 17 00:00:00 2001
Message-ID: <1ba92029324d61a1457df8c1540e3bc73debb7e3.1714562298.git.roman@burningswell.com>
In-Reply-To: <cc4ccc8bf5a66e30ba40d3b0d355284ad26d5243.1714562298.git.roman@burningswell.com>
References: <cc4ccc8bf5a66e30ba40d3b0d355284ad26d5243.1714562298.git.roman@burningswell.com>
From: Roman Scherer <roman@burningswell.com>
Date: Sun, 28 Apr 2024 14:35:51 +0200
Subject: [PATCH v2 2/2] Add plz-event-source

---
 elpa-packages | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/elpa-packages b/elpa-packages
index a56cc6f..c4c1d56 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -587,6 +587,8 @@
   :release-branch "stable"
   :ignored-files ("LICENSE")
   :doc "README.org")
+ (plz-event-source        :url "https://github.com/r0man/plz-event-source"
+  :doc "plz-event-source.org")
  (plz-media-type        :url "https://github.com/r0man/plz-media-type"
   :doc "plz-media-type.org")
  (plz-see		:url "https://github.com/astoff/plz-see.el"
-- 
2.41.0


[-- Attachment #1.4: Type: text/plain, Size: 3519 bytes --]


Philip Kaludercic <philipk@posteo.net> writes:

> Roman Scherer <roman.scherer@burningswell.com> writes:
>
>> Hi Philip,
>>
>> ok, perfect. Thanks for your help on this!
>
> Can you just tell me what the names of the manual files will be?  Also,
> if possible it would be better if you could track the files to ingore
> inside the repository using a .elpaignore file (I just noticed the
> patches now, so I didn't see what you were proposing until now).
>
>> Roman
>>
>> Philip Kaludercic <philipk@posteo.net> writes:
>>
>>> Roman Scherer <roman.scherer@burningswell.com> writes:
>>>
>>>> Hi Philip,
>>>>
>>>> Philip Kaludercic <philipk@posteo.net> writes:
>>>>
>>>>>
>>>>> The different files have different audiences.  I'd say:
>>>>>
>>>>> - The README is an introduction to anyone who just checked out a
>>>>>   repository (or found it on some Website), and wants to know what it is
>>>>>   about.  It should just be a starting point, linking to other resources
>>>>>   (INSTALL, COPYING, ChangeLog, proper documentation, ...) where
>>>>>   possible.
>>>>>
>>>>> - The documentation is for people who have installed a package and want
>>>>>   to know the exact details of how something works or is done.  It is
>>>>>   not something that would usually interest someone who hasn't
>>>>>   downloaded and installed a package.
>>>>>
>>>>> - The package description (C-h P foo RET) is a brief explanation of what
>>>>>   a package does and provides.  It should focus on the questions the
>>>>>   user might have when they first encounter the package:
>>>>>
>>>>>   * If the name is not indicative, what is the package even about.
>>>>>   
>>>>>   * What is the core functionality and how is it used.
>>>>>
>>>>>   * Who is the target audience.
>>>>>
>>>>>   * What are the entry points to the package.
>>>>>
>>>>>   * What differentiates the package from other similar packages.
>>>>>
>>>>>   or other questions like these.  It should NOT include:
>>>>>
>>>>>   * A table of contents
>>>>>
>>>>>   * Installation instructions of any kind (there is a install button in
>>>>>     the package description buffer)
>>>>>
>>>>>   * Extensive details on how to configure the package
>>>>>
>>>>>   * Screenshots, as these are currently not displayed
>>>>>
>>>>>   * Changelog information
>>>>>
>>>>>   and instead try and to keep it short and simple.  It is just a sales
>>>>>   pitch, not a lecture.
>>>>>
>>>>> Sadly a number of packages just use the same README.org file for all
>>>>> these things, confusing the separate audiences.  If anything, it is
>>>>> acceptable to mix the first two, but the third should certainly not
>>>>> result in a 500+ line buffer (as is currently the case with "plz").  The
>>>>> easiest way to address the last point is just to use the commentary
>>>>> section in the main file to generate the description of the package,
>>>>> which we can configure in elpa.git.
>>>>
>>>> Ok, thanks for the explanation. I will then split the README and the
>>>> manual up. I will do this in the next days.
>>>
>>> OK, I can add the packages to elpa.git in the meantime.
>>>
>>>> I looked a bit around and will probably do something similar to what
>>>> Protesilaos does in his packages. This one being an example:
>>>>
>>>> https://github.com/protesilaos/ef-themes
>>>
>>> If I am not mixing something up, I think I recommended something along
>>> the lines I wrote above to him as well ^^
>>>
>>>> Roman
>>>>
>>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 528 bytes --]