1*0Sstevel@tonic-gateobjects.txt syntax
2*0Sstevel@tonic-gate------------------
3*0Sstevel@tonic-gate
4*0Sstevel@tonic-gateTo cover all the naming hacks that were previously in objects.h needed some
5*0Sstevel@tonic-gatekind of hacks in objects.txt.
6*0Sstevel@tonic-gate
7*0Sstevel@tonic-gateThe basic syntax for adding an object is as follows:
8*0Sstevel@tonic-gate
9*0Sstevel@tonic-gate	1 2 3 4		: shortName	: Long Name
10*0Sstevel@tonic-gate
11*0Sstevel@tonic-gate		If the long name doesn't contain spaces, or no short name
12*0Sstevel@tonic-gate		exists, the long name is used as basis for the base name
13*0Sstevel@tonic-gate		in C.  Otherwise, the short name is used.
14*0Sstevel@tonic-gate
15*0Sstevel@tonic-gate		The base name (let's call it 'base') will then be used to
16*0Sstevel@tonic-gate		create the C macros SN_base, LN_base, NID_base and OBJ_base.
17*0Sstevel@tonic-gate
18*0Sstevel@tonic-gate		Note that if the base name contains spaces, dashes or periods,
19*0Sstevel@tonic-gate		those will be converte to underscore.
20*0Sstevel@tonic-gate
21*0Sstevel@tonic-gateThen there are some extra commands:
22*0Sstevel@tonic-gate
23*0Sstevel@tonic-gate	!Alias foo 1 2 3 4
24*0Sstevel@tonic-gate
25*0Sstevel@tonic-gate		This juts makes a name foo for an OID.  The C macro
26*0Sstevel@tonic-gate		OBJ_foo will be created as a result.
27*0Sstevel@tonic-gate
28*0Sstevel@tonic-gate	!Cname foo
29*0Sstevel@tonic-gate
30*0Sstevel@tonic-gate		This makes sure that the name foo will be used as base name
31*0Sstevel@tonic-gate		in C.
32*0Sstevel@tonic-gate
33*0Sstevel@tonic-gate	!module foo
34*0Sstevel@tonic-gate	1 2 3 4		: shortName	: Long Name
35*0Sstevel@tonic-gate	!global
36*0Sstevel@tonic-gate
37*0Sstevel@tonic-gate		The !module command was meant to define a kind of modularity.
38*0Sstevel@tonic-gate		What it does is to make sure the module name is prepended
39*0Sstevel@tonic-gate		to the base name.  !global turns this off.  This construction
40*0Sstevel@tonic-gate		is not recursive.
41*0Sstevel@tonic-gate
42*0Sstevel@tonic-gateLines starting with # are treated as comments, as well as any line starting
43*0Sstevel@tonic-gatewith ! and not matching the commands above.
44*0Sstevel@tonic-gate
45