Subversion Repositories crisos/svn

Rev

Rev 109 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 109 Rev 132
Line 1... Line 1...
1
Welcome to CrisOs DarwinFox building system
1
Welcome to CrisOs DarwinFox building system
2
*************************************************
2
*************************************************
3
				http://crisos.org
3
				http://crisos.org
4
4
5
5
6
1. Introduction
-
 
7
2. OpenWrt and patches
-
 
8
3. Bulding system
-
 
9
4. Patch system
-
 
10
5. Typical use
-
 
11
6. Contibute
-
 
-
 
6
1. Introduction - What is it CrisOs?
-
 
7
2. Bulding system
-
 
8
3. Patch system
-
 
9
4. Typical usage
-
 
10
5. Contibute
12
11
13
1. Introduction
-
 
-
 
12
1. Introduction - What is it CrisOs?
14
-------------------
13
-------------------
15
Some time ago I start to work within this strange project, CrisOs just for fun,
-
 
16
during the mouths I release some different version of CrisOs.
-
 
17
Originally this system was based on an old release of openwrt with some fix 
-
 
18
called alpha release, now this approach is useless and cannot be followed for 
-
 
19
the latest CrisOs release Darwinfox, let me explain because.
-
 
-
 
14
CrisOs isn't an OpenWrt fork! 
-
 
15
This project help us to keep a stable building enviroment over OpenWrt
-
 
16
changes, personalize the  firmware and integrate some dirty workaround.
20
17
21
2. OpenWrt and patches
-
 
-
 
18
2. Building system
22
-------------------
19
-------------------
23
Most of the works done on CrisOs has been upstreamed to OpenWrt community using 
-
 
24
patches.
-
 
25
This building systems allow me to dynamically publish the related patches for the 
-
 
26
latest openwrt version.
-
 
27
BUT there are a lot of side effect on this approach, READ ALL THIS DOCUMENT!
-
 
28
-
 
29
3. Bulding system
-
 
30
-------------------
-
 
31
The OpenWrt system is well documented under openwrt/doc and will not addressed
-
 
32
in this readme.
-
 
-
 
20
The OpenWrt system is well documented under openwrt/doc and will not 
-
 
21
addressed in this readme.
33
The darwinfox system have this directory layout:
22
The darwinfox system have this directory layout:
34
darwinfox
23
darwinfox
35
    |--- helper		- this dir contain some script
24
    |--- helper		- this dir contain some script
36
    |--- openwrt	- contain the latest openwrt version
-
 
37
    \--- patches	- contain crisos patches
-
 
-
 
25
    |--- openwrt	- contains the latest openwrt version
-
 
26
    \--- patches	- contains crisos patches
38
    
27
    
39
28
40
The darwinfox building system introduce some aliases and a simple patches manager.
-
 
-
 
29
The darwinfox building system introduce some aliases and a simple patches 
-
 
30
manager.
-
 
31
The building system command are:
-
 
32
	svn update  - Update the crisos enviroment
-
 
33
	make patch - Apply crisos changes to openwrt
-
 
34
	make revert - Disapply ALL openwrt changes, this include crisos 
-
 
35
		patches and your own change!!
-
 
36
	make update - Update the openwrt version. 
-
 
37
		BEWARE: To prevent conflict during update make revert is 
-
 
38
		previously called.
-
 
39
	
-
 
40
Other useful target are:
-
 
41
	make install_feed - Install all openwrt ported programs from feeds
-
 
42
		(See also How to add crisos feed)
41
43
42
Aliases:
-
 
43
make update	- this update the openwrt checkout ONLY
-
 
44
make menuconfig	- alias of make -C openwrt/ menuconfig
-
 
45
make verbose	- alias make -C openwrt/ V=99
-
 
46
-
 
47
4. Patch system
-
 
-
 
44
3. Patch system
48
-----------------
45
-----------------
49
At the moment the patch system is very, VERY stupid!
-
 
50
Typing 'make patch' the patches files under patches/ are applied to openwrt/
-
 
51
**BEWARE**
-
 
52
To prevent possible error due to previously applied patches ALL the change 
-
 
53
inside openwrt/ are reverted before applying patches!
-
 
-
 
46
As discussed in 2  using 'make patch' all files under patches/ are 
-
 
47
applied to openwrt/
-
 
48
-
 
49
BEWARE: To prevent possible error due to previously applied patches ALL 
-
 
50
the changes 
-
 
51
	inside openwrt/ are reverted before applying patches!
54
52
55
For save your change BEFORE patch the openwrt with new set of patches save 
53
For save your change BEFORE patch the openwrt with new set of patches save 
56
your change as follows:
54
your change as follows:
57
55
58
1) enter the openwrt directory
56
1) enter the openwrt directory
Line 63... Line 61...
63
	<num> is a three digit number used for sort the patches
61
	<num> is a three digit number used for sort the patches
64
	<name> is a descriptive name
62
	<name> is a descriptive name
65
63
66
Use this method for save your change!
64
Use this method for save your change!
67
65
68
For update the patches simple use 'svn up'.
-
 
69
-
 
70
5. Typical use
-
 
-
 
66
4. Typical use
71
-----------------
67
-----------------
72
Typically you should follow this steps:
68
Typically you should follow this steps:
73
69
74
 * svn co svn://svn.tuxfamily.org/svnroot/crisos/svn/target/darwinfox
70
 * svn co svn://svn.tuxfamily.org/svnroot/crisos/svn/target/darwinfox
75
 * cd darwinfox
71
 * cd darwinfox
76
 * make patch <-- this apply the patches with crisos configuration
72
 * make patch <-- this apply the patches with crisos configuration
77
 * make mcm <-- ONLY IF YOU HAVE A MCM FOXBOARD
73
 * make mcm <-- ONLY IF YOU HAVE A MCM FOXBOARD
78
 * make menuconfig <-- choice wanted apps
-
 
-
 
74
 * make menuconfig <-- choice Foxboard and wanted apps
79
 * make (good luck :p )
75
 * make (good luck :p )
80
 * make flash <-- flash your fox trough eth0 interface
76
 * make flash <-- flash your fox trough eth0 interface
81
-
 
82
NOTE! After __any__ svn up you should re-run make patch and above.
-
 
83
77
84
6. Contribute
78
6. Contribute
85
-----------------
79
-----------------
86
Any kind of support is welcome!
80
Any kind of support is welcome!
87
81
88
If you discover a bug or do you like to contribute to CrisOs please join mailing 
-
 
89
list, report issue on bug system http://crisos.org/flyspray/ or directly write 
-
 
90
to info@crisos.org.
-
 
-
 
82
If you discover a bug or do you  like to contribute to  CrisOs please join 
-
 
83
mailing list, use IRC channel #crisos@freenode, report issue on bug system
-
 
84
http://crisos.org/flyspray/ and shares your patches.
91
85