Sean Whitton <spwhit...@spwhitton.name> writes: > Hello, > > On Tue 10 Dec 2024 at 10:45am -08, Xiyue Deng wrote: > >> Hi Sean, >> >> Sean Whitton <spwhit...@spwhitton.name> writes: >> >>> Hello Xiyue, >>> >>> Thanks for adopting the package. >>> >>> You've added a wrong-name-for-upstream-changelog override. What name >>> does the file get installed as? The .org extension shouldn't be present >>> in the filesystem under /usr/share/doc, if that is what it is. >>> >> >> I didn't know of such restriction. I was looking at the Debian policy >> 12.3[1] which suggests "Additional documentation included in the package >> should be installed under /usr/share/doc/package" so I thought it was OK >> to ship org documentation under /usr/share/doc/dap-mode/. What would be >> the recommended practice to ship the org documentation? > > Specifically, README should always be README, just like how > README.Debian should always be README.Debian. I'm not sure this is a > Policy requirement, just a good idea. >
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. 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) > -- > Sean Whitton [1] https://www.debian.org/doc/debian-policy/ch-docs.html#changelog-files-and-release-notes -- Regards, Xiyue Deng
signature.asc
Description: PGP signature
