waylan / vim-markdown-extra-preview

A Python port of vim-markdown-preview that utilizes Python-Markdown's 'extra' extension.
17 stars 7 forks source link

added doc/tags to gitignore #15

Closed brianclements closed 10 years ago

waylan commented 10 years ago

What are you trying to accomplish with this? Where does docs/tags come from that it needs to be ignored?

brianclements commented 10 years ago

Plugin managers like vundle and pathogen automatically create the helptags. And I believe that a byproduct of how they manage the runtime for each plugin ends up with them putting each plugins' own help tags into it's own someplugin/doc folder in a file called "tags" instead of .vim/doc/tags. I noticed this when I was trying to manage my vim folder, and all my vim plugins, as submodules of a "dotfiles" package for storing all my personal configuration files. My directory for this and some other plugins for some reason was always "dirty" because of the auto-generation of this specific tags file. I actually went through and made this same recommendation for those plugins as well.

UPDATE: I investigated further and found that the convention is to package one's plugin with a tags file already included for that plugins documentation file. My auto-generation of tags caught some of your keywords in your help file, but the layout of your help file doesn't have a table of contents, which is usually (I think) how these help files make use of the tags that get generated. For example, this is what was caught for me:

g:VMEPextensions    vmep.txt    /*g:VMEPextensions*
g:VMEPhtmlreader    vmep.txt    /*g:VMEPhtmlreader*
g:VMEPoutputdirectory   vmep.txt    /*g:VMEPoutputdirectory*
g:VMEPoutputformat  vmep.txt    /*g:VMEPoutputformat*
g:VMEPstylesheet    vmep.txt    /*g:VMEPstylesheet*
g:VMEPtemplate  vmep.txt    /*g:VMEPtemplate*
vmep-global-settings    vmep.txt    /*vmep-global-settings*
vmep-local-settings vmep.txt    /*vmep-local-settings*
vmep-templates  vmep.txt    /*vmep-templates*
vmep.txt    vmep.txt    /*vmep.txt*