junegunn / goyo.vim

:tulip: Distraction-free writing in Vim
MIT License
4.49k stars 115 forks source link

Add doc/tags to gitignore #154

Closed Jab2870 closed 7 years ago

Jab2870 commented 7 years ago

Hi, I use pathogen to manage all of my plugins which are git sub-modules. Unfortunately, as soon as I open vim, this plugin creates the file doc/tags which git notices as a new file and makes the sub-module dirty.

IF you could add the line doc/tags to the .gitignore file, it would make life easier for anyone using pathogen

Jab2870 commented 7 years ago

When I opened this, I didn't realise there was a pull request ( #153 ) open

junegunn commented 7 years ago

I can merge that, but many of my plugins also do not have .gitignore. Any reason you can't configure your submodules to ignore changes? It should be easier for you to do that than to ask every plugin maintainer.

Jab2870 commented 7 years ago

Your plugin is the only plugin I use that has this issue. I believe Pathogen (and vundle certainly used to although I don't use it now so can't be sure) create this file at run time. It is possible to ask git to ignore it but a lot of people use Pathogen.

Most other plugins I use have this .gitignore-d.

If you don't wish to ignore it, please could you add instructions to your readme to ignore dirty submodules?

Once the submodule has been added, you need to add a line to the .gitmodules file for your submodule.

Here is the relevant extract from my .gitmodules folder:

[submodule "bundle/goyo.vim"]
    path = bundle/goyo.vim
    url = https://github.com/junegunn/goyo.vim
    ignore = dirty
junegunn commented 7 years ago

Closed by #153