diff options
author | rillig <rillig@pkgsrc.org> | 2006-05-11 09:05:33 +0000 |
---|---|---|
committer | rillig <rillig@pkgsrc.org> | 2006-05-11 09:05:33 +0000 |
commit | 752797eed33d7f71049d16aec128c705f62d6e5e (patch) | |
tree | f223abd071f59108f8d7ba5c385dffe0cba5830d | |
parent | 58d574ad34f79732b6b4377fd5ea023e6cb90447 (diff) | |
download | pkgsrc-752797eed33d7f71049d16aec128c705f62d6e5e.tar.gz |
Some ideas about the contexts in which variables may be used.
-rw-r--r-- | pkgtools/pkglint/files/doc/chap.types.xml | 41 |
1 files changed, 40 insertions, 1 deletions
diff --git a/pkgtools/pkglint/files/doc/chap.types.xml b/pkgtools/pkglint/files/doc/chap.types.xml index b0f44203123..51f036d1411 100644 --- a/pkgtools/pkglint/files/doc/chap.types.xml +++ b/pkgtools/pkglint/files/doc/chap.types.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: chap.types.xml,v 1.8 2006/05/10 17:14:08 rillig Exp $ --> +<!-- $NetBSD: chap.types.xml,v 1.9 2006/05/11 09:05:33 rillig Exp $ --> <chapter id="types"> <title>The &pkglint; type system</title> @@ -147,6 +147,45 @@ first ACL entry whose subject matches the current filename are allowed. If no entry matches, nothing is allowed.</para> + <para>For determining if a variable is used in the correct + place, the filename is only one part of the whole decision. The + other one is the context in which the variable appears. There + are many factors that influence whether the variable is used + correctly.</para> + + <itemizedlist> + + <listitem>The variable may be either used at preprocessing time + or at runtime. Some variables are defined in + <filename>bsd.pkg.mk</filename> and thus are not available until + that file has been included. As this should always be the very + last thing a package includes, it practically means that these + variables are only available at runtime.</listitem> + + <listitem>The variable may appear as the whole right hand side + of an assignment, as a single word, or even as part of a word. + First, the types on the right and left side should be + compatible. Second, some variables need to be quoted correctly, + depending on whether they are part of a word or not.</listitem> + + <listitem>In shell commands, the variable may also appear as a + whole word or as part of a word. This is similar to the case + above.</listitem> + + <listitem>The variable may appear inside some sort of quotes. + For some variables this is acceptable, as they are assumed to + never contain special characters. For others it + isn't.</listitem> + + <listitem>The various operators in conditional statements like + <literal>.if</literal> may further restrict the valid values. + For example, the <varname>OPSYS</varname> variable should only + be compared to well-known operating system names. The + <varname>exists()</varname> function should only be called on + pathnames.</listitem> + + </itemizedlist> + <sect2 id="types.acls.future"> <title>Future Directions</title> |