rabbit-slide-kenhys-tokyodebian-lintian-howto-202112 2021.12.18.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6e70a124f9d3c59429c75c86c9cc55c9ce72ecf1f5e96e57250ef01d6088e77
+  data.tar.gz: b26d1f1dfdab88609ba19b1174e8575ce8f2c3ca5fd3faef96a49ae2bba0b64f
+SHA512:
+  metadata.gz: 73c4de2aa73824e19c2d58542a07c8a839bb753a75242fa67c70e48d92cced068b422f5de6bee42a2f0dc9d55a3bbb2230b95ecd5bc3b9196e42b8158a89968b
+  data.tar.gz: 0cd5fd2ce0ec781ad390f07dce4919cc5a49851d1dc0e9d6db69af0e9bef74dc0593a6e8a5eb0db58d41231d2f4287f11599c48e65e785e7fecc49bd0cba3d29

data/.rabbit

@@ -0,0 +1 @@
+--size=1024,768 tokyodebian-lintian-howto.md

data/README.md

@@ -0,0 +1,14 @@
+# Tokyo Debian Lintian Howto 202112
+
+## How to show
+
+  % rabbit
+
+## How to install
+
+  % gem install rabbit-slide-kenhys-tokyodebian-lintian-howto-202112
+
+## How to create PDF
+
+  % rake pdf
+

data/Rakefile

@@ -0,0 +1,17 @@
+require "rabbit/task/slide"
+
+# Edit ./config.yaml to customize meta data
+
+spec = nil
+Rabbit::Task::Slide.new do |task|
+  spec = task.spec
+  # spec.files += Dir.glob("doc/**/*.*")
+  # spec.files -= Dir.glob("private/**/*.*")
+  # spec.add_runtime_dependency("rabbit-theme-YOUR-THEME")
+end
+
+desc "Tag #{spec.version}"
+task :tag do
+  sh("git", "tag", "-a", spec.version.to_s, "-m", "Publish #{spec.version}")
+  sh("git", "push", "--tags")
+end

data/config.yaml

@@ -0,0 +1,25 @@
+---
+id: tokyodebian-lintian-howto-202112
+base_name: tokyodebian-lintian-howto
+tags:
+- rabbit
+- debian
+- lintian
+presentation_date: 2021-12-18
+presentation_start_time:
+presentation_end_time:
+slideshare_id:
+version: 2021.12.18.1
+licenses:
+- CC-BY-SA-4.0
+slideshare_id: kenhys
+speaker_deck_id:
+vimeo_id:
+youtube_id:
+author:
+  markup_language: :md
+  name: Kentaro Hayashi
+  email: kenhys@gmail.com
+  rubygems_user: kenhys
+  slideshare_user:
+  speaker_deck_user:

data/theme.rb

@@ -0,0 +1,5 @@
+@default_font = "Ubuntu"
+@monospace_font = "Ubuntu"
+include_theme("debian")
+#@slide_show_span = 1300
+@slide_show_loop = true

data/tokyodebian-lintian-howto.md

@@ -0,0 +1,265 @@
+# lintianに\\n新規ルールを\\n追加する方法
+
+subtitle
+:  2.11X.0対応版
+
+author
+:  Kentaro Hayashi
+
+institution
+:  ClearCode Inc.
+
+content-source
+:  2021年12月 東京エリア・関西合同Debian勉強会
+
+allotted-time
+:  20m
+
+theme
+:  .
+
+# スライドはRabbit Slide Showにて公開済みです
+
+* lintianに新規ルールを追加する方法
+  * <https://slide.rabbit-shocker.org/authors/kenhys/tokyodebian-lintian-howto-202112/>
+
+# 本日の内容
+
+* lintianについて
+* lintianのしくみ
+* ルールの追加方法解説
+* 実際に追加しながら学ぶ
+
+# lintianについて
+
+* /lɪntən/ <https://wiki.debian.org/Lintian>
+  * Debianパッケージをチェックするツール
+    * Debianポリシー違反を検出
+    * よくあるミスを検出 (+dfsgを+dsfgとtypoしているとか)
+    * よいパッケージングのやりかたを示す
+
+# lintianについて
+
+* salsaでメンテナンスされている
+  * <https://salsa.debian.org/lintian/lintian>
+* Perlによる実装
+* 実行例: lintian -EvIL +pedantic path/to/pkg_version_arch.changes
+
+# lintianのしくみ
+
+* パッケージをパース
+* 各種検出ルールを適用する
+* 問題のある箇所をtagとして検出
+* 結果をまとめて出力する
+
+# lintianの参考資料
+
+* <https://wiki.debian.org/Teams/Lintian/HackersGuide>
+  * これは古くてあまり参考にならない
+* <https://salsa.debian.org/lintian/lintian/-/blob/master/CONTRIBUTING.md>
+* <https://salsa.debian.org/lintian/lintian/-/blob/master/doc/README.developers>
+  * perldoc README.developersすべし
+
+# 注意事項
+
+* lintian 2.11X.0をベースに説明します
+  * 結構アクティブに開発され、変更が入るため
+
+# lintianのディレクトリ構成
+
+* 大事なのは以下の3つ
+  * lib/ 検出するルールを実装
+  * t/ テストを追加する
+  * tags/ タグを定義する
+
+# lintianのルール開発
+
+* 検出するためのコードを書く
+  * lib/Lintian/Check/*
+* テストを追加する
+  * t/recipes/checks/*
+* tagを追加する
+  * tags/x/xxx.tag
+
+# lintianで検出したいルール
+
+* 判断に迷いがちなやつは機械的に検出したい
+  * 例: +dfsgか~dfsgどっちを使うか問題
+  * 例: +dfsgのrepack countどうあるべきか問題
+
+# +dfsgか~dfsgどっちを使うか問題
+
+* +dfsgが主流 (出典: UDDのsidのsource package調べ)
+  * +dfsg: 1974パッケージ
+  * ~dfsg: 109パッケージ
+    * 例: ghostscript 9.55.0~dfsg-3
+
+# あえて~dfsgを使う理由
+
+* upstreamが同一バージョンでリリースしなおした場合に便利
+  * upstream: ライセンス問題あるやつを公開(1.0)した🔥
+  * debian: 1.0~dfsg-1としてパッケージングした
+  * upstream: 同じバージョンで再リリースした
+  * debian: 1.0-1 > 1.0~dfsg-1 なので、1.0-1として再度パッケージングすればよい
+    * +dfsg使うと1.0+dfsg-1 > 1.0-1なのでアップグレードできない
+
+# 結論: +dfsgか~dfsgどっちを使うか問題
+
+* +dfsgで実用上は十分
+* +dfsgに移行を促していくのがよいのでは
+  * debian-policyではなさそう
+  * developers-referenceにあるとよい?
+    * <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=499167>
+  * lintianがinfoレベルとしてチェックしてくれると気づきやすい
+
+# +dfsgのrepack countどうあるべきか問題
+
+* repack countもバラバラ(出典: UDDのsid source package調べ)
+
+
+|repack countの付け方|パッケージ数| 
+|--|---:|
+|+dfsg-1|~1400|
+|+dfsgN-1|~400|
+|+dfsg.N-1|~60|
+
+* mentors.debian.netはなぜか+dfsg.N-1をオススメしている🤔
+
+# 結論: repack countはどう付与するのがよいか?
+
+* 初回は+dfsg-1スタイル
+  * 理由: ほぼ複数回repackすることはない
+* 再度repackしないといけなくなったら、+dfsgN-1
+  * 例: 1.0+dfsg2-1
+  * 1.0+dfsg2-1 > 1.0+dfsg-1なので更新も問題ない
+* lintianがinfoレベルとしてチェックしてくれると気づきやすい
+
+# 実践編
+
+* ~dfsgをlintianでチェックできるようにする
+  * 検出するためのコードを書く
+    * lib/Lintian/Check/*
+  * テストを追加する
+    * t/recipes/checks/*
+  * tagを追加する
+    * tags/x/xxx.tag
+
+# ~dfsgをチェックする
+
+* lib/Lintian/Check/Fields/Version.pm
+
+```
+--- a/lib/Lintian/Check/Fields/Version.pm                                                                                                   
++++ b/lib/Lintian/Check/Fields/Version.pm                                                                                                   
+...
+     } elsif ($version =~ /\.dfsg/) {
+         $self->hint('dfsg-version-with-period', $version);
++                                                                                                                                           
++    } elsif ($version =~ /~dfsg/) {                                                                                                        
++        $self->hint('dfsg-version-with-tilde', $version);                                                                                  
++                                                                                                                                           
+     } elsif ($version =~ /dsfg/) {
+         $self->hint('dfsg-version-misspelled', $version);
+     }
+...
+```
+
+
+# ~dfsgのテストを追加する
+
+* 主に以下の3つを追加する
+  * t/recipes/checks/fields/version/**tilde-dfsg/build-spec/fill-values**
+  * t/recipes/checks/fields/version/**tilde-dfsg/eval/desc**
+  * t/recipes/checks/fields/version/**tilde-dfsg/eval/hints**
+
+# ~dfsgのテストを追加する
+
+* t/.../tilde-dfsg/build-spec/fill-values
+  * パラメータ指定でテスト用パッケージをカスタマイズする
+* t/.../tilde-dfsg/eval/desc
+  * テストがどのグループに属するかを指定する
+* t/.../tilde-dfsg/eval/hints
+  * lintianでチェックしたときのメッセージ(自動生成する)
+
+# t/.../tilde-dfsg/build-spec/fill-valuesの例
+
+```
+Testname: tilde-dfsg
+Skeleton: upload-non-native
+Version: 1.0~dfsg-1
+Description: Check for dfsg with tilde (~) prefix
+See-Also:
+ https://lists.debian.org/debian-devel/2021/10/msg00012.html
+```
+
+* Skeleton: で指定したパッケージの雛形を上書きする
+
+# t/.../tilde-dfsg/eval/descの例
+
+```
+Testname: tilde-dfsg
+Check: fields/version
+```
+
+* Testname: はevalの親ディレクトリ(fill-valuesと同じ)
+* Check:はこのテストが所属するグループを指定する
+
+# t/.../tilde-dfsg/eval/hintsの例
+
+
+```
+tilde-dfsg (source): dfsg-version-with-tilde 1.0~dfsg-1
+```
+
+* テスト実行時に自動生成する
+
+# tags/d/dfsg-version-with-tilde.tagの例
+                                                                                    
+```
+Tag: dfsg-version-with-tilde
+Severity: info
+Check: fields/version
+Explanation: The source version string contains a tilde like <code>~dfsg</code>.
+ It is probably in a form like <code>1.0~dfsg-1</code>.
+ ...
+See-Also:
+ https://lists.debian.org/debian-devel/2021/10/msg00012.html
+```
+
+* タグ名、重要度など詳細を記述する
+
+# ~dfsgのhintを生成する
+
+* ./private/runtests --onlyrun=check:fields/version
+
+```
+Building the test packages took 1 second.
+
+# Hints do not match
+# 
+# --- debian/test-out/eval/checks/fields/version/tilde-dfsg/hints.specified.calibrated
+# +++ debian/test-out/eval/checks/fields/version/tilde-dfsg/hints.actual.parsed
+# -
+# +tilde-dfsg (source): dfsg-version-with-tilde 1.0~dfsg-1
+# 
+```
+
+# テストがパスすることを確認する
+
+* 開発時は`--onlyrun`で実行するテストのグループをしぼるのがよい
+
+```
+$ ./private/runtests --onlyrun=check:fields/version
+...
+All tests successful.
+Files=4, Tests=4,  2 wallclock secs ( 0.41 usr  0.12 sys +  4.25 cusr  1.02 csys =  5.80 CPU)
+Result: PASS
+```
+
+# さいごに
+
+* lintian 2.113.0のリリースに取り込まれました
+  * <https://salsa.debian.org/lintian/lintian/-/merge_requests/379> ~dfsgのチェック
+  * <https://salsa.debian.org/lintian/lintian/-/merge_requests/381> +dfsg.N-1のチェック
+  * <https://salsa.debian.org/lintian/lintian/-/merge_requests/380> +dfsg1-1のチェック
+* けっこうあっさりマージしてもらえるのでフィードバックおすすめ

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: rabbit-slide-kenhys-tokyodebian-lintian-howto-202112
+version: !ruby/object:Gem::Version
+  version: 2021.12.18.1
+platform: ruby
+authors:
+- Kentaro Hayashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rabbit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: ''
+email:
+- kenhys@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rabbit"
+- README.md
+- Rakefile
+- config.yaml
+- pdf/tokyodebian-lintian-howto-202112-tokyodebian-lintian-howto.pdf
+- theme.rb
+- tokyodebian-lintian-howto.md
+homepage: https://slide.rabbit-shocker.org/authors/kenhys/tokyodebian-lintian-howto-202112/
+licenses:
+- CC-BY-SA-4.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Tokyo Debian Lintian Howto 202112
+test_files: []