Bug#964729: vim-gitgutter doesn't respect the Debian vim policy
On 2020-07-11 09 h 37, James McCoy wrote: > On Thu, Jul 09, 2020 at 01:00:24PM -0400, Louis-Philippe Véronneau wrote: >> On 2020-07-09 12 h 37, Raphael Medaer wrote: >>> Dear Louis-Philippe, >>> >>> The first packaging I did (not published) was using `vim-addon-manager`. >>> Although I switch to dh-vim_addon (and friends) which is not using >>> `vim-addon-manager` anymore. >>> This move has been recommended by James McCoy (who >>> sponsored the package). >>> >>> I guess you spotted a lack of documentation/policy for this new helper: >>> `dh-vim_addon`. >>> I add James in CC. Maybe should we discuss/write a new Policy and/or some >>> guidelines. >>> >>> I already started a TODO list of checks for new/next vim addon packages. I >>> would appreciate some feedback on it, but first let me a few days to make >>> it clean. >>> >>> Here are some additional notes about your comments: >>> >>> > It appears this package doesn't follow the Debian vim policy [1]. It's >>> > clearly not easy to find (I had to search quite a bit to find it), but I >>> > think it's important vim packages try to respect it :) >>> >>> Is this policy still relevant ? Already mentionned above. >> >> No idea, I'm only a vim user and I haven't done any vim work in Debian :) > > The policy basically codifies the behavior that we implemented in vam. > That's problematic in its own right, but also an issue because vam is > very flawed (see #438482). > > >>> > * the addon is enabled after the installation; it shouldn't >>> >>> If I well understood James' advices: with `dh-vim_addon` help, vim addon >>> packages should always be enabled if you can disable them through your >>> vimrc with `let g:loaded_gitgutter = 1`. >> This is quite a big change and I guess it breaks my current setup :s > > I'm curious about how this breaks your setup. Could you explain this > more? Nothing important really. I use configuration management on hosts I use (servers and clients) to get a consistent vim profile, and I used vam to enable or disable addons. Addons being enabled by default will simply mean everything will be done via vimrc files. -- ⢀⣴⠾⠻⢶⣦⠀ ⣾⠁⢠⠒⠀⣿⡁ Louis-Philippe Véronneau ⢿⡄⠘⠷⠚⠋ po...@debian.org / veronneau.org ⠈⠳⣄ signature.asc Description: OpenPGP digital signature
Bug#964729: vim-gitgutter doesn't respect the Debian vim policy
On Thu, Jul 09, 2020 at 01:00:24PM -0400, Louis-Philippe Véronneau wrote: > On 2020-07-09 12 h 37, Raphael Medaer wrote: > > Dear Louis-Philippe, > > > > The first packaging I did (not published) was using `vim-addon-manager`. > > Although I switch to dh-vim_addon (and friends) which is not using > > `vim-addon-manager` anymore. > > This move has been recommended by James McCoy (who > > sponsored the package). > > > > I guess you spotted a lack of documentation/policy for this new helper: > > `dh-vim_addon`. > > I add James in CC. Maybe should we discuss/write a new Policy and/or some > > guidelines. > > > > I already started a TODO list of checks for new/next vim addon packages. I > > would appreciate some feedback on it, but first let me a few days to make > > it clean. > > > > Here are some additional notes about your comments: > > > > > It appears this package doesn't follow the Debian vim policy [1]. It's > > > clearly not easy to find (I had to search quite a bit to find it), but I > > > think it's important vim packages try to respect it :) > > > > Is this policy still relevant ? Already mentionned above. > > No idea, I'm only a vim user and I haven't done any vim work in Debian :) The policy basically codifies the behavior that we implemented in vam. That's problematic in its own right, but also an issue because vam is very flawed (see #438482). > > > * the addon is enabled after the installation; it shouldn't > > > > If I well understood James' advices: with `dh-vim_addon` help, vim addon > > packages should always be enabled if you can disable them through your > > vimrc with `let g:loaded_gitgutter = 1`. > This is quite a big change and I guess it breaks my current setup :s I'm curious about how this breaks your setup. Could you explain this more? Most people expect that installing something makes it available, rather than having to jump through more hoops to get it working. That's why the recommendation for dh-vim-addon is to enable by default for well behaved addons. All addons, whether installed disabled by default or not, are managed by Vim's builtin "package" functionality. This means the behavior isn't unique to Debian. There's still the option for the packager to make them "optional", which then lets the user explicitly enable them. However, that should generally be used for addons which are either heavyweight or require configuration before being able to do something sensible (or for packages like vim-scripts which install numerous addons). > I feel this should be publicized and done in coordinated fashion for all > the vim packages in preparation for Bullseye. Having a mix of the two > behaviors (enabled and disabled by default) sounds like headache. Agreed, and that's my fault for not pushing harder on this. I had arbitrarily decided to do that after I had converted vim-scripts to dh-vim-addon, but I'm taking too long to finish that. > I don't mind moving to something else, but I quite like being able to > use vim-addon-manager as a frontend for vim addons. It would be nice if > the new packaging guidelines made it somehow possible to continue using > that tool. vam doesn't work with the new addon structure and generally has problems with addons evolving over time (see #438482). I've been wanting to get rid of vam for years. When Vim finally added the packages functionality (essentially a builtin version of vim-pathogen), I knew that was the right way to move forward. It just took time for me to finally sit down and write dh-vim-addon. Cheers, -- James GPG Key: 4096R/91BF BF4D 6956 BD5D F7B7 2D23 DFE6 91AE 331B A3DB
Bug#964729: vim-gitgutter doesn't respect the Debian vim policy
On 2020-07-09 12 h 37, Raphael Medaer wrote: > Dear Louis-Philippe, > > The first packaging I did (not published) was using `vim-addon-manager`. > Although I switch to dh-vim_addon (and friends) which is not using > `vim-addon-manager` anymore. > This move has been recommended by James McCoy (who > sponsored the package). > > I guess you spotted a lack of documentation/policy for this new helper: > `dh-vim_addon`. > I add James in CC. Maybe should we discuss/write a new Policy and/or some > guidelines. > > I already started a TODO list of checks for new/next vim addon packages. I > would appreciate some feedback on it, but first let me a few days to make it > clean. > > Here are some additional notes about your comments: > > > It appears this package doesn't follow the Debian vim policy [1]. It's > > clearly not easy to find (I had to search quite a bit to find it), but I > > think it's important vim packages try to respect it :) > > Is this policy still relevant ? Already mentionned above. No idea, I'm only a vim user and I haven't done any vim work in Debian :) > > > * the addon is enabled after the installation; it shouldn't > > If I well understood James' advices: with `dh-vim_addon` help, vim addon > packages should always be enabled if you can disable them through your vimrc > with `let g:loaded_gitgutter = 1`. This is quite a big change and I guess it breaks my current setup :s I feel this should be publicized and done in coordinated fashion for all the vim packages in preparation for Bullseye. Having a mix of the two behaviors (enabled and disabled by default) sounds like headache. I don't mind moving to something else, but I quite like being able to use vim-addon-manager as a frontend for vim addons. It would be nice if the new packaging guidelines made it somehow possible to continue using that tool. Cheers! -- ⢀⣴⠾⠻⢶⣦⠀ ⣾⠁⢠⠒⠀⣿⡁ Louis-Philippe Véronneau ⢿⡄⠘⠷⠚⠋ po...@debian.org / veronneau.org ⠈⠳⣄ signature.asc Description: OpenPGP digital signature
Bug#964729: vim-gitgutter doesn't respect the Debian vim policy
Dear Louis-Philippe, The first packaging I did (not published) was using `vim-addon-manager`. Although I switch to dh-vim_addon (and friends) which is not using `vim-addon-manager` anymore. This move has been recommended by James McCoy (who sponsored the package). I guess you spotted a lack of documentation/policy for this new helper: `dh-vim_addon`. I add James in CC. Maybe should we discuss/write a new Policy and/or some guidelines. I already started a TODO list of checks for new/next vim addon packages. I would appreciate some feedback on it, but first let me a few days to make it clean. Here are some additional notes about your comments: > It appears this package doesn't follow the Debian vim policy [1]. It's > clearly not easy to find (I had to search quite a bit to find it), but I > think it's important vim packages try to respect it :) Is this policy still relevant ? Already mentionned above. > * the addon is enabled after the installation; it shouldn't If I well understood James' advices: with `dh-vim_addon` help, vim addon packages should always be enabled if you can disable them through your vimrc with `let g:loaded_gitgutter = 1`. > * the package doesn't depend on "vim-addon-manager" like other vim plugins do It should not anymore, thanks to dh-vim_addon helper. -- Raphaël Medaer
Bug#964729: vim-gitgutter doesn't respect the Debian vim policy
Package: vim-gitgutter Version: 0~20200414-1 Severity: important Dear maintainer, It appears this package doesn't follow the Debian vim policy [1]. It's clearly not easy to find (I had to search quite a bit to find it), but I think it's important vim packages try to respect it :) Here are the problems I saw while giving the package a quick test: * the addon is enabled after the installation; it shouldn't * the package doesn't depend on "vim-addon-manager" like other vim plugins do * after the installation, it doesn't show up when running "vim-addon-manager status". I think the "Severity: important" is justified since this breaks what vim users are used to on Debian. Thanks for packaging vim-gitgutter, I'm really looking forward to using it once this is fixed! [1] https://web.archive.org/web/20151022212021/http://pkg-vim.alioth.debian.org/vim-policy.html/index.html -- ⢀⣴⠾⠻⢶⣦⠀ ⣾⠁⢠⠒⠀⣿⡁ Louis-Philippe Véronneau ⢿⡄⠘⠷⠚⠋ po...@debian.org / veronneau.org ⠈⠳⣄ signature.asc Description: OpenPGP digital signature
