Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wikiの情報が古いのかすぐ使えないものが多い(特にhtmlfileサブコマンド) #174

Open
universato opened this issue Jan 10, 2022 · 3 comments

Comments

@universato
Copy link
Contributor

BitClustのWikiの情報が古いのか、
すぐ使えないものが多いように思います。

特にhtmlfileサブコマンドについて、使いやすくあって欲しいです。

bitclust htmlfile --target=Range Range > t.html
bitclust htmlfile ../doctree/refm/api/src/_builtin/Array --target Array > t.html
bitclust htmlfile ../doctree/refm/api/src/net/https.rd > a.html
bitclust htmlfile src/zlib/GzipReader                              #ライブラリGzipReader
bitclust htmlfile src/zlib/GzipReader --target=Zlib::GZipReader    #クラスGzipReader
bitclust htmlfile --force mkmf.rd                                  #ファイルの全体を強制的に出力する
bitclust htmlfile --ruby=1.8.6 --target=Array Array > t.html       #rubyのバージョンを指定
bitclust htmlfile --capi ../doctree/refm/capi/src/array.c.rd --target=rb_ary_new3 # C API では現状 --target 必須

1番最初のRangeなどクラス指定だけでいけそうな雰囲気ですが、
パスじゃないと上手くいかないように思います。
htmlfileコマンドそのものの問題ですけど、パスが存在しないときにRuby本体のエラー文が10行ほどでるので、わかりにくいです。
これは、別でIssueをたてるべきでしょうかね。

後半の--force--capiについて、
--forceオプションは存在するようですが動かないし、
--capiは、invalid optionだと怒られます。

動かないもの等、Wikiから消したりしていきたいです。

@scivola
Copy link
Contributor

scivola commented Jan 10, 2022

そうなんですよね。
私も以前,るりまの修正に参加していましたが,先日,久しぶりにやろうとするとうまくいかなくて,当時どうやっていたのか思い出せず止まっています(←イマココ)

マニュアル全体のビルドはできますし,文章のタイポ修正くらいなら GitHub 上でやれるのですが,フォーマットが問題になるような修正は htmlfile サブコマンドを使う必要があり,それができなくて困っています。
Wiki を見れば誰でもやれるようになっているといいですね。
記述が古い,もしくは少し間違っている(?)のに加え,複数ページに似た記述があって,どこをみたらいいのか,久々に読もうとするとよく分からないです。

るりまの編集に参加していた頃,一度 Wiki を分かりやすく書き直そうと思ったのですが,それができる程度に bitclust を理解することができず,断念した覚えもあります。

@ima1zumi
Copy link

特にhtmlfileサブコマンドについて、使いやすくあって欲しいです。

私も Wiki に bitclust htmlfile でどういう場合に使えるかという説明があると嬉しいです。
個人的に、GitHub の Wiki は更新しても誰にも通知が飛ばないことと、レビューされないまま更新できてしまうのが好きではなくて修正するハードルが高いです。気にせず更新していってしまったほうがいいんですかねえ

--forceオプションは存在するようですが動かないし、

--force オプションが動かなかった場合が分からなかったのですが、特定の場合には動きます。例えば、https://github.com/rurema/doctree/blob/master/refm/doc/symref.rd のようなそのままでは途中で落ちて出力できないファイルを --force で出力させることができます。

$ bitclust htmlfile refm/doc/symref.rd > /tmp/tmp.html # 失敗する
$ bitclust htmlfile --force refm/doc/symref.rd > /tmp/tmp.html # 出力できる

@universato
Copy link
Contributor Author

--force オプションが動かなかった場合が分からなかったのですが、特定の場合には動きます。

これ動くんですね〜!

bitclust htmlfile refm/api/src/_builtin/Array > /tmp/tmp.html 
bitclust htmlfile --force refm/api/src/_builtin/Array > /tmp/tmp.html

何のオプションなのかよくわからず試してましたが、
自分が試したのは--forceつけると逆にエラーになるので動かないオプションなのかと思ってしまいました、

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants