Thu Jul 13 13:29:07 2023 UTC ()
doc/guide: sync binary package creation with reality

For many years now, binary packages have been created before installing
them.


(rillig)
diff -r1.35 -r1.36 pkgsrc/doc/guide/files/binary.xml
cvs diff -r1.35 -r1.36 pkgsrc/doc/guide/files/binary.xml (expand / switch to unified diff)

--- pkgsrc/doc/guide/files/binary.xml 2016/07/10 07:43:23 1.35
+++ pkgsrc/doc/guide/files/binary.xml 2023/07/13 13:29:07 1.36
@@ -1,43 +1,43 @@ @@ -1,43 +1,43 @@
1<!-- $NetBSD: binary.xml,v 1.35 2016/07/10 07:43:23 rillig Exp $ --> 1<!-- $NetBSD: binary.xml,v 1.36 2023/07/13 13:29:07 rillig Exp $ -->
2 2
3<chapter id="binary"> 3<chapter id="binary">
4 <title>Creating binary packages</title> 4 <title>Creating binary packages</title>
5 5
6 <sect1 id="building-a-single-binary-package"> 6 <sect1 id="building-a-single-binary-package">
7 <title>Building a single binary package</title> 7 <title>Building a single binary package</title>
8 8
9 <para>Once you have built and installed a package, you can create 9 <para>Once you have built and installed a package, you can create
10 a <emphasis>binary package</emphasis> which can be installed on 10 a <emphasis>binary package</emphasis> which can be installed on
11 another system with &man.pkg.add.1;. This saves having to build 11 another system with &man.pkg.add.1;. This saves having to build
12 the same package on a group of hosts and wasting CPU time. It also 12 the same package on a group of hosts and wasting CPU time. It also
13 provides a simple means for others to install your package, should 13 provides a simple means for others to install your package, should
14 you distribute it.</para> 14 you distribute it.</para>
15 15
16 <para>To create a binary package, change into the appropriate 16 <para>To create a binary package, change into the appropriate
17 directory in pkgsrc, and run <command>make 17 directory in pkgsrc, and run <command>make
18 package</command>:</para> 18 package</command>:</para>
19 19
20<screen> 20<screen>
21&uprompt; <userinput>cd misc/figlet</userinput> 21&uprompt; <userinput>cd misc/figlet</userinput>
22&uprompt; <userinput>make package</userinput> 22&uprompt; <userinput>make package</userinput>
23</screen> 23</screen>
24 24
25 <para>This will build and install your package (if not already done), 25 <para>This will build your package (if not already done) and package
26 and then build a binary package from what was installed. You can 26 it into a binary package. You can then use the
27 then use the <command>pkg_*</command> tools to manipulate 27 <command>pkg_*</command> tools to manipulate it. Binary packages are
28 it. Binary packages are created by default in 28 created in <varname>PACKAGES</varname>, which defaults to
29 <filename>/usr/pkgsrc/packages</filename>, in the form of a 29 <filename>/usr/pkgsrc/packages</filename>, in the form of a compressed
30 gzipped tar file. See <xref linkend="logs.package"/> for a 30 tar file. See <xref linkend="logs.package"/> for a continuation of
31 continuation of the above <filename 31 the above <filename role="pkg">misc/figlet</filename>
32 role="pkg">misc/figlet</filename> example.</para> 32 example.</para>
33 33
34 <para>See <xref linkend="submit"/> for information on how to submit 34 <para>See <xref linkend="submit"/> for information on how to submit
35 such a binary package.</para> 35 such a binary package.</para>
36 </sect1> 36 </sect1>
37 37
38 <sect1 id="settings-for-creationg-of-binary-packages"> 38 <sect1 id="settings-for-creationg-of-binary-packages">
39 <title>Settings for creation of binary packages</title> 39 <title>Settings for creation of binary packages</title>
40 40
41 <para>See <xref linkend="build.helpful-targets"/>.</para> 41 <para>See <xref linkend="build.helpful-targets"/>.</para>
42 </sect1> 42 </sect1>
43</chapter> 43</chapter>