doc: add note to anyone who edits list of reserved words
[charm.git] / doc / charm++ / keywords.tex
1 The following words are reserved for the \charm interface translator, and
2 cannot appear as variable or entry method names in a {\tt .ci} file:
3
4 % NOTE:
5 % This list is also duplicated (albeit, not exactly) in /www/codemirror/mode/clike/clike.js
6 % This helps the html version of the charm manual display syntax highlighting correctly.
7 %
8 % Any additions or modifications to this list should also be reflected there.
9 % In that file, it should be sufficient to only list ci keywords that are NOT
10 % already C++ keywords For eg, class and namespace are already cpp reserved
11 % words and need not be included in the list of permitted ci file reserved
12 % words.
13
14 \begin{itemize}
15 \item module
16 \item mainmodule
17 \item chare
18 \item mainchare
19 \item group
20 \item nodegroup
21 \item namespace
22 \item array
23 \item message
24 \item conditional
25 \item extern
26 \item initcall
27 \item initnode
28 \item initproc
29 \item readonly
30 \item PUPable
31 \item pupable
32 \item template
33 \item class
34 \item include
35 \item virtual
36 \item packed
37 \item varsize
38 \item entry
39 \item using
40 \item Entry method attributes
41 \begin{itemize}
42 \item stacksize
43 \item threaded
44 \item migratable
45 \item createhere
46 \item createhome
47 \item sync
48 \item iget
49 \item exclusive
50 \item immediate
51 \item expedited
52 \item inline
53 \item local
54 \item nokeep
55 \item notrace
56 \item python
57 \item accel
58 \item readwrite
59 \item writeonly
60 \item accelblock
61 \item memcritical
62 \item reductiontarget
63 \end{itemize}
64 \item Basic C++ types
65 \begin{itemize}
66 \item int
67 \item short
68 \item long
69 \item char
70 \item float
71 \item double
72 \item unsigned
73 \item void
74 \item const
75 \end{itemize}
76 \item SDAG constructs
77 \begin{itemize}
78 \item atomic
79 \item serial
80 \item forward
81 \item when
82 \item while
83 \item for
84 \item forall
85 \item if
86 \item else
87 \item overlap
88 \item connect
89 \item publishes
90 \end{itemize}
91 \end{itemize}