pkglint

- Image Packaging System パッケージ lint

形式

/usr/bin/pkglint [-c dir] [-r uri] [-p regexp]
    [-f rcfile] [-b build_no] [-v]
    [-l uri] | manifest ...

/usr/bin/pkglint -L [-v]

機能説明

pkglint は、必要に応じて別のリポジトリを参照しながら、1 つ以上のパッケージマニフェストに対して一連のチェックを実行します。

pkglint は、パッケージ公開前の、パッケージ作成処理中に使用するべきです。pkglint は、マニフェストに対して、pkgsend(1) または pkg.depotd(1M) の通常動作中に実行するには負荷が大きすぎる可能性のある徹底的なテストを実行します。pkglint のチェックには、重複したアクション、欠落した属性、および異常なファイルアクセス権に対するテストが含まれます。

lint のためのマニフェストは、コマンド行で、スペースで区切られたローカルファイルのリストとして渡すことができます。または、リポジトリからマニフェストを取得できます。

リポジトリからマニフェストを取得する場合、pkglint は最初の実行で、指定されたキャッシュディレクトリ内に pkg(5) ユーザーイメージを作成して設定します。-r オプションが指定されている場合は、参照リポジトリのために cache_dir/ref_image という名前のユーザーイメージが作成されます。-l オプションが指定されている場合は、lint リポジトリのために cache_dir/lint_image という名前のユーザーイメージが作成されます。これらのイメージに内容はインストールされません。これらのイメージは、リポジトリからマニフェストを取得するために pkglint でのみ使用されます。

pkglint の以降の呼び出しではキャッシュディレクトリを再利用できるため、-r または -l 引数はすべて省略できます。

pkglint では、キャッシュディレクトリ内のパブリッシャーを構成するためのサポートが制限されています。これらのイメージに対して、より複雑なパブリッシャーの構成を実行するには、pkg(1) を使用します。

pkglint では、パッケージ作成者は、特定のマニフェストまたはアクションに対するチェックをバイパスできます。True に設定された属性 pkg.linted を含むマニフェストまたはアクションでは、そのマニフェストまたはアクションに対する lint 出力は生成されません。

pkglint チェックの名前の部分文字列を使用して、よりきめ細かな pkg.linted 設定を行うことができます。たとえば、pkg.linted. check.id が True に設定されていると、特定のマニフェストまたはアクションに対する check.id という名前を持つすべてのチェックがバイパスされます。

pkglint の動作は、pkglintrc ファイルを指定することによって構成できます。デフォルトでは、pkglint は、/usr/share/lib/pkg/pkglintrc および $HOME/.pkglintrc 内の構成オプションを検索します。別の構成ファイルを指定するには、-f オプションを使用します。

lint の実行中に検出されたエラーまたは警告はすべて stderr に出力されます。

オプション

サポートしているオプションは、次のとおりです。

-b build_no

lint および参照リポジトリからの lint 中に使用されるパッケージのリストを絞り込むために使用されるビルド番号を指定します。-b オプションが指定されていない場合は、最新バージョンのパッケージが使用されます。version.pattern 構成プロパティーも参照してください。

-c cache_dir

lint および参照リポジトリからのパッケージのメタデータをキャッシュするために使用されるローカルディレクトリを指定します。

-l lint_uri

lint リポジトリの場所を表す URI を指定します。HTTP ベースとファイルシステムベースの両方の公開がサポートされています。-l を指定する場合は、-c も指定する必要があります。

-L

既知の lint チェックと除外された lint チェックを一覧表示してから終了します。各チェックの短縮名と説明を表示します。-v フラグと組み合わせる場合は、説明の代わりに、このチェックを実装するメソッドを表示します。

-f config_file

config_file 構成ファイルを使用して pkglint セッションを構成します。

-p regexp

lint リポジトリからチェックされるパッケージのリストを絞り込むために使用される正規表現を指定します。参照リポジトリからはすべてのマニフェストがロードされ (-b が指定されている場合は、その値に一致すると仮定)、このパターンは無視されます。

-r repo_uri

参照リポジトリの場所を表す URI を指定します。-r を指定する場合は、-c も指定する必要があります。

-v

pkglint を冗長モードで実行し、構成ファイル内の log_level 設定をすべて上書きします。

--help or -?

使用方法に関するメッセージを表示します。

ファイル

pkglintrc 構成ファイルは、次のキーと値の引数を取ります。

log_level

lint メッセージを発行する最小のレベル。このレベルより低い lint メッセージは破棄されます。デフォルト値は INFO です。

ログレベルを最小のレベルからもっとも重大なレベルの順に示すと、DEBUG、INFO、WARNING、ERROR、CRITICAL になります。

do_pub_checks

True の場合は、公開されたパッケージにとってのみ意味がある可能性のあるチェックを実行します。デフォルト値は True です。

pkglint.ext.*

pkglint のプラグインメカニズムを使用すると、実行時に lint モジュールを追加できます。pkglint.ext. で始まるキーはすべて、完全に指定された Python モジュールである必要のある値を取ります。詳細は、「開発者」のセクションを参照してください。

pkglint.exclude

実行されるチェックのセットから省略する、完全に指定された Python モジュール、クラス、または関数名のスペースで区切られたリスト。

use_progress_tracker

True の場合は、lint の実行中にマニフェストに対する処理を繰り返すときに進捗トラッカーを使用します。デフォルト値は True です。

version.pattern

lint の対象となるビルド番号を指定するときに使用されるバージョンのパターン (-b)。構成ファイルで指定されていない場合、-b オプションはパターン *,5.11-0. を使用します。これは、ブランチ接頭辞が 0 である 5.11 ビルドのすべてのコンポーネントに一致します。

開発者

pkglint によって実行されるチェックのセットを拡張するには、pkg.lint.base.Checker とそのサブクラス ManifestChecker 、ActionChecker、および ContentChecker をサブクラス化します。これらのクラスを含む Python モジュール名を、構成ファイル内の新しい pkglint.ext. キーに追加します。

これらの新しいサブクラスのインスタンスは、起動時に pkglint によって作成されます。lint セッション中に、特殊なキーワード引数 pkglint_id を持つ、各サブクラスの内部のメソッドが呼び出されます。これらのメソッドには、スーパークラス内の対応する check() メソッドと同じ署名が含まれているべきです。また、これらのメソッドには、pkglint -L によって出力される説明として使用される pkglint_desc 属性も割り当てられていなくてはいけません。

パラメータは Checker サブクラスから使用できます。これにより、これらのサブクラスは自身の動作を調整できます。推奨されるパラメータの命名規則は、pkglint_id.name です。パラメータ値は構成ファイル内に格納するか、または LintEngine.get_param() メソッドを使用して取得されるマニフェストまたはアクションでアクセスすることができます。マニフェストからパラメータにアクセスする場合は、pkglint パラメータが既存のどのアクションまたはマニフェスト値とも重複しないようにするために、キー名に接頭辞 pkg.lint が付加されます。

使用例

例 1 特定のリポジトリに対する最初の実行

特定のリポジトリに対する pkglint セッションのはじめての実行。

$ pkglint -c /space/cache -r http://localhost:10000 mymanifest.mf

例 2 同じリポジトリに対するそれ以降の実行

例 1 で使用されている同じリポジトリに対するそれ以降の実行。

$ pkglint -c /space/cache mymanifest-fixed.mf

例 3 絞り込まれたマニフェストセットでの lint リポジトリの使用

lint リポジトリでの pkglint セッションの実行と、チェックするマニフェストのサブセットの指定。

$ pkglint -c /space/othercache -l http://localhost:10000 \
-p '.*firefox.*'

例 4 ビルドの指定

冗長モードでの特定のビルドに対する pkglint セッションの実行。

$ pkglint -c /space/cache -r http://localhost:10000 \
-l http://localhost:12000 -b 147 -v

例 5 構成ファイルの変更

新しい lint モジュールを含む構成ファイル (一部のチェックを除外)。

$ cat ~/.pkglintrc
[pkglint]

log_level = DEBUG
# log_level = INFO

pkglint.ext.mycheck = org.timf.mychecks
pkglint.ext.opensolaris = pkg.lint.opensolaris
pkglint.exclude: pkg.lint.opensolaris.OpenSolarisActionChecker
pkg.lint.pkglint.PkgActionChecker.unusual_perms pkg.lint.pkglint.PkgManifestChecker
pkg.lint.opensolaris.OpenSolarisManifestChecker

終了ステータス

次の終了ステータスが返されます。

0

コマンドが成功しました。

1

1 つ以上の lint チェックが出力を発行しました。

2

無効なコマンド行オプションが指定された。

99

予期しない例外が発生しました。

属性

次の属性については、attributes(5) を参照してください。

関連項目

pkg(1)、pkg.depotd(1m)、pkgsend(1)、pkg(5)

http://hub.opensolaris.org/bin/view/Project+pkg/