vim-plug icon indicating copy to clipboard operation
vim-plug copied to clipboard

Respect git managed tags

Open h-east opened this issue 6 years ago • 0 comments

Hi Junegunn,

Vim's documentation recommends that package include doc/tags.

:help package-create

Run the :helptags command to generate the doc/tags file.  Including this
generated file in the package means that the user can drop the package in his
pack directory and the help command works right away.  Don't forget to re-run
the command after changing the plugin help:
        :helptags path/start/foobar/doc
        :helptags path/opt/fooextra/doc

:help help-writing

- Make a package with all the files and the tags file available for download.
  Users can drop it in one of the "doc" directories and start use it.
  Report this to Bram, so that he can add a link on www.vim.org.

In fact, many packages does not contain doc/tags in the repository. So I think that vim-plug is unconditionally running :helptags after installation and update. I think that should not run :helptags in the case of installation or update of that package. Please respect tags that git managed.

This PR is changed to execute :helptags only when either of the following conditions is satisfied.

  • tags file is not exist.
  • tags file is not managed by git.

Please check it out.

Note: Repository of package containing doc/tags (or doc/tags-??x)

  • https://github.com/vim-jp/vimdoc-ja
  • https://github.com/vim-jp/autofmt

-- Best regards, Hirohito Higashi (h_east)

h-east avatar Jun 28 '18 12:06 h-east