doc: warn about the limited use of identifiers of individual dimensions
authorSven Verdoolaege <skimo@kotnet.org>
Fri, 12 Aug 2011 09:18:37 +0000 (11:18 +0200)
committerSven Verdoolaege <skimo@kotnet.org>
Fri, 12 Aug 2011 09:18:51 +0000 (11:18 +0200)
Signed-off-by: Sven Verdoolaege <skimo@kotnet.org>
doc/user.pod

index 0ace5aa..d7d91d3 100644 (file)
@@ -1409,7 +1409,9 @@ read off using the following functions.
                enum isl_dim_type type, unsigned pos);
 
 These functions are mostly useful to obtain the identifiers, positions
-or names of the parameters.
+or names of the parameters.  Identifiers of individual dimensions are
+essentially only useful for printing.  They are ignored by all other
+operations and may not be preserved across those operations.
 
 =head2 Properties