-
Notifications
You must be signed in to change notification settings - Fork 120
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
C API版のライブラリとヘッダファイル名をcore -> voicevox_coreに変更 #256
C API版のライブラリとヘッダファイル名をcore -> voicevox_coreに変更 #256
Conversation
ファイル名変更、良いと思います!! |
… feature/rename-library-name
review可能になりました |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
以下の行の libcore.dylib
も libvoicevox_core.dylib
への変更をお願いしたいです……!
println!("cargo:rustc-link-arg=-Wl,-install_name,@rpath/libcore.dylib"); |
@PickledChair 忘れてました。修正しました。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! 大丈夫だと思うのでマージします
@Hiroshiba @PickledChair engine側でfile名が変わったことによる対応が必要になると思います。 |
ご指摘ありがとうございます。rename するかどうかは少し迷いますね……。 エンジン側では新しいコアの名前に対応すること自体はそれほど大変ではないと感じました(例えばまず voicevox_core.{dll,so,dylib} を探し、あればそれを読む。なければ core.{dll,so,dylib} を読む、という仕様にしてしまうなど)。なので rename するかどうかは互換性を(コアの名前まで含めて)気にするかどうかのみに依ると思います。 rename する場合は、そのタイミングをコアの配布前にするか、エンジンのビルド時にするか、といった選択肢があると思いました。 |
engineで古いバージョンのものを読み込む場合名前が coreであるためそのあたり問題になりそうかなと思ったんですが、大丈夫そうならそのままでも問題ないと思います。 |
内容
rust 版を作成する際にライブラリファイルとヘッダファイルの名称を既存のものと合わせて作っていたが、それから事情も変わって今なら変えれそうなタイミングかなと判断したのでやってみました
変えれそうかなと判断したのは
engineが既存のC APIのものからpython API版を使う流れになりそうになったので、C API版のファイル名称を変更しても影響は少なそうだと判断したためです
Pros
voicevox
を prefixにいれることによりvoicevox関連のファイルであることを表明できるcore
のみだと一般的な名称であるためユーザー側に同名ファイルがあって取り違える可能性もゼロではないのでprefixをつけることによりそれを避けることができるCons
core
ライブラリユーザーが参照するファイル名を変更する手間が発生する(既存ユーザーは恐らく少ない上、次のリリースでどのみち大幅な変更がはいるのでやるなら今な気がします。むしろここでやらないとcore名称に依存したライブラリ参照したユーザーが増え続けてcoreから名称を変えることができない自体にずるずると陥っていきそうです)