Merge branch 'upstream-fixes'
[mw/micromonitor-lm32.git] / README
1 Welcome to MicroMonitor!
2
3
4 This is the top-level of the MicroMonitor CVS.
5
6 There are three main directories:
7 umon_main:
8   This is the common code reusable on various targets as the core
9   of MicroMonitor's functionality.
10 umon_ports:
11   This directory contains the public ports of MicroMonitor.  Each
12   subdirectory contains the makefile and target-specific code for
13   one uMon port.
14 umon_apps:
15   This code provides a few different application examples for use
16   after the bootmonitor is built and running on your target.  The
17   best place to go there is umon_apps/demo.  This directory contains
18   the source and makefile that support building a basic application
19   for any target supported by MicroMonitor.  
20
21 To get started, refer to umon_main/README.
22
23
24 ######################
25 #
26 # SVN User Notes:
27 #
28 As of release 1.17 the uMon tree is under SVN (instead of CVS).
29 To diff a file ignoring whitespace...
30         svn diff --diff-cmd diff -x -uw filename
31
32 To retrieve the current revision...
33         svn info -r HEAD
34
35 To review recent changes...
36         svn log -vr 2186:2100   (range may vary)
37
38 To diff a file relative to the HEAD, run...
39         svn diff -r HEAD filename
40
41 To create a new uMon release...
42         1 Retrieve a "fresh" tree from SVN so that we don't miss a file
43           that may be in the local directory, but not committed.
44         2 Run 'make rebuild 2>&1 | tee make.out' under umon_ports and
45           verify that the build was clean.
46         3 Update common/version.h
47         4 When committing the verion.h file, note the SVN release and
48           make a note of it at the bottom of this file.  Then commit this
49           file.  
50         5 Copy the umon tree to umon-X.YY, then remove all .svn and
51           .subversion directories.  Run 'make clobber' under umon_ports
52           and umon_main/host.
53         6 Create new tarball.
54
55 If these instructions are followed, then in theory, this file will be
56 the last committed file in the release; hence the Revision of this file
57 (keyword below) can be used as the release point of reference...
58
59 Revision: $Revision: 2387 $
60
61 ######################
62 #
63 # SVN Revision-to-uMon release...
64 #
65 uMon1.17: Committed revision 1924 (Mar 13, 2009).
66 uMon1.18: Committed revision 2386 (Jan 23, 2010).