Sat Sep 13 07:32:54 2014 UTC ()
Fix REPLACE_PERL description and extend REPLACE_{,C,K,BA}SH one.


(wiz)
diff -r1.123 -r1.124 pkgsrc/doc/guide/files/fixes.xml
cvs diff -r1.123 -r1.124 pkgsrc/doc/guide/files/fixes.xml (expand / switch to unified diff)

--- pkgsrc/doc/guide/files/fixes.xml 2013/08/24 16:55:21 1.123
+++ pkgsrc/doc/guide/files/fixes.xml 2014/09/13 07:32:54 1.124
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1<!-- $NetBSD: fixes.xml,v 1.123 2013/08/24 16:55:21 bsiegert Exp $ --> 1<!-- $NetBSD: fixes.xml,v 1.124 2014/09/13 07:32:54 wiz Exp $ -->
2 2
3<chapter id="fixes"> <?dbhtml filename="fixes.html"?> 3<chapter id="fixes"> <?dbhtml filename="fixes.html"?>
4<title>Making your package work</title> 4<title>Making your package work</title>
5 5
6<sect1 id="general-operation"> 6<sect1 id="general-operation">
7 <title>General operation</title> 7 <title>General operation</title>
8 8
9 <sect2 id="portability-of-packages"> 9 <sect2 id="portability-of-packages">
10 <title>Portability of packages</title> 10 <title>Portability of packages</title>
11 11
12 <para>One appealing feature of pkgsrc is that it runs on many 12 <para>One appealing feature of pkgsrc is that it runs on many
13 different platforms. As a result, it is important to ensure, 13 different platforms. As a result, it is important to ensure,
14 where possible, that packages in pkgsrc are portable. This 14 where possible, that packages in pkgsrc are portable. This
@@ -1084,46 +1084,50 @@ pre-configure: @@ -1084,46 +1084,50 @@ pre-configure:
1084 <!-- XXX: describe PKG_JVM_DEFAULT and PKG_JVMS_ACCEPTED, but 1084 <!-- XXX: describe PKG_JVM_DEFAULT and PKG_JVMS_ACCEPTED, but
1085 not here --> 1085 not here -->
1086 </itemizedlist> 1086 </itemizedlist>
1087 </sect2> 1087 </sect2>
1088 1088
1089 <sect2 id="perl-scripts"> 1089 <sect2 id="perl-scripts">
1090 <title>Packages containing perl scripts</title> 1090 <title>Packages containing perl scripts</title>
1091 1091
1092 <para>If your package contains interpreted perl scripts, add 1092 <para>If your package contains interpreted perl scripts, add
1093 <quote>perl</quote> to the <varname>USE_TOOLS</varname> variable 1093 <quote>perl</quote> to the <varname>USE_TOOLS</varname> variable
1094 and set <varname>REPLACE_PERL</varname> to ensure that the proper 1094 and set <varname>REPLACE_PERL</varname> to ensure that the proper
1095 interpreter path is set. <varname>REPLACE_PERL</varname> should 1095 interpreter path is set. <varname>REPLACE_PERL</varname> should
1096 contain a list of scripts, relative to <varname>WRKSRC</varname>, 1096 contain a list of scripts, relative to <varname>WRKSRC</varname>,
1097 that you want adjusted. Every occurrence of 1097 that you want adjusted. Every occurrence of
1098 <filename>*/bin/perl</filename> will be replaced with the full 1098 <filename>*/bin/perl</filename> in a she-bang line will be
1099 path to the perl executable.</para> 1099 replaced with the full path to the perl executable.</para>
1100 1100
1101 <para>If a particular version of perl is needed, set the 1101 <para>If a particular version of perl is needed, set the
1102 <varname>PERL5_REQD</varname> variable to the version number. The 1102 <varname>PERL5_REQD</varname> variable to the version number. The
1103 default is <quote>5.0</quote>.</para> 1103 default is <quote>5.0</quote>.</para>
1104 1104
1105 <para>See <xref linkend="perl-modules" /> for information 1105 <para>See <xref linkend="perl-modules" /> for information
1106 about handling perl modules.</para> 1106 about handling perl modules.</para>
1107 </sect2> 1107 </sect2>
1108 1108
1109 <sect2 id="shell-scripts"> 1109 <sect2 id="shell-scripts">
1110 <title>Packages containing shell scripts</title> 1110 <title>Packages containing shell scripts</title>
1111 1111
1112 <para><varname>REPLACE_SH</varname>, 1112 <para><varname>REPLACE_SH</varname>,
1113 <varname>REPLACE_BASH</varname>, <varname>REPLACE_CSH</varname>, 1113 <varname>REPLACE_BASH</varname>, <varname>REPLACE_CSH</varname>,
1114 and <varname>REPLACE_KSH</varname> can be used to replace shell 1114 and <varname>REPLACE_KSH</varname> can be used to replace shell
1115 hash bangs in files. Please use the appropriate one, prefering 1115 hash bangs in files. Please use the appropriate one, prefering
1116 <varname>REPLACE_SH</varname> in case this shell is sufficient. 1116 <varname>REPLACE_SH</varname> in case this shell is sufficient.
 1117 Each should contain a list of scripts, relative to
 1118 <varname>WRKSRC</varname>, that you want adjusted. Every
 1119 occurrence of the matching shell in a she-bang line will be
 1120 replaced with the full path to the shell executable.
1117 When using <varname>REPLACE_BASH</varname>, don't forget to add 1121 When using <varname>REPLACE_BASH</varname>, don't forget to add
1118 <filename>bash</filename> to <varname>USE_TOOLS</varname>.</para> 1122 <filename>bash</filename> to <varname>USE_TOOLS</varname>.</para>
1119 </sect2> 1123 </sect2>
1120 1124
1121 <sect2 id="other-programming-languages"> 1125 <sect2 id="other-programming-languages">
1122 <title>Other programming languages</title> 1126 <title>Other programming languages</title>
1123 1127
1124 <para>Currently, there is no special handling for other languages 1128 <para>Currently, there is no special handling for other languages
1125 in pkgsrc. If a compiler package provides a 1129 in pkgsrc. If a compiler package provides a
1126 <filename>buildlink3.mk</filename> file, include that, otherwise 1130 <filename>buildlink3.mk</filename> file, include that, otherwise
1127 just add a (build) dependency on the appropriate compiler 1131 just add a (build) dependency on the appropriate compiler
1128 package.</para> 1132 package.</para>
1129 </sect2> 1133 </sect2>