]> err.no Git - sope/blob - sope-ldap/README-OSX.txt
some code cleanups
[sope] / sope-ldap / README-OSX.txt
1 Building Notes
2 ==============
3
4 Prerequisites:
5 - Apple Developer Tools
6 - sope-xml
7 - sope-core
8
9 There are two ways to build SOPE on MacOSX, either using the gnustep-make
10 package or as native Xcode projects. The first option is usually used when
11 you build SOPE for use with OGo, while the latter is more appropriate for
12 SOPE:X applications.
13
14 Building using gstep-make:
15 ==========================
16
17 First install gnustep-make (eg v1.8), then ensure that GNUstep.sh is properly
18 sources. For the build just enter:
19   make -s install
20 or
21   make -s debug=yes install
22 if you build with debug informations.
23
24 Building using Xcode:
25 =====================
26
27 The Xcode build comes in two variants, one for development and the other for
28 deployment.
29
30
31 Development
32 -----------
33 Development usually means you're happily hacking away at your pet
34 projects and sometimes want to update the SOPE frameworks. For this purpose
35 use the "all" target and the accompanied "Development" build style. Later,
36 you can narrow the target down to something more specific. For development we
37 assume the destination for frameworks to be /Library/Frameworks. Once you are
38 done building all the frameworks the loader commands of the frameworks will
39 have that destination path built in. In order to use the frameworks you either
40 have to install them (by copying them manually to their destination) or to
41 prepare symlinks from /Library/Frameworks to the place where the built products
42 are. I usually build everything in a central place (i.e. /Local/BuildArea) and
43 have symlinks from /Library/Frameworks to /Local/BuildArea for each of the
44 products.
45
46
47 Deployment
48 ----------
49 Deployment in our terms means you want to copy all required SOPE products into
50 an application's app wrapper. For this step all frameworks need to be built in
51 a special fashion, as the "install_name" of the frameworks needs to be prepared
52 to point to a relative path in the app wrapper. The situation is even more
53 complicated as all frameworks during linking store the "install names" of other
54 frameworks in their mach loader commands. In order for this step not to break
55 we need to set up an environment which is clearly separated from the
56 Development environment. I chose to use $(USER_LIBRARY_DIR)/EmbeddedFrameworks
57 as the default destination for these builds. In order for your application to
58 easily pick up the built products and copy them into its app wrapper this
59 location needs to be fixed and easily accessible. Note that on my system
60 ~/Library/EmbeddedFrameworks is a symlink to /Library/EmbeddedFrameworks so
61 even if you don't like the location at all it's very easy to point it to 
62 somewhere else. As soon as you have set this up you can use the
63 "Wrapper Contents" target with the accompanied "Wrapper" build style to build
64 all wrapper contents in the appropriate fashion. When you're done you can copy
65 all the wrapper products into your application's wrapper. The expected
66 destination is the "Frameworks" directory in the wrappers "Contents" directory.
67 For a complete list of what you need to copy into your application's wrapper
68 see the "Direct Dependencies" of all "Wrapper Contents" targets in all SOPE
69 related projects. At the time of this writing the complete list for SOPE
70 consisted of the following:
71
72 sope-ldap
73   NGLdap.framework
74
75
76 Note: "A word on umbrellas"
77       The general idea of umbrellas is to make life easier by providing a cover
78       for linking. In an ideal world we would provide a SOPE umbrella (we 
79       actually do that) and you just link against that and forget about the
80       complete list. However, with the "Wrapper" style things do not work that
81       way. Because the "install name"s of all frameworks are relative paths,
82       during linking the mach dyld cannot find the dependend frameworks
83       (because the path isn't absolute) and thus symbol checking fails. This
84       directly leads to prebinding to fail which we really don't want since we
85       have such a huge dependency tree and prebinding escpecially in our case
86       speeds up loading significantly. So, umbrellas do not really help with
87       "Wrapper" products - in fact they just add to the overall dependency
88       graph without providing any benefit. With the notable exception of the
89       "Development" build style umbrellas are totally useless. If you're
90       not planning to do a "Wrapper" deployment you might be happy to have
91       the umbrellas, however, that's why they are still here.
92
93 Note: You cannot use the -buildAllTargets commandline argument for Xcode,
94       because the Xcode projects also contain a target to build in the
95       gstep-make environment (called GSM:all)
96
97
98 Prebinding Notes
99 ================
100
101 General technical information about prebinding is available from Apple at
102 http://developer.apple.com/documentation/Performance/Conceptual/LaunchTime/Tasks/Prebinding.html#//apple_ref/doc/uid/20001858.
103
104 OGo frameworks currently use the range from 0xC0000000 to 0xCFFFFFFF.
105
106 Any questions and feedback regarding our use of this range should go to
107 Marcus Müller <znek@mulle-kybernetik.com>.
108
109
110 SxCore: 0xC1000000 - 0xC2FFFFFF
111 ===============================
112
113 0xC1C00000 NGLdap