Hello,

On Tue 10 Dec 2024 at 10:32pm -08, Xiyue Deng wrote:

> I see.  I checked Policy 12.7[1] and it does suggest providing an
> upstream in plain text format and should be named `changelog', though
> as I understand it, the footnote suggests that the purpose is more about
> make it easy to be found instead of requiring the format.

Yes, exactly.  It's fine to install an Org-mode README.org as just
/usr/share/doc/package/README(.gz).

> Meanwhile, there are packages with README or CHANGELOG in markdown
> format, and shipping those are also common practice.  I think org files
> can be considered as similar.  As markdown is somehow in between a
> human-readable and machine-readable format, the boundary is kind of
> blurred, though I would like to think that they are essentially text
> format.
>
> That said, even though I would prefer to ship CHANGELOG.org under
> /usr/share/doc/dap-mode as-is, I would not insist.  Do you think it is
> OK to just skip/not-shipping it? (Or convert it to plain text which
> would need other dependencies that would be better to avoid :P)

I think you are stuck on file extensions.  They're not that important :)
Just ship it as is, under the name README.

-- 
Sean Whitton

Attachment: signature.asc
Description: PGP signature

Reply via email to