Skip to content

vimdoc-ja/doc/tags-ja もdeployする #268

Closed
@h-east

Description

@h-east

これ、やってない理由なんかあるんでしたっけ?
ローカルでgit pull後に毎回 :helptagsするの忘れがち。

Activity

mattn

mattn commented on Jun 22, 2018

@mattn
Member

賛否両論ありますね。プラグインマネージャによるインストールだと、ドキュメントとしてプラグインが配布されてる場合に作者がタグ生成し忘れてたりすると git diff が出ちゃうので、プラグイン界隈では doc/tags* は同梱しないというのが一般的なんですよね。

h-east

h-east commented on Jun 22, 2018

@h-east
MemberAuthor

CIで自動生成するので「タグ生成し忘れ」は発生しないし同梱してもいいかなと思っています。

koron

koron commented on Jun 22, 2018

@koron
Member

いまざっくりみてたら vimdoc-ja のほうで .gitignore に指定しているんですね。

vim-jp/vimdoc-ja@a2f1f07

@crazymaster doc/tags-ja を含める(= vimdoc-ja の .gitignoreから外す) ことについてなにか意見はありますか?

koron

koron commented on Jun 22, 2018

@koron
Member

もともとはこれか。

vim-jp/vimdoc-ja#70

mattn

mattn commented on Jun 22, 2018

@mattn
Member

あるとすれば

  1. コントリビュータがドキュメントを修正
  2. git commit -a しちゃう
  3. tags-ja が含まれた PR がくる

とかでしょうか。

h-east

h-east commented on Jun 22, 2018

@h-east
MemberAuthor

@mattn vimdoc-ja-working/docの方は今まで通りtags-jaは含めないのでそういうことにはならないんじゃないでしょうか?

mattn

mattn commented on Jun 22, 2018

@mattn
Member

そうですね。なお僕のスタンスは「どちらでもいい」ですが、いくぶんプラグインマネージャに関する知見が多い訳ではないので slack でも意見を募集しています。

koron

koron commented on Jun 22, 2018

@koron
Member

vim-jp/vimdoc-ja#21 でも同じ議論をやってたんですね。
自分はもうすっかり忘れてる。

ざっくり見ると当時は
「どっちでも良い」vs「あったらプラグインマネージャはちょっと苦労するね」
みたいな感じで、「あるほうが良い」という立場は明確ではなかった。
だったらなしにしとこう、というくらいの判断だったんだと思います。

現時点においてどうするべきかは、僕は今も「どっちでも良い」

h-east

h-east commented on Jun 22, 2018

@h-east
MemberAuthor

その議論してた時ってvimdoc-ja-workingあったんでしたっけ?

ちなみにローカルでgit pull後に再度:helptagsしても内容変わらないし、タイムスタンプは変わるけど、gitは変更ファイルとみなさないです。

mattn

mattn commented on Jun 22, 2018

@mattn
Member

vim のバージョンにより出力されるタグが違うって事が起きた時にどうするかですね。

crazymaster

crazymaster commented on Jun 22, 2018

@crazymaster
Member

vim標準のパッケージ機能ではタグファイルを含めることを推奨してますね
:h package-create

h-east

h-east commented on Jun 22, 2018

@h-east
MemberAuthor

そもそも、プラグインマネージャが 無条件 でtags-jaを更新するのどうなの?って思いました。

とりあえず、.vimrcにこんなのを書いて運用してみます。

packadd! vimdoc-ja
let docdir = filter(split(&rtp, ','), 'v:val =~# "vimdoc-ja$"')[0] . '/doc'
let doctag = docdir . '/tags-ja'
if !filereadable(doctag) || getftime(doctag) < getftime(docdir)
  exec "helptags" docdir
endif

(追記)
いや、:helptagsgit pullした後に1度だけおこなえばいいので、これは.vimrcに書くべきものではないですね。
package dir下の各リポジトリを更新して、必要な処理があればおこなう関数(とコマンド)を作れよって話か。

h-east

h-east commented on Jun 23, 2018

@h-east
MemberAuthor

vim標準のパッケージ機能ではタグファイルを含めることを推奨してますね

では含めることにしましょう。
(mattnさん、koronさんも「どっちでもいい」という意見なのも踏まえて)

added a commit that references this issue on Jun 24, 2018
5429158

11 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @mattn@koron@machakann@h-east@crazymaster

        Issue actions

          vimdoc-ja/doc/tags-ja もdeployする · Issue #268 · vim-jp/vimdoc-ja-working