]> asedeno.scripts.mit.edu Git - 1ts-debian.git/blob - NOTES
server/kopt.c: in decomp_ticket make sure certain 32 bit values are32 bit
[1ts-debian.git] / NOTES
1 Please observe the following notes when making changes to the source
2 tree.
3
4 The directory h contains header files used internally in the zephyr
5 source tree.  The directory h/zephyr contains header files containing
6 declarations for the Zephyr API.  h/zephyr/zephyr_err.h is generated
7 from lib/zephyr/zephyr_err.et when lib/zephyr is built.
8 h/zephyr/zephyr.h is generated by configure, as is h/config.h.  Those
9 header files live in the build tree.  All other header files in h live
10 in the source tree.
11
12 h/config.h is generated by configure and contains the results of
13 configure tests as well as definitions for the installation
14 configuration directory and data directory.  h/sysdep.h uses
15 h/config.h to include various header files or make various external
16 declarations which many programs might be interested in.  h/internal.h
17 contains declarations internal to the "Zephyr system proper," which
18 includes the Zephyr library, the server, the hostmanager, and (for
19 now) zstat.
20
21 h/zephyr/zephyr.h is a public header file; that is, it is installed
22 with the Zephyr system.  As such, this header file may need to work
23 with compilers other than the compiler used to build the Zephyr system
24 itself.  Thus, we use __STDC__ (both in h/sysdep.h and in zephyr.h) to
25 guess whether the compiler will handle const, prototypes, and stdarg.
26 This is unfortunately not as reliable as using autoconf features like
27 AC_C_CONST.
28
29 The Zephyr system version number is kept in server/version.c, and
30 should be updated when releases are made.
31