Appendix D. the pkgsrc guide 編集の指針

Table of Contents

D.1. make ターゲット
D.2. 編集手順

本節では、この the pkgsrc guide そのものの編集に関する情報を掲載します。

D.1. make ターゲット

the pkgsrc guide のソースコードは pkgsrc/doc/guide/files 以下に置かれており、 これをもとに、以下のような数々のファイルが生成されます。

D.2. 編集手順

the pkgsrc guide の編集手順は、以下のとおりです。

  1. the pkgsrc guide (と、XML にもとづくその他の NetBSD ドキュメンテーション) の再生成に必要なパッケージがインストールされていることを確認します。 ASCII および HTML 版の生成に必要なのは meta-pkgs/netbsd-doc、 PostScript および PDF 版の生成に必要なのは meta-pkgs/netbsd-doc-print です。 各形式のドキュメンテーションの一貫性を保つために、 いずれのパッケージもインストールする必要があります。

  2. cd doc/guide を実行して、 適切なディレクトリーに移動します。これ以降の手順は、 すべてこの場所でおこないます。

  3. files/ 以下にある XML ファイルを編集します。

  4. bmake を実行して、the pkgsrc guide が妥当な XML であることを確認し、最終的な出力ファイルを構築します。 何かエラーが出た場合は、元のファイルを編集するだけで結構です。 作業ディレクトリーには、files/ 以下のファイルを指すシンボリックリンクがあるだけだからです。

  5. (cd files && cvs commit)

  6. bmake clean && bmake を実行して、適切な RCS Id を含んだ出力ファイルを作り直します。

  7. bmake regen を実行して、 pkgsrc/doc および htdocs 以下にそれぞれファイルをインストールして commit します。

    Note

    章の追加、削除、または改名をした場合は、 htdocs ディレクトリー以下で cvs addcvs delete を使って、 元のファイルとの対応を揃える必要があります。