Chương 4. Các tệp yêu cầu trong thư mục debian

Tập tin này chứa các giá trị khác nhau mà dpkg, dselect, apt-get, apt-cache, aptitude, và các công cụ quản lý gói khác sẽ sử dụng để quản lý gói. Nó được xác định bởi Debian Policy Manual, 5 "Control files and their fields"

Đây là tệp control mà dh_make tạo ra cho chúng ta:

 1 Source: gentoo
 2 Section: unknown
 3 Priority: optional
 4 Maintainer: Josip Rodin <joy-mg@debian.org>
 5 Build-Depends: debhelper (>=10)
 6 Standards-Version: 4.0.0
 7 Homepage: <insert the upstream URL, if relevant>
 8
 9 Package: gentoo
10 Architecture: any
11 Depends: ${shlibs:Depends}, ${misc:Depends}
12 Description: <insert up to 60 chars description>
13  <insert long description, indented with spaces>

(Tôi đã thêm các số dòng.)

Dòng 1–7 là thông tin điều khiển cho gói nguồn. Dòng 9–13 là thông tin điều khiển cho gói nhị phân.

Dòng 1 là tên của gói nguồn

Dòng 2 là các mục loại mục chương trình

Như bạn có thể nhận thấy, kho phần mềm Debian được chia làm nhiều khu vục: main (phần mềm tự do), non-free (thật sự không phải phẩn mềm tự do) and contrib (phần mềm tự do phụ thuộc vào phần mềm không tự do). Mỗi loại được chi thánh các phần danh mục. Vậy chúng ta có admin cho các chương trình quản trị, devel cho các công cụ phát triển, doc cho tài liệu, libs cho thư viện, mail cho chương trình liên quan thư điện tử, net cho ứng dụng mạng và chaỵ nền, x11 cho các chương trình X11 khác, và nhiều nữa. ^[28]

Chúng ta hãy thay đổi nó thành x11. (Tiền tố main/ với ngụ ý là chúng ta có thể bỏ qua nó).

Dòng 3 miêu tả mức độ quan trọng của việc ngươì dùng cài đặt gói này. ^[29]

Trường Section và Priority được sử dụng bởi các chương trình front-ends như aptitude khi họ sắp xếp gói và chọn mặc định. Khi bạn tải gói lên Debian, giá trị của hai trường này có thể bị ghi đè bởi các nhà bảo trì kho lưu trữ, trong trường hợp đó bạn sẽ được thông báo bằng email.

Vì đây là gói ưu tiên thông thường và không xung đột với bất kỳ điều gì khác, chúng tôi sẽ thay đổi mức độ ưu tiên thành optional.

Dòng 4 là tên và địa chỉ email của người bảo trì. Hãy đảm bảo rằng trường này có tiêu đề To hợp lệ cho email, bởi vì sau khi tải lên, hệ thống theo dõi lỗi sẽ sử dụng chính trường này để gửi email lỗi cho bạn. Tránh sử dụng dấu phẩy, ký hiệu, hoặc dấu ngoặc đơn.

Dòng 5 là trưởng Build-Depends bao gồm danh sách của các gói yêu cầu để xây dựng gói của bạn. Bạn cũng có thể có thêm trường Build-Depends-Indep bổ sung. ^[30]. Một số gói như gcc và make là yêu cầu ngầm định bởi gói build-essential Nếu bạn cần có các công cụ khác để xây dựng gói của mình, bạn nên thêm chúng vào các trường này. Nhiều mục được phân cách bằng dấu phẩy; Hãy đọc tiếp để hiểu rõ hơn về các phụ thuộc gói nhị phân.

Nếu bạn không chắc chắn nên sử dụng trường nào, hãy sử dụng trường Build-Depends để an toàn. ^[31]

Để tìm ra những gói nào cần để xây dựng chương trình của bạn:

$ dpkg-depcheck -d ./configure

Để tự tìm chính xác các phụ thuộc khi xây dựng /usr/bin/foo, thực hiện

$ objdump -p /usr/bin/foo | grep NEEDED

và cho mỗi thư viện được liệt kê (ví dụ: libfoo.so.6), thực hiện

$ dpkg -S libfoo.so.6

Sau đó chỉ cần lấy phiên bản -dev của mỗi gói như một mục nhập Build-Depends. Nếu bạn sử dụng ldd cho mục đích này, nó sẽ báo cáo phụ thuộc lib gián tiếp, kết quả là

gentoo yêu cầu xlibs-dev, libgtk1.2-dev and libglib1.2-dev để xây dựng, vâỵ nên chúng ta sẽ thêm chúng vào vị trí tiếp theo debhelper.

Dòng 6 là phiên bản của Debian Policy Manualmà phần mềm này tuân theo, một trong tài liệu bạn đọc trong khi xây dựng gói của bạn.

Trên dòng 7, bạn có thể đặt URL của trang chủ thượng nguồn của phần mềm

Dòng 9 là tên của gói nhị phân. Nó thường giống với tên của gói nguồn, nhưng nó không nhất thiết phải giống nhau.

Dòng 10 mô tả các kiến ​​trúc mà gói nhị phân có thể được biên dịch. Giá trị này thường là một trong các tùy chọn sau, tùy thuộc vào loại gói nhị phân: ^[32]

Chúng ta để lại dòng 10 vì nó được viết bằng C. dpkg-gencontrol(1) sẽ tự điền vào trường Architecture một cách thích hợp cho bất kỳ máy nào gói nguồn này được biên soạn.

Nếu gói của bạn là kiến ​​trúc độc lập (ví dụ: mã shell hoặc kịch bản Perl, hoặc tài liệu), hãy thay đổi điều này thành all và đọc Phần 4.4, “rules” về binary-indep thay vì binary-arch để xây dựng gói.

Dòng 11 cho thấy một trong những tính năng mạnh mẽ nhất của hệ thống đóng gói Debian. Gói có thể liên quan đến nhau theo nhiều cách khác nhau. Ngoài Depends, các trường mối quan hệ khác là Recommends, Suggests, Pre-Depends, Breaks, Conflicts, Provides và Replaces.

Các công cụ quản lý gói thường có chung hành vi khi đọc các mối quan hệ này; Nếu không, nó sẽ được giải thích. (See dpkg(8), dselect(8), apt(8), aptitude(1), etc.)

Đây là mô tả đơn giản về các mối quan hệ của gói: ^[33]

Tất cả các trường này có cú pháp thống nhất. Họ là một danh sách các tên gói được phân cách bằng dấu phẩy. Các tên gói này cũng có thể là danh sách các tên gói thay thế, được phân cách bằng ký hiệu thanh dọc | (biểu tượng ống).

Các trường có thể hạn chế khả năng áp dụng của chúng đối với các phiên bản cụ thể của từng gói có tên. Hạn chế của từng gói riêng lẻ được liệt kê trong dấu ngoặc đơn sau tên của nó và phải có một mối quan hệ từ danh sách dưới đây và theo sau là một giá trị số phiên bản. Các mối quan hệ được cho phép là: <<, <=, =, >=, và >> tương ứng với bé hơn, bé hơn hoặc bằng, chính xác bằng, lớn hơn hoặc bằng, và lớn hơn. Ví dụ,

Depends: foo (>= 1.2), libbar1 (= 1.3.4)
Conflicts: baz
Recommends: libbaz4 (>> 4.0.7)
Suggests: quux
Replaces: quux (<< 5), quux-foo (<= 7.6)

Tính năng cuối cùng bạn cần biết là về ${shlibs:Depends}, ${perl:Depends}, ${misc:Depends}, vân vân.

dh_shlibdeps(1) tính toán sự phụ thuộc vào các thư viện chia sẻ cho các gói nhị phân. Nó sinh ra một danh sách củả tệp thực thi ELF và thư viện chia sẻ mà nó đã tìm cho mỗi gói nhị phân. Danh sách này được sử dụng để thay thế ${shlibs:Depends}.

dh_perl(1) tính toán sự phụ thuộc Perl. Nó sinh ra một danh sách của các phụ thuộc trong perl hoặc perlapi cho mỗi gói nhị phân. Danh sách này được sử dụng thay thế cho ${perl:Depends}.

Một vài lệnh debhelper có thể làm cho gói được sinh ra phụ thuộc vào vài gói mở rộng thêm. Tất cả các lệnh như vậy sinh ra một danh sách của các gói cho mỗi gói nhị phân. Danh sách này được sử dụng để thay thế cho ${misc:Depends}.

dh_gencontrol(1) tạo ra DEBIAN/control cho mỗi gói nhị phân trong khi thay thế ${shlibs:Depends}, ${perl:Depends}, ${misc:Depends}, vân vân.

Có tất cả những điều đó, chúng ta có thể để trường Depends chính xác như bây giờ và chèn một dòng sau là Suggests: file, bởi vì gentoo có thể sử dụng một số tính năng được cung cấp bởi gói file .

Dòng 9 là URL Trang chủ. Giả sử rằng đây là http://www.obsession.se/gentoo/.

Dòng 12 là mô tả ngắn. Thiết bị đầu cuối thông thường có 80 cột nên không được dài hơn 60 ký tự. Tôi sẽ thay đổi nó thành fully GUI-configurable, two-pane X file manager

Dòng 13 là nơi diễn tả dài. Đây sẽ là một đoạn cho biết thêm chi tiết về gói. Cột 1 của mỗi dòng nên để trống. Không có dòng trắng, nhưng bạn có thể đặt một . (dấu chấm) trong một cột để mô phỏng. Ngoài ra, không có nhiều dòng trống sau mô tả dài. ^[34]

Chúng ta có thể chèn các trường Vcs-* để ghi lại thông tin của VCS trong các dòng 6 và 7. ^[35] Hãy giả sử rằng gói gentoo có VCS của nó nằm trong Debian Alioth Git Service ở git://git.debian.org/git/collab-maint/gentoo.git.

Cuối cùng, đây là tệp control đã được cập nhật

 1 Source: gentoo
 2 Section: x11
 3 Priority: optional
 4 Maintainer: Josip Rodin <joy-mg@debian.org>
 5 Build-Depends: debhelper (>=10), xlibs-dev, libgtk1.2-dev, libglib1.2-dev
 6 Standards-Version: 4.0.0
 7 Vcs-Git: https://anonscm.debian.org/git/collab-maint/gentoo.git
 8 Vcs-browser: https://anonscm.debian.org/git/collab-maint/gentoo.git
 9 Homepage: http://www.obsession.se/gentoo/
10
11 Package: gentoo
12 Architecture: any
13 Depends: ${shlibs:Depends}, ${misc:Depends}
14 Suggests: file
15 Description: fully GUI-configurable, two-pane X file manager
16  gentoo is a two-pane file manager for the X Window System. gentoo lets the
17  user do (almost) all of the configuration and customizing from within the
18  program itself. If you still prefer to hand-edit configuration files,
19  they're fairly easy to work with since they are written in an XML format.
20  .
21  gentoo features a fairly complex and powerful file identification system,
22  coupled to an object-oriented style system, which together give you a lot
23  of control over how files of different types are displayed and acted upon.
24  Additionally, over a hundred pixmap images are available for use in file
25  type descriptions.
26  .
29  gentoo was written from scratch in ANSI C, and it utilizes the GTK+ toolkit
30  for its interface.

(Tôi đã thêm các số dòng.)

Tập tin này chứa thông tin về bản quyền và giấy phép của các nguồn thượng nguồn Debian Policy Manual, 12.5 "Copyright information" kiểm soát nội dung của nó và DEP-5: Machine-parseable debian/copyright cung cấp các chỉ dẫn cho định dạng của nó

dh_make có thể cho bạn một tệp mẫu copyright . Hãy sử dụng tuỳ chọn --copyright gpl2 để lấy tệp mẫu cho gói gentoo phát hành dưói giấy phép GPL-2.

Bạn phải điền thông tin còn thiếu để hoàn thành tệp này, chẳng hạn như nơi tạo ra gói ,thông báo bản quyền thực tế, và giấy phép. Đối với một số giấy phép phần mềm tự do thông thường (GNU GPL-1, GNU GPL-2, GNU GPL-3, LGPL-2, LGPL-2.1, LGPL-3, GNU FDL-1.2, GNU FDL-1.3, Apache-2.0, hoặc Artistic license), bạn chỉ cần tham khảo các tệp thích hợp trong thư mục /usr/share/common-licenses/ tồn tại trên bất kỳ hệ thống Debian. Nếu không, bạn phải bao gồm giấy phép đầy đủ.

Tóm lại, tệp copyright của gói gentoo trông sẽ như sau:

 1 Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 2 Upstream-Name: gentoo
 3 Upstream-Contact: Emil Brink <emil@obsession.se>
 4 Source: http://sourceforge.net/projects/gentoo/files/
 5
 6 Files: *
 7 Copyright: 1998-2010 Emil Brink <emil@obsession.se>
 8 License: GPL-2+
 9
10 Files: icons/*
11 Copyright: 1998 Johan Hanson <johan@tiq.com>
12 License: GPL-2+
13
14 Files: debian/*
15 Copyright: 1998-2010 Josip Rodin <joy-mg@debian.org>
16 License: GPL-2+
17
18 License: GPL-2+
19  This program is free software; you can redistribute it and/or modify
20  it under the terms of the GNU General Public License as published by
21  the Free Software Foundation; either version 2 of the License, or
22  (at your option) any later version. 
23  .
24  This program is distributed in the hope that it will be useful,
25  but WITHOUT ANY WARRANTY; without even the implied warranty of
26  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27  GNU General Public License for more details.
28  .
29  You should have received a copy of the GNU General Public License along
30  with this program; if not, write to the Free Software Foundation, Inc.,
31  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
32  .
33  On Debian systems, the full text of the GNU General Public
34  License version 2 can be found in the file
35  '/usr/share/common-licenses/GPL-2'.

(Tôi đã thêm các số dòng.)

Hãy làm theo HOWTO cung cấp bởi ftpmasters và gửi tới debian-devel-announce: http://lists.debian.org/debian-devel-announce/2006/03/msg00023.html.

Đây là tệp yêu cầu, có định dạng đặc biệt được mô tả trong Debian Policy Manual, 4.4 "debian/changelog". Định dạng này được sử dụng bởi dpkg và các chương trình khác để đọc số phiên bản, số sửa đổi, bản phân phối và tính khẩn cấp của gói

Đối với bạn, điều này cũng rất quan trọng vì bạn nên ghi lại tất cả những thay đổi bạn đã làm. Nó sẽ giúp mọi người tải gói của bạn và xem liệu có vấn đề gì với gói mà họ cần biết hay không. Nó sẽ được lưu lại như /usr/share/doc/gentoo/changelog.Debian.gz trong gói nhị phân.

dh_make tạo ra tệp mặc định, và nó sẽ trông như sau:

1  gentoo (0.9.12-1) unstable; urgency=medium
2
3   * Initial release (Closes: #nnnn)  <nnnn is the bug number of your ITP>
4
5  -- Josip Rodin <joy-mg@debian.org>  Mon, 22 Mar 2010 00:37:31 +0100
6

(Tôi đã thêm các số dòng.)

Dòng 1 là tên gói, phiên bản, phân phối và mức độ khẩn cấp. Tên phải khớp với tên gói nguồn; Phân phối nên là unstable, và nên cài mức độ khẩn cấp lên medidum (trung bình) trừ khi có bất kỳ lý do cụ thể nào cho giá trị khác.

Dòng 3-5 là một mục thông tin, nơi bạn ghi lại những thay đổi được thực hiện trong bản sửa đổi gói này (không phải là những thay đổi ở thượng nguồn — có một tệp tin đặc biệt cho mục đích đó được tạo ra bởi các tác giả thượng nguồn, mà sau này bạn sẽ cài đặt dưới dạng /usr/share/doc/gentoo/changelog.gz). Hãy giả sử báo lỗi ITP (Intent To Package) của bạn có số là 12345. Các dòng mới chèn trên dòng trên cùng nhất của mục nội dung này và bắt đầu với * (dấu sao). Bạn có thể thực hiện điều này với dch(1), bạn có thể chỉnh sửa bằng tay với một trình soạn thảo văn bản theo quy ước định dạng được sử dụng bởi dch(1).

Để ngăn chặn một gói bị vô tình tải lên trước khi hoàn thành gói, bạn nên thay đổi giá trị phân phối thành chưa phát hành UNRELEASED.

Bạn sẽ kết thúc với một cái gì đó như thế này:

1  gentoo (0.9.12-1) UNRELEASED; urgency=low
2
3   * Initial Release. Closes: #12345
4   * This is my first Debian package.
5   * Adjusted the Makefile to fix $(DESTDIR) problems.
6
7  -- Josip Rodin <joy-mg@debian.org>  Mon, 22 Mar 2010 00:37:31 +0100
8

(Tôi đã thêm các số dòng.)

Khi bạn đã hài lòng với tất cả các thay đổi và ghi lại chúng trong changelog, bạn nên thay đổi giá trị phân phối từ UNRELEASED sang unstable (hoặc ngay cả experimental). ^[36]

Bạn có thể đọc về cập nhật tệp changelog tại Chương 8, Cập nhật gói phần mềm.

Bây giờ chúng ta cần phải xem xét các quy tắc chính xác mà dpkg-buildpackage(1) sẽ thực sự sử dụng để tạo gói. Tệp này thật sự là tệp Makefile, nhưng nó khác với (các) tệp Makefile trong nguồn của thượng nguồn. Và không giống các tệp khác trong thư mục debian, đây là tệp thực thi