Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.debian.bugs.dist > #1223547

Bug#1089625: dap-mode 0.8-1 upload

Show all headers | View raw

[Multipart message — attachments visible in raw view] - view raw

Sean Whitton <spwhitton@spwhitton.name> writes:

> Hello,
>
> On Tue 10 Dec 2024 at 10:45am -08, Xiyue Deng wrote:
>
>> Hi Sean,
>>
>> Sean Whitton <spwhitton@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

Back to linux.debian.bugs.dist | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

Bug#1089625: RFS: dap-mode/0.8-1 -- DAP UI controls implemented using treemacs Xiyue Deng <manphiz@gmail.com> - 2024-12-10 06:40 +0100
  Bug#1089625: dap-mode 0.8-1 upload Sean Whitton <spwhitton@spwhitton.name> - 2024-12-10 11:30 +0100
    Bug#1089625: dap-mode 0.8-1 upload Xiyue Deng <manphiz@gmail.com> - 2024-12-10 19:50 +0100
      Bug#1089625: dap-mode 0.8-1 upload Sean Whitton <spwhitton@spwhitton.name> - 2024-12-11 03:20 +0100
        Bug#1089625: dap-mode 0.8-1 upload Xiyue Deng <manphiz@gmail.com> - 2024-12-11 07:40 +0100
          Bug#1089625: dap-mode 0.8-1 upload Sean Whitton <spwhitton@spwhitton.name> - 2024-12-12 04:00 +0100
            Bug#1089625: dap-mode 0.8-1 upload Nicholas D Steeves <nsteeves@gmail.com> - 2024-12-12 04:10 +0100
  Bug#1089625: dap-mode 0.8-1 upload Sean Whitton <spwhitton@spwhitton.name> - 2024-12-12 12:10 +0100
  Bug#1089625: dap-mode 0.8-1 upload Sean Whitton <spwhitton@spwhitton.name> - 2024-12-13 12:30 +0100
  Re: Bug#1089625: dap-mode 0.8-1 upload Soren Stoutner <soren@debian.org> - 2024-12-14 21:00 +0100
    Re: Bug#1089625: dap-mode 0.8-1 upload Xiyue Deng <manphiz@gmail.com> - 2024-12-15 10:20 +0100
      Re: Bug#1089625: dap-mode 0.8-1 upload Soren Stoutner <soren@debian.org> - 2024-12-16 22:00 +0100
  Bug#1089625: dap-mode 0.8-1 upload Sean Whitton <spwhitton@spwhitton.name> - 2024-12-15 03:40 +0100
  Bug#1089625: dap-mode 0.8-1 upload Sean Whitton <spwhitton@spwhitton.name> - 2024-12-15 12:00 +0100
    Re: Bug#1089625: dap-mode 0.8-1 upload Soren Stoutner <soren@debian.org> - 2024-12-16 22:20 +0100
      Re: Bug#1089625: dap-mode 0.8-1 upload Xiyue Deng <manphiz@gmail.com> - 2024-12-19 03:50 +0100
  Bug#1089625: dap-mode 0.8-1 upload Sean Whitton <spwhitton@spwhitton.name> - 2024-12-17 03:10 +0100
  Bug#1089625: dap-mode 0.8-1 upload Sean Whitton <spwhitton@spwhitton.name> - 2024-12-18 02:50 +0100
  Bug#1089625: dap-mode 0.8-1 upload Sean Whitton <spwhitton@spwhitton.name> - 2024-12-18 08:40 +0100
  Bug#1089625: dap-mode 0.8-1 upload Sean Whitton <spwhitton@spwhitton.name> - 2024-12-18 13:10 +0100
  Bug#1089625: dap-mode 0.8-1 upload Sean Whitton <spwhitton@spwhitton.name> - 2024-12-19 02:50 +0100

csiph-web