reportbug - เมื่อคุณเจอบั๊ก

เช่นเดียวกับโครงการซอฟต์แวร์เสรีทั่วไป คุณสามารถรายงานบั๊กที่พบขณะใช้เดเบียน เพื่อช่วยให้นักพัฒนาสามารถปรับปรุงแก้ไขข้อบกพร่องได้

ระบบติดตามบั๊กของเดเบียน จะทำงานผ่านเมลเป็นหลัก โดยมี web archive ให้ติดตามแต่ละบั๊กได้ ทุกสิ่งทุกอย่างที่คุณจะสั่งการบั๊ก ไม่ว่าจะเป็นการรายงาน การแสดงความเห็นเพิ่มเติม การติดแท็กหรือเปลี่ยนสถานะของบั๊ก จะสั่งการผ่านอีเมลทั้งหมด แต่ในขั้นตอนที่สำคัญและผู้ใช้อย่างคุณจะเกี่ยวข้องมากที่สุด คือการรายงานบั๊กนั้น มีเครื่องมือช่วยเหลือ ชื่อว่า reportbug

ถ้าระบบของคุณยังไม่มีแพกเกจนี้ ก็ติดตั้งก่อน

# apt-get install reportbug

สมมุติว่าคุณเซ็ตระบบเมลในเครื่องของคุณเรียบร้อยแล้ว เวลาจะรายงานบั๊กสำหรับแพกเกจ p (เปลี่ยนชื่อเอานะครับ) ก็เพียงสั่ง:

$ reportbug p

reportbug จะตรวจสอบรุ่นที่คุณติดตั้งก่อน ถ้าไม่ใช่รุ่นใหม่ล่าสุด ก็จะถามว่าจะลองปรับรุ่นก่อนหรือเปล่า เพื่อป้องกันการรายงานบั๊กเก่าที่อาจแก้ไขไปแล้ว คุณสามารถยกเลิกแล้วมาปรับรุ่นก่อนได้

จากนั้น reportbug ก็จะแสดงรายการบั๊กต่าง ๆ ของแพกเกจที่คุณรายงาน โดยคุณสามารถเลือกดูเนื้อหาของบั๊กต่าง ๆ ได้ โดยตอบเป็นหมายเลขตัวเลือก (ไม่ใช่หมายเลขบั๊ก) เช่น:

Bugs fixed in subsequent releases (7 bugs)
   1) #133348 [FIXED libx11 2:1.1.3-1]: xlibs-dev: XGetCommand man page lies
   2) #392618 [FIXED libx11 2:1.1.2-1]: Unneeded define in debian/rules.
   3) #400443 [FIXED 2]: libx11-6: multiple wrong calls to LockDisplay and Unlo
   4) #427296 [FIXED libx11 2:1.1.3-1]: xterm: xcb_xlib.c:50: xcb_xlib_unlock: 
   5) #225839 [FIXED libx11 2:1.1.2-1]: libx11-dev: XQueryBestCursor(3x) should
   6) #393434 [FIXED libx11 2:1.1.3-1]: libx11-dev: error in manual page for Xr
   7) #399094 [FIXED libx11 2:1.1.2-1]: mismatch between docs and header (struc

Outstanding bugs -- Important bugs; Unclassified (1 bug)
   8) #366355: libx11: ssh -X between Sarges XF86 and Sids Xorg7 broken

Outstanding bugs -- Normal bugs; Unclassified (2 bugs)
   9) #349251: CVE-2006-0197: XClientMessageEvent struct issue on 64 bit
  10) #364014: libx11-6: UTF-8 incorrectly displayed in ion window title

Outstanding bugs -- Normal bugs; More information needed (1 bug)
  11) #425445: libx11-6: fails to cross-build. tries to run cross-built makekey

Outstanding bugs -- Normal bugs; Will Not Fix (3 bugs)
  12) #216933: libx11-6: many clients get BadLength error from X_ChangeProperty
  13) #234556: libx11-6: apps crash with 'BadLength (poly request too large or 
  14) #261251: libx11-6: apps crash with 'BadLength (poly request too large or 
(1-14/36) Is the bug you found listed above [y|N|m|r|q|s|f|?]? 1

ในตัวอย่างข้างบน ผมตอบ 1 เพื่อดูรายละเอียดบั๊ก #133348 เป็นต้น

ถ้าดูหัวข้อบั๊กแล้ว ไม่มีตัวไหนเกี่ยวข้อง ก็ตอบ n หรือกด enter (เพราะ n คือคำตอบปริยาย) เพื่อดูชุดถัดไปไปเรื่อย ๆ ถ้าพบบั๊กที่ใช่ (คือมีคนรายงานไปแล้ว ไม่ควรรายงานซ้ำ) และตอบ y ก็จะมีคำถามถามหมายเลขบั๊กที่จะแสดงความเห็นเพิ่มเติม หรือถ้าจะไม่เพิ่มเติมอะไรก็กด enter เพื่อออก

แต่ถ้าคุณแน่ใจจริง ๆ ว่าไม่มีใครรายงานบั๊กนี้แล้ว หรือจะข้ามช่วงของบั๊กที่แก้ไปแล้ว ก็ตอบ s (skip) เพื่อข้ามไปเริ่มป้อนข้อมูลบั๊กทันทีได้ หรือถ้าจะเปลี่ยนใจไม่รายงานบั๊กแล้ว ก็ตอบ q (quit)

โอย จำไม่ไหว ตัวเลือกเยอะจัง กด '?' เพื่อขอดู help ได้ครับ รวมถึงคำตอบขณะดูเนื้อหาบั๊กแต่ละบั๊กด้วย คงไม่ต้องอธิบายคำตอบต่าง ๆ ในที่นี้แล้วนะครับ

ข้ามไปที่ขั้นรายงานบั๊ก จะมี prompt ให้กรอก subject ของบั๊ก พยายามใช้ข้อความที่กระชับแต่ได้ใจความ คือให้คนที่เจอบั๊กเดียวกับคุณเขามาอ่านทีหลังแล้วรู้ทันที ว่าใช่บั๊กเดียวกันหรือเปล่า

จากนั้นก็จะเป็นคำถามเกี่ยวกับความร้ายแรงของบั๊ก ขอให้อ่านรายละเอียดของแต่ละระดับให้แน่ใจนะครับ

• critical (วิกฤติ) คือระดับความร้ายแรงสูงสุด บั๊กน้อยตัวนักที่จะอยู่ในขั้นนี้ มักเป็นบั๊กที่ทำให้ระบบพิการทั้งหมด หรือทำให้แพกเกจอื่นเสียหายไปด้วย หรือสร้างรูโหว่ด้านระบบรักษาความปลอดภัยสำหรับทั้งระบบ
• grave (สาหัส) เป็นบั๊กที่ทำให้แพกเกจที่รายงานนี้ใช้การไม่ได้สำหรับผู้ใช้ส่วนใหญ่ หรือสร้างรูโหว่ด้านระบบรักษาความปลอดภัยของตัวแพกเกจเอง
• serious (ร้ายแรง) ใช้กับการละเมิด Debian Policy ในข้อที่ใช้คำว่า 'must' หรือ 'required' แต่ถ้าเป็นการละเมิดกรณีอื่น ก็ไม่ใช่ความร้ายแรงขั้นนี้
• important (สำคัญ) เป็นบั๊กที่ไม่ได้มีผลกับส่วนใหญ่ของแพกเกจ แต่ทำให้ผู้ใช้บางส่วนใช้การไม่ได้
• does-not-build (คอมไพล์ไม่ผ่าน) คือบั๊กที่เรียกกันว่า FTBFS (Fails To Build From Source) เคยเป็นบั๊กในระดับ serious แต่ปัจจุบันแยกออกมาเป็นเอกเทศ
• normal (ปกติ) ไม่ได้ทำให้แพกเกจใช้การไม่ได้ แต่เป็นปัญหาของบางส่วนของโปรแกรมเท่านั้น
• minor (เล็กน้อย) เป็นบั๊กเกี่ยวกับตัวสะกด หรือหน้าตาที่ผิดเพี้ยนของหน้าจอ เป็นต้น โดยไม่ได้มีผลกับการทำงานของแพกเกจ
• wishlist (ขอเพิ่ม) เป็นการขอเพิ่มความสามารถบางอย่าง หรือเพิ่มคำแปล

ผ่านขั้นนี้ไปแล้ว ก็เป็นรายละเอียดของบั๊กละ

Subject: libx11-6: Thai XIM does not filter keys when NumLock/CapsLock is on
Package: libx11-6
Version: 2:1.0.3-7
Severity: normal

*** Please type your report below this line ***
(ป้อนรายละเอียดที่นี่)

-- System Information:
Debian Release: lenny/sid
  APT prefers unstable
  APT policy: (500, 'unstable')
Architecture: amd64 (x86_64)

Kernel: Linux 2.6.22-2-amd64 (SMP w/2 CPU cores)
Locale: LANG=th_TH.UTF-8, LC_CTYPE=th_TH.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/bash

Versions of packages libx11-6 depends on:
ii  libc6                         2.6.1-5    GNU C Library: Shared libraries
ii  libx11-data                   2:1.0.3-7  X11 client-side library
ii  libxau6                       1:1.0.3-2  X11 authorisation library
ii  libxdmcp6                     1:1.0.2-2  X11 Display Manager Control Protoc
ii  x11-common                    1:7.3+2    X Window System (X.Org) infrastruc

libx11-6 recommends no packages.

-- no debconf information

สังเกตว่าจะมี header ซึ่งระบบบั๊กจะใช้ขณะสร้างบั๊ก จึงไม่ควรแตะต้องเด็ดขาด และตอนท้าย จะให้ข้อมูลทั่วไปของระบบ รวมทั้งรุ่นของแพกเกจต่าง ๆ ที่เกี่ยวข้องโดยอัตโนมัติ ไม่ควรแตะต้องเช่นกัน ป้อนเฉพาะรายละเอียดตรงบริเวณที่กำหนดเท่านั้นพอ

เสร็จแล้ว สั่งบันทึก (เช่น ถ้าใช้ vi ก็ ':wq') แล้วตอบคำถามยืนยัน โปรแกรมจะส่งบั๊กผ่านทางเมลให้โดยอัตโนมัติ

เมื่อระบบบั๊กได้รับเมลของคุณ และสร้างรายการบั๊กให้แล้ว ก็จะมีเมลตอบมาพร้อมหมายเลขบั๊ก พร้อมคำอธิบายวิธีติดตามบั๊ก

เริ่มยาวแล้ว ไว้ตอนหน้ามาพูดถึงการปรับแต่ง reportbug สำหรับสถานการณ์บางอย่าง แล้วต่อด้วยการติดตามบั๊กที่รายงานไปครับ

reportbug แบบส่งเมลเอง

ตอนที่แล้ว เราพูดถึงการรายงานบั๊กด้วย reportbug ในสถานการณ์ปกติไปแล้ว ซึ่งจะเห็นว่าสะดวกมากทีเดียว ที่ไม่ต้องเปิดเว็บเบราว์เซอร์เลย ถ้าเซ็ตระบบเมลไว้เรียบร้อย แต่ถ้าคุณใช้ระบบเมลอื่น เช่น web mail ที่ไม่ได้เชื่อมต่อกับระบบ debian ที่คุณใช้ล่ะ?

ปัญหาข้อแรกคือ reportbug จะส่งเมลโดยใช้ที่อยู่ในเครื่อง ซึ่งอาจจะเป็น user@localhost.localdomain ก็ได้ และอีกข้อหนึ่งคือ เมลจะส่งออกไปไม่ได้ ถ้าระบบของคุณไม่ได้เซ็ตไว้ให้รับ-ส่งเมล (ซึ่งเป็นเหตุผลที่คุณใช้ web mail)

ปัญหาข้อแรก คือที่อยู่เมลที่จะใช้ส่งรายงาน คุณกำหนดได้ใน /etc/reportbug.conf หรือ ~/.reportbugrc โดยกำหนดค่า realname และ email เช่น

# Default "from" email address and real name (override with env. vars.)
email "somchai@example.com"
realname "Somchai Klahan"

นั่นจะมีผลถ้าคุณส่งเมลโดยผ่าน SMTP server ที่เครื่องอื่นได้ แต่ถ้าคุณใช้ web mail ล้วน ๆ ทั้งรับและส่งเมลล่ะก็ อาจจะปล่อยค่าข้างบนไว้ไม่ต้องแก้ แล้วมาที่ปัญหาข้อที่สอง คือการส่งเมล

คุณสามารถสร้างรายงานบั๊กโดยไม่ส่งได้ โดยใช้ตัวเลือก -o <filename> ของ reportbug

$ reportbug -o report.txt package

คุณจะผ่านกระบวนการปกติของ reportbug จนถึงขั้นสุดท้าย ราวกับว่าคุณกำลังจะส่งเมลจริง ๆ แต่เนื้อหาเมลจะเขียนลงในแฟ้มที่กำหนดแทน โดยมีเนื้อหาคล้าย ๆ อย่างนี้:

Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
From: Somchai Klahan <somchai@example.com>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: libx11-6: Thai XIM does not filter keys when NumLock/CapsLock is on
Bcc: Somchai Klahan <somchai@example.com>
Message-ID: <20070924063008.10445.46943.reportbug@localhost.localdomain>
X-Mailer: reportbug 3.39
Date: Mon, 24 Sep 2007 13:30:08 +0700

Package: libx11-6
Version: 2:1.0.3-7
Severity: normal

(รายละเอียดบั๊กที่เขียน)

-- System Information:
Debian Release: lenny/sid
  APT prefers unstable
  APT policy: (500, 'unstable')
Architecture: amd64 (x86_64)

Kernel: Linux 2.6.22-2-amd64 (SMP w/2 CPU cores)
Locale: LANG=th_TH.UTF-8, LC_CTYPE=th_TH.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/bash

Versions of packages libx11-6 depends on:
ii  libc6                         2.6.1-5    GNU C Library: Shared libraries
ii  libx11-data                   2:1.0.3-7  X11 client-side library
ii  libxau6                       1:1.0.3-2  X11 authorisation library
ii  libxdmcp6                     1:1.0.2-2  X11 Display Manager Control Protoc
ii  x11-common                    1:7.3+2    X Window System (X.Org) infrastruc

libx11-6 recommends no packages.

-- no debconf information

คุณก็จัดการตัดแปะโดยเปิด web mail ส่งเมลไปที่ที่อยู่ใน To: ใช้ Subject: ตามนั้น แล้วคัดลอกเนื้อหาที่อยู่ใต้ mail header ทั้งหมดลงไป (ในตัวอย่างข้างต้นคือใต้ Date: ... ลงมา)

จบแล้ว.. ใช้ web mail ก็รายงานบั๊กให้เดเบียนได้เหมือนกัน

อีกกรณีหนึ่งที่น่าสนใจ คือการเซ็นกำกับรายงานด้วย gpg ในกรณีที่คุณมีกุญแจ gpg และต้องการยืนยันว่ารายงานนี้มาจากคุณจริง ก็ใช้ตัวเลือกนี้ใน /etc/reportbug.conf หรือ ~/.reportbugrc ได้:

sign gpg

ในขั้นตอนสุดท้ายก่อนส่งเมลหรือเขียนลงแฟ้ม reportbug จะเซ็นกำกับข้อความด้วยกุญแจ gpg ปริยายของคุณ

ตอนหน้ามาพูดถึงวิธีการใช้ระบบติดตามบั๊กของเดเบียนกัน

การติดต่อกับระบบติดตามบั๊ก

หลังจากรายงานบั๊กไปตามที่ว่ากันใน ตอนแรก และ ตอนที่สอง แล้ว เมื่อระบบบั๊กของเดเบียนได้รับเมลของคุณและสร้างรายการบั๊กในระบบเสร็จแล้ว จะส่งเมลตอบมาพร้อมหมายเลขบั๊กและวิธีการติดตามบั๊ก รวมทั้งชื่อและที่อยู่ของผู้ดูแลแพกเกจซึ่งจะได้รับสำเนาของรายงานด้วย

รายการบั๊กของคุณ สามารถดูผ่านเว็บได้ง่าย ๆ โดยไปที่ http://bugs.debian.org/ แล้วป้อนหมายเลขบั๊ก หรือจะใช้รูปแบบ:

http://bugs.debian.org/<หมายเลขบั๊ก>

เพื่อตรงไปที่บั๊กหมายเลขที่ต้องการได้ทันที หรือถ้าใช้รูปแบบ:

http://bugs.debian.org/<ชื่อแพกเกจ>

ก็จะแสดงบั๊กทั้งหมดของแพกเกจที่กำหนด ใช้ค้นหาบั๊กที่มีผู้รายงานได้อย่างรวดเร็ว เวลาที่คุณเจอปัญหาอะไรในเดเบียน นอกเหนือจากการใช้คำสั่ง reportbug ที่บรรทัดคำสั่ง

เกร็ด: ผมทำ smart bookmark ของ Epiphany เอาไว้เลย ช่วยประหยัด keystroke ได้เยอะ

การแสดงความเห็นเพิ่มเติมในบั๊ก ก็ทำได้โดยส่งเมลไปที่:

<หมายเลขบั๊ก>@bugs.debian.org

ส่วนการกระทำอย่างอื่นเกี่ยวกับบั๊ก เช่น เพิ่มแท็ก เปลี่ยนระดับความร้ายแรง ผสานบั๊กที่รายงานซ้ำกัน ฯลฯ สามารถทำได้โดยส่งเมลคำสั่งไปที่

control at bugs dot debian dot org

โดยดูรายการคำสั่งทั้งหมดได้จาก คำแนะนำคำสั่งควบคุมบั๊ก โดยปิดท้ายคำสั่งด้วยคำสั่ง "thanks" (หรือ "quit", "stop", "thank", "thankyou" หรือ "thank you" ก็ได้ แต่เห็นใช้ "thanks" กันมากที่สุด) ระบบควบคุมบั๊กจะหยุดอ่านคำสั่งหลังจากบรรทัดนี้ไป

เช่น จะเปลี่ยนหัวข้อของบั๊ก 123456 ก็ใช้คำสั่ง:

retitle 123456 foo: foo is ugly
thanks

ส่งคำสั่งทีละหลายคำสั่งก็ได้ เช่น:

package foo
reassign 123456 bar

package bar
retitle 123456 bar: bar is ugly
severity 123456 normal

thanks

จะเป็นการโอนบั๊กจากแพกเกจ foo ให้เป็นของแพกเกจ bar (หลังจากที่ตรวจสอบแล้ว พบว่าไม่ใช่ปัญหาในแพกเกจ foo แต่อยู่ใน bar) ตามด้วยการเปลี่ยนชื่อบั๊กให้เกี่ยวข้องกับ bar พร้อมทั้งเปลี่ยนระดับความร้ายแรงของบั๊กให้เป็น normal

คำสั่ง "package" ใช้กำหนดให้คำสั่งต่าง ๆ ที่ตามมานั้น ใช้กับบั๊กของแพกเกจที่กำหนดเท่านั้น คุณจะไม่กำหนดคำสั่ง "package" นี้ แล้วสั่งกระทำกับบั๊กตรง ๆ เลยก็ได้ แต่คำสั่งนี้มีประโยชน์ที่สามารถกันการพิมพ์หมายเลขบั๊กผิด ซึ่งจะไประรานบั๊กของชาวบ้านเขาได้ โดยถ้าพิมพ์ผิด แล้วบั๊กนั้นไม่ใช่ของแพกเกจที่กำหนด ก็จะไม่มีผลอะไร

สังเกตคำสั่ง "thanks" ที่บรรทัดสุดท้าย เป็นการจบคำสั่ง ข้อความต่อจากบรรทัดนี้ไปจะไม่มีผลอะไรกับการควบคุมบั๊ก

โดยปกติ ในฐานะผู้รายงานบั๊ก คำสั่งที่อาจเป็นประโยชน์สำหรับคุณก็คือ:

reopen หมายเลขบั๊ก

ใช้เปิดบั๊กที่ปิดไปแล้วขึ้นมาใหม่ อาจใช้ในกรณีที่นักพัฒนาอ้างว่าแก้ปัญหาแล้ว แต่คุณพบว่าปัญหายังคงอยู่

retitle หมายเลขบั๊ก ชื่อใหม่

ใช้เปลี่ยนชื่อหัวข้อบั๊กเป็นชื่อใหม่ อาจใช้เมื่อพบว่าปัญหาจริง ๆ เป็นอีกเรื่องหนึ่ง หรือพิมพ์ผิด

severity หมายเลขบั๊ก ระดับความร้ายแรง

ใช้เปลี่ยนระดับความร้ายแรงของบั๊ก

tags หมายเลขบั๊ก [ + | - | = ] tag [ tag... ]

ใช้ติดป้ายกำกับบั๊กเพื่อบอกสถานะบางอย่าง โดยใช้ + เพิ่มแท็ก, ใช้ - ลบแท็กออก, ใช้ = ลบแท็กเดิมทั้งหมดแล้วใช้แท็กชุดใหม่แทน เช่น

tags 123456 + patch l10n

ระบุแท็กของบั๊กว่ามีแพตช์เสนอ และเป็นบั๊กที่เกี่ยวกับ localization

ดูความหมายของแท็กต่าง ๆ ได้จาก หน้าอ้างอิง

package ชื่อแพกเกจ

ใช้ระบุว่า คำสั่งต่าง ๆ ที่ตามมา ใช้กับแพกเกจที่กำหนดเท่านั้น ถ้าบั๊กไม่ใช่ของแพกเกจนี้ ไม่ทำ

thanks

thank

thankyou

thank you

stop

quit

ใช้จบชุดคำสั่ง สิ่งที่อยู่ในเมลหลังบรรทัดนี้ จะไม่ถูกอ่าน

(ดูรายละเอียด คำสั่งทั้งหมด)

ระบบติดตามบั๊กของเดเบียน จะว่ายากก็ยาก แต่จะว่าสะดวกก็สะดวก ในเมื่อทุกอย่างติดต่อผ่านเมลหมด จะ forward หรือ Cc: เข้าเมลลิงลิสต์ก็สะดวก จะ quote จะ attach อะไร ก็ใช้ระบบเมลนั่นแหละ ระบบบั๊กบนเว็บอย่าง bugzilla นั้น จะมีเมลแจ้งเมื่อมีความเห็นใหม่ แต่จะบอกว่า "do not reply to this message" ให้คลิกไปตอบในเบราว์เซอร์แทน ซึ่งก็ต้องเปิด URL แล้วล็อกอินอีกขั้นหนึ่งก่อนตอบ แต่ของเดเบียน ให้ตอบได้เลยทางเมลที่ได้รับนั่นแหละ (ยกเว้นความเห็นแรกที่ต้องส่งเข้าที่อยู่ของบั๊กเอง)

ข้อเสียคือ ต้องเรียนรู้คำสั่งในการควบคุมบั๊กนิดหน่อย แต่โดยส่วนใหญ่ ถ้าคุณไม่ใช่นักพัฒนา ก็มักจะไม่ได้ใช้คำสั่งพวกนี้หรอก

# apt-get install reportbug-ng

Applications > System Tools > Reportbug-NG
[โปรแกรม > เครื่องมือระบบ > Reportbug-NG]