[pkgsrc/trunk]: pkgsrc/doc/guide/files Added a subsection about naming conven...

[rillig <rillig%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/4478496f6068
branches:  trunk
changeset: 493743:4478496f6068
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Fri May 13 23:28:08 2005 +0000

description:
Added a subsection about naming conventions for Makefile variables.

diffstat:

 doc/guide/files/makefile.xml |  20 +++++++++++++++++++-
 1 files changed, 19 insertions(+), 1 deletions(-)

diffs (34 lines):

diff -r fe38aa3e016d -r 4478496f6068 doc/guide/files/makefile.xml
--- a/doc/guide/files/makefile.xml      Fri May 13 22:48:09 2005 +0000
+++ b/doc/guide/files/makefile.xml      Fri May 13 23:28:08 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: makefile.xml,v 1.7 2005/05/13 22:48:09 rillig Exp $ -->
+<!-- $NetBSD: makefile.xml,v 1.8 2005/05/13 23:28:08 rillig Exp $ -->
 
 <!-- based on:
 pkgsrc/bootstrap/bmake/for.c 1.1.1.1
@@ -98,6 +98,24 @@
       <varname>MASTER_SITES</varname>.</para></listitem>
 
     </itemizedlist>
+
+    <sect2 id="makefile.variables.names">
+      <title>Naming conventions</title>
+
+      <itemizedlist>
+
+        <listitem><para>All variable names starting with an underscore
+       are reserved for use by the pkgsrc infrastructure. They shall
+       not be used by package
+       <filename>Makefile</filename>s.</para></listitem>
+
+        <listitem><para>In <!-- FIXME --><varname>.for</varname> loops
+       you should use lowercase variable names for the iteration
+       variables.</para></listitem>
+
+      </itemizedlist>
+    </sect2>
+
   </sect1>
 
   <sect1 id="makefile.code">