Zig向けにパッケージ化されたC/C++プロジェクト
C/C++ projects packaged for Zig (github.com)
要約
All Your Codebaseは、C/C++プロジェクトをZigのビルドシステム向けにパッケージ化する組織です。これにより、Zigコンパイラツールチェーンのユーザーは、プロジェクトを容易に(クロスコンパイルも含めて)確実にコンパイルできるようになります。また、C/C++プロジェクトのメンテナーに対して、ビルドファイル(build.zig)の例を示すことも目的としています。
全文翻訳
All Your Codebase
...are belong to usですが、喜んでお返しします!
この組織は何ですか?
私たちはC/C++プロジェクトをZigビルドシステム向けにパッケージ化し、それらを簡単に(クロスコンパイルも!)確実にコンパイルできるようにします。
これはZigコンパイラツールチェインのユーザーに利便性を提供するだけでなく、C/C++プロジェクトのメンテナーに、プロジェクトのbuild.zigファイルがどのようなものかを示すことにもなります。
私がパッケージ化したプロジェクトのメンテナーですが、あなたの仕事にはどのような価値がありますか?
一般的な回答としては、プロジェクトにZigへの依存関係を追加しますが、その代わりに以下の依存関係を削除します。
- Make / GNUMake / CMake / autoconf / bashスクリプト / バッチスクリプト / powershellスクリプト: Zigは、サポートされているすべてのプラットフォームで動作する完全なビルドシステムであり、これら他のツールのすべてを実行できます。
- Clang: Zigは完全なコンパイラツールチェインであり、
clangのすべてをバンドルしています。 - システムパッケージマネージャー: Zigはパッケージマネージャーでもあり、必要であれば、それにパッケージ化された依存関係をダウンロードしてビルドできます。
- Docker / CIマトリックスジョブ: ZigはC/C++/Zigコードをクロスコンパイルできるため、リリースは
zig build releaseを実行するのと同じくらい簡単です。
より一般的には、Zigはシステム全体の設定への依存をすべて排除しますが、必要に応じてオプトインする能力は残します。
私がパッケージ化したプロジェクトのメンテナーで、あなたの仕事が好きです。どのようにアップストリームできますか?
あなたが私たちによってパッケージ化されたプロジェクトのメンテナーであり、ビルドパイプラインをアップグレードしたいと決めた場合、私たちのリポジトリから必要なすべてのものをアップストリームする自由があります。
そうすることにした場合は、Issueを開いてお知らせください。そうすれば、私たちのリポジトリをアーカイブし、人々をあなたのアップストリームに誘導できます。また、私たちのリポジトリのIssueセクションを自由に利用して、プロジェクトにすべてを正しく統合する方法について質問してください(例えば、二次ビルドステップを実装しなかった場合など)。
最後に注意点があります。リポジトリをアーカイブできるようにするには、build.zigの統合が私たちのバージョンよりも多くのシステム依存関係を追加しない必要があります。例えば、私たちのパッケージ化されたバージョンがallyourcodebase/zstd経由でzstdに依存できる場合、それを維持し続けるか(そのbuild.zigがアップストリームされるまで)、またはSystem Library Integrationを利用してユーザーに選択肢を与えることをお願いします。
とはいえ、Zigビルドシステム経由で他のパッケージに依存し続ける予定がなくても、自由にビルドコードをアップストリームしていただいて構いません。この場合も喜んでお手伝いしますが、私たちのダウンストリームフォークは維持し続けます。
あなたがZigビルドシステム向けにパッケージ化したC/C++プロジェクトはどのようなものですか?
私たちは主に2つの戦略を使用します。
- アップストリームプロジェクトを依存関係として追加し(
build.zig.zon内)、対応するbuild.zigスクリプトを私たちのリポジトリで定義します。 - アップストリームプロジェクトをフォークし(オプションで、もはや不要になった他のビルドスクリプトを削除)、それにZigビルドスクリプトを追加し、元のプロジェクトに必要なパッチを適用します。この最後の部分は通常は必要ありませんが、一部のビルドステップは、設定スクリプトなどをZigビルドシステムで使いやすくするために変更すると有益な場合があります。例えば、出力パスをハードコーディングするのではなく、引数として受け取るようにすることで、Zigのビルドキャッシュと適切に統合できるようになります。
あなたがアップストリームプロジェクトのメンテナーである場合、(1)はあなたが2つのファイル(build.zig、build.zig.zon)のみを必要とすることを示していますが、他のすべてのビルドスクリプトをクリーンアップし、上記のZigビルドスクリプトを改善するのはあなたの責任となります。(2)は、アップストリームする際に少し注意が必要ですが、すべてがより徹底的に行われています(ただし、Zigビルドスクリプトファイルのみを取得し、アップストリームプロジェクトへの統合方法を手動でレビューするオプションもあります)。
私はZigユーザーで、リポジトリに貢献したいのですが、どうすればよいですか?
kristoffに連絡して、組織に追加してもらうよう依頼してください。
リポジトリに貢献するための基本的なルールをいくつか示します。
- あなたのコード(新しい
build.zigファイル)にはライセンスが必要です。そして、それは元のプロジェクトのライセンスと同等以上に寛容である必要があります(簡単にするためにMITを使用すれば間違いありません)。 - あなたのリポジトリは、追加のZig固有の機能(例えばバインディング)を追加せずに、元のC/C++プロジェクトをパッケージ化する必要があります。
バインディングは、あなた自身が所有する別のリポジトリに含めることができます。 - 最新のタグ付きZigバージョンをターゲットにする必要があります。
- 元のプロジェクトをポートする際は、最初の戦略(
build.zig+ クリーンなtarball)を使用し、以下の場合にのみ2番目の戦略(プロジェクト全体のフォーク)に切り替えるべきです。- 元のソースコードを正しくビルドするためにパッチを適用する必要がある場合
- すべての他のビルドスクリプトをクリーンアップし、ビルドプロセスの途中段階の動作を改善する場合
- 最後の点の例としては、出力パスをハードコーディングする(通常はカレントディレクトリ)プロジェクト固有のビルドツール(例: アセット処理ツール、画像オプティマイザー)を変更して、代わりに引数として出力パスを受け取るようにし、Zigのビルド(エコ)システムの良い市民にすることです。
zig buildが成功することを保証するCIジョブを追加する必要があります。例えば、allyourcodebase/AFLplusplusからスクリプトをコピーできます。- アップストリームプロジェクトの新しいバージョンがリリースされたときに、ビルドスクリプトを更新するための、時折のメンテナンス作業に興味を持っている必要があります。
上記のチェックリストが完了したら、リポジトリに発見しやすいように適切なタグ(例: zig、zig-package)を付けてください。