Turn headings into actual links
[openafs-wiki.git] / CodeArchitecture.mdwn
1
2 This is an entry point into the code architecture. As always, the source for your release is the authoritative reference, but this wiki is designed to help navigate the source and point out relevant documentation.
3
4 -- Starting Point --
5
6 - Early architectural documents are in the source tree at openafs/doc/pdf. They are out of date, but still important. You should especially read the Architectural Overview document (archov-doc.pdf)
7 - To understand the source layout, consult src/SOURCE-MAP -- this is a good place to go after reading the Architectural Overview
8 - Need to document the build environment issues -- README, README.DEVEL, README.CVS
9 - src/BUILDNOTES (at least in the 1.4 tree) is not very helpful
10
11 -- Source Browsing --
12
13 - The source tree has been converted to git - see [[GitDevelopers]] for how to access it. 
14 - If you must use CVS, see [[OpenAFSCVS]]
15
16 But in that tree, README.CVS has the following line:
17
18 Do not use the CVS tree unless you know what you're doing.
19
20 This document helps you learn what you're doing.
21
22 - cvs co, regen.sh (& when to run regen.sh)
23 ----
24
25 In the source itself ---
26
27 - **find | grep** is very helpful. For example, to find all the RX packages (ie, so that you can start to identify the various namespaces of components), you can do:
28
29     find . -name \*.xg -exec grep -H "^package" {} \; | grep -v 'example' | grep -v 'bulktest' | \
30       sed -e 's|^./src/||' | sed -e 's/package/ /' | awk '{printf "%10s   %s\n", $2, $1}'
31
32 which results in:
33
34         VOTE_   ubik/ubik_int.xg:
35          DISK_   ubik/ubik_int.xg:
36        SAMPLE_   ubik/utst_int.xg:
37            VL_   vlserver/vldbint.xg:
38        UPDATE_   update/update.xg:
39          TEST_   rxgk/test.xg:
40          RXGK_   rxgk/rxgk_proto.xg:
41       RXAFSCB_   fsint/afscbint.xg:
42         RXAFS_   fsint/afsint.xg:
43       RXSTATS_   rxstat/rxstat.xg:
44            PR_   ptserver/ptint.xg:
45          BOZO_   bozo/bosint.xg:
46         BUMON_   bubasics/backmon.xg:
47            TC_   bubasics/butc.xg:
48            BC_   bubasics/bumon.xg:
49           ADK_   dauth/adkint.xg:
50        RMTSYS_   sys/rmtsys.xg:
51         AFSVol   volser/volint.xg:
52
53 In other words, if something starts with BOZO\_, you know that it is generated by rxgen, and the interface is defined in `bozo/bosint.xg`.
54
55 In addition to the package name, also note that only rxstat uses an M prefix; all others use S.
56
57 - Assuming you have a fairly modern grep, you can use its recursive facility:
58
59   $ **grep -r regex .**
60
61 and find every time *pattern* appears in a file
62
63 - If you're looking for one specific word, the <tt>-w</tt> switch is your friend as well.
64
65   $ **egrep -w -r VFORMAT .**
66
67 will find all instances of **VFORMAT** but will not find **ABVFORMAT**
68
69 - cscope: a source code browser, linked to your editor. Setup is simple: cd to your source tree and run:
70
71     $ **cscope -R -b**
72
73 Then run
74
75     $ **cscope -d**
76
77 to start. The interface is simple. I tend to use it for finding things, but not necessarily for editing. When I'm studying the source, trying to understand how components link together, or bug-hunting, I tend to live inside `cscope`.
78
79 - doxygen: what it is, how to set up, how to use, how to make even more useful (ie, src code changes)
80
81 - gdb: examples of using (primarily b, bt)