Tue Apr 6 17:21:17 2021 UTC ()
update for transition from README.html


(nia)
diff -r1.85 -r1.86 pkgsrc/doc/guide/files/build.xml

cvs diff -r1.85 -r1.86 pkgsrc/doc/guide/files/build.xml (expand / switch to unified diff)

--- pkgsrc/doc/guide/files/build.xml 2020/06/20 15:25:01 1.85
+++ pkgsrc/doc/guide/files/build.xml 2021/04/06 17:21:17 1.86
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1<!-- $NetBSD: build.xml,v 1.85 2020/06/20 15:25:01 rillig Exp $ --> 1<!-- $NetBSD: build.xml,v 1.86 2021/04/06 17:21:17 nia Exp $ -->
2 2
3<chapter id="build"> 3<chapter id="build">
4 <title>The build process</title> 4 <title>The build process</title>
5 5
6 <sect1 id="build.intro"> 6 <sect1 id="build.intro">
7 <title>Introduction</title> 7 <title>Introduction</title>
8 8
9 <para>This chapter gives a detailed description on how a package is 9 <para>This chapter gives a detailed description on how a package is
10 built. Building a package is separated into different 10 built. Building a package is separated into different
11 <emphasis>phases</emphasis> (for example <varname>fetch</varname>, 11 <emphasis>phases</emphasis> (for example <varname>fetch</varname>,
12 <varname>build</varname>, <varname>install</varname>), all of which are 12 <varname>build</varname>, <varname>install</varname>), all of which are
13 described in the following sections. Each phase is split into 13 described in the following sections. Each phase is split into
14 so-called <emphasis>stages</emphasis>, which take the name of the 14 so-called <emphasis>stages</emphasis>, which take the name of the
@@ -1059,75 +1059,75 @@ ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site @@ -1059,75 +1059,75 @@ ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site
1059 PKG=<replaceable>somepackage</replaceable></command>.</para> 1059 PKG=<replaceable>somepackage</replaceable></command>.</para>
1060 1060
1061 <para>Running this command takes a very long time, some 1061 <para>Running this command takes a very long time, some
1062 hours even on fast machines!</para> 1062 hours even on fast machines!</para>
1063 </listitem> 1063 </listitem>
1064 </varlistentry> 1064 </varlistentry>
1065 1065
1066 1066
1067 <varlistentry> 1067 <varlistentry>
1068 <term>readme</term> 1068 <term>readme</term>
1069 1069
1070 <listitem> 1070 <listitem>
1071 <para>This target generates a 1071 <para>This target generates a
1072 <filename>README.html</filename> file, which can be 1072 <filename>index.html</filename> file, which can be
1073 viewed using a browser such as <filename 1073 viewed using a browser such as <filename
1074 role="pkg">www/firefox</filename> or <filename 1074 role="pkg">www/firefox</filename> or <filename
1075 role="pkg">www/links</filename>. The generated files 1075 role="pkg">www/links</filename>. The generated files
1076 contain references to any packages which are in the 1076 contain references to any packages which are in the
1077 <varname>PACKAGES</varname> directory on the local 1077 <varname>PACKAGES</varname> directory on the local
1078 host. The generated files can be made to refer to URLs 1078 host. The generated files can be made to refer to URLs
1079 based on <varname>FTP_PKG_URL_HOST</varname> and 1079 based on <varname>FTP_PKG_URL_HOST</varname> and
1080 <varname>FTP_PKG_URL_DIR</varname>. For example, if I 1080 <varname>FTP_PKG_URL_DIR</varname>. For example, if I
1081 wanted to generate <filename>README.html</filename> 1081 wanted to generate <filename>index.html</filename>
1082 files which pointed to binary packages on the local 1082 files which pointed to binary packages on the local
1083 machine, in the directory 1083 machine, in the directory
1084 <filename>/usr/packages</filename>, set 1084 <filename>/usr/packages</filename>, set
1085 <varname>FTP_PKG_URL_HOST=file://localhost</varname> and 1085 <varname>FTP_PKG_URL_HOST=file://localhost</varname> and
1086 <varname>FTP_PKG_URL_DIR=/usr/packages</varname>. The 1086 <varname>FTP_PKG_URL_DIR=/usr/packages</varname>. The
1087 <varname>${PACKAGES}</varname> directory and its 1087 <varname>${PACKAGES}</varname> directory and its
1088 subdirectories will be searched for all the binary 1088 subdirectories will be searched for all the binary
1089 packages.</para> 1089 packages.</para>
1090 1090
1091 <para>The target can be run at the toplevel or in category 1091 <para>The target can be run at the toplevel or in category
1092 directories, in which case it descends recursively.</para> 1092 directories, in which case it descends recursively.</para>
1093 </listitem> 1093 </listitem>
1094 </varlistentry> 1094 </varlistentry>
1095 1095
1096 <varlistentry> 1096 <varlistentry>
1097 <term>readme-all</term> 1097 <term>readme-all</term>
1098 1098
1099 <listitem> 1099 <listitem>
1100 <para>This is a top-level command, run it in 1100 <para>This is a top-level command, run it in
1101 <filename>pkgsrc</filename>. Use this target to create a 1101 <filename>pkgsrc</filename>. Use this target to create a
1102 file <filename>README-all.html</filename> which contains a 1102 file <filename>README-all.html</filename> which contains a
1103 list of all packages currently available in the &os; 1103 list of all packages currently available in the &os;
1104 Packages Collection, together with the category they belong 1104 Packages Collection, together with the category they belong
1105 to and a short description. This file is compiled from the 1105 to and a short description. This file is compiled from the
1106 <filename>pkgsrc/*/README.html</filename> files, so be sure 1106 <filename>pkgsrc/*/index.html</filename> files, so be sure
1107 to run this <emphasis>after</emphasis> a <command>make 1107 to run this <emphasis>after</emphasis> a <command>make
1108 readme</command>.</para> 1108 readme</command>.</para>
1109 </listitem> 1109 </listitem>
1110 </varlistentry> 1110 </varlistentry>
1111 1111
1112 <varlistentry> 1112 <varlistentry>
1113 <term>cdrom-readme</term> 1113 <term>cdrom-readme</term>
1114 1114
1115 <listitem> 1115 <listitem>
1116 <para>This is very much the same as the 1116 <para>This is very much the same as the
1117 <quote>readme</quote> target (see above), but is to be 1117 <quote>readme</quote> target (see above), but is to be
1118 used when generating a pkgsrc tree to be written to a 1118 used when generating a pkgsrc tree to be written to a
1119 CD-ROM. This target also produces 1119 CD-ROM. This target also produces
1120 <filename>README.html</filename> files, and can be made 1120 <filename>index.html</filename> files, and can be made
1121 to refer to URLs based on 1121 to refer to URLs based on
1122 <varname>CDROM_PKG_URL_HOST</varname> and 1122 <varname>CDROM_PKG_URL_HOST</varname> and
1123 <varname>CDROM_PKG_URL_DIR</varname>.</para> 1123 <varname>CDROM_PKG_URL_DIR</varname>.</para>
1124 </listitem> 1124 </listitem>
1125 </varlistentry> 1125 </varlistentry>
1126 1126
1127 <varlistentry> 1127 <varlistentry>
1128 <term>show-distfiles</term> 1128 <term>show-distfiles</term>
1129 1129
1130 <listitem> 1130 <listitem>
1131 <para>This target shows which distfiles and patchfiles 1131 <para>This target shows which distfiles and patchfiles
1132 are needed to build the package 1132 are needed to build the package
1133 (<varname>ALLFILES</varname>, which contains all 1133 (<varname>ALLFILES</varname>, which contains all