docs/C - Misc. tutorials.txt
1 File.........: C - Misc. tutorials.txt
2 Copyrigth....: (C) 2010 Yann E. MORIN <yann.morin.1998@anciens.enib.fr>
3 License......: Creative Commons Attribution Share Alike (CC-by-sa), v2.5
10 Using crosstool-NG on FreeBSD (and other *BSD) |
11 -----------------------------------------------+
13 Contributed by: Titus von Boxberg
15 Prerequisites and instructions for using ct-ng for building a cross toolchain on FreeBSD as host.
17 0) Tested on FreeBSD 8.0
19 1) Install (at least) the following ports
30 Of course, you should have /usr/local/bin in your PATH.
32 2) run ct-ng's configure with the following tool configuration:
33 ./configure --with-sed=/usr/local/bin/gsed --with-make=/usr/local/bin/gmake \
34 --with-patch=/usr/local/bin/gpatch
35 [...other configure parameters as you like...]
37 3) proceed as described in general documentation
38 but use gmake instead of make
41 Using crosstool-NG on MacOS-X |
42 ------------------------------+
44 Contributed by: Titus von Boxberg
46 Prerequisites and instructions for using crosstool-NG for building a cross
47 toolchain on MacOS as host.
49 0) Mac OS Snow Leopard, with Developer Tools 3.2 installed, or
50 Mac OS Leopard, with Developer Tools & newer gcc (>= 4.3) installed
53 1) You have to use a case sensitive file system for ct-ng's build and target
54 directories. Use a disk or disk image with a case sensitive fs that you
57 2) Install macports (or similar easy means of installing 3rd party software),
58 make sure that macport's bin dir is in your PATH.
59 Furtheron assuming it is /opt/local/bin.
61 3) Install (at least) the following macports
67 gcc43 (only necessary for Leopard OSX 10.5)
69 On Leopard, make sure that the macport's gcc is called with the default
70 commands (gcc, g++,...), e.g. via macport gcc_select
72 4) run ct-ng's configure with the following tool configuration
73 (assuming you have installed the tools via macports in /opt/local):
74 ./configure --with-sed=/opt/local/bin/gsed \
75 --with-libtool=/opt/local/bin/glibtool \
76 --with-objcopy=/opt/local/bin/gobjcopy \
77 --with-objdump=/opt/local/bin/gobjdump \
78 --with-readelf=/opt/local/bin/greadelf \
79 [...other configure parameters as you like...]
81 5) proceed as described in standard documentation
86 - Apparently, GNU make's builtin variable .LIBPATTERNS is misconfigured
87 under MacOS: It does not include lib%.dylib.
88 This affects build of (at least) gdb-7.1
89 Put 'lib%.a lib%.so lib%.dylib' as .LIBPATTERNS into your environment
90 before executing ct-ng build.
91 See http://www.gnu.org/software/make/manual/html_node/Libraries_002fSearch.html
93 - ct-ng menuconfig will not work on Snow Leopard 10.6.3 since libncurses
94 is broken with this release. MacOS <= 10.6.2 and >= 10.6.4 are ok.
97 Using Mercurial to hack crosstool-NG |
98 -------------------------------------+
100 Contributed by: Titus von Boxberg
104 Configuring Mercurial:
105 You need mercurial with the following extensions:
106 - mq : http://mercurial.selenic.com/wiki/MqExtension
107 - patchbomb : http://mercurial.selenic.com/wiki/PatchbombExtension
108 Usually, these two extensions are already part of the installation package.
109 The mq extension maintains a separate queue of your local changes
110 that you can change at any later time.
111 With the patchbomb extension you can email those patches directly
112 from your local repo.
114 Your configuration file for mercurial, e.g. ~/.hgrc should contain
115 at least the following sections (but have a look at `man hgrc`):
118 # configure sending patches directly via Mercurial
119 from = "Your Name" <your@email.address>
124 # SMTP configuration (only for method=smtp)
131 # The following lines enable the two extensions:
136 Create your local repository as a clone:
137 hg clone http://crosstool-ng.org/hg/crosstool-ng crosstool-ng
139 Setting up the mq extension in your local copy:
146 Recording your changes in the patch queue maintained by mq:
147 # First, create a new patch entry in the patch queue:
148 hg qnew -D -U -e short_patch_name1
149 <edit patch description as commit message (see below for an example)>
151 <now edit the ct-ng sources and check them>
153 # if you execute `hg status` here, your modifications of the working
154 # copy should show up.
156 # Now the following command takes your modifications from the working copy
157 # into the patch entry
159 <reedit patch description [-e] if desired>
161 # Now your changes are recorded, and `hg status` should show a clean
164 Repeat the above steps for all your modifications.
165 The command `hg qseries` informs you about the content of your patch queue.
168 CONTRIBUTING YOUR PATCHES:
170 Once you are satisfied with your patch series, you can (you should!)
171 contribute them back to upstream.
172 This is easily done using the `hg email` command.
174 `hg email` sends your new changesets to a specified list of recipients,
175 each patch in its own email, all ordered in the way you entered them (oldest
176 first). The command line flag --outgoing selects all changesets that are in
177 your local but not yet in the upstream repository. Here, these are exactly
178 the ones you entered into your local patch queue in the section above, so
179 --outgoing is what you want.
181 Each email gets the subject set to: "[PATCH x of n] <series summary>"
182 where 'x' is the serial number in the email series, and 'n' is the total number
183 of patches in the series. The body of the email is the complete patch, plus
184 a handful of metadata, that helps properly apply the patch, keeping the log
185 message, attribution and date, tracking file changes (move, delete, modes...)
187 `hg email` also threads all outgoing patch emails below an introductory
188 message. You should use the introductory message (command line flag --intro)
189 to describe the scope and motivation for the whole patch series. The subject
190 for the introductory message gets set to: "[PATCH 0 of n] <series summary>"
191 and you get the chance to set the <series summary>.
193 Here is a sample `hg email` complete command line:
194 Note: replace " (at) " with "@"
196 hg email --outgoing --intro \
197 --to '"Yann E. MORIN" <yann.morin.1998 (at) anciens.enib.fr>' \
198 --cc 'crossgcc (at) sourceware.org'
200 # It then opens an editor and lets you enter the subject
201 # and the body for the introductory message.
203 Use `hg email` with the additional command line switch -n to
204 first have a look at the email(s) without actually sending them.
207 MAINTAINING YOUR PATCHES:
209 When the patches are refined by discussing them on the mailing list,
210 you may want to finalize and resend them.
212 The mq extension has the idiosyncrasy of imposing a stack onto the queue:
213 You can always reedit/refresh only the patch on top of stack.
214 The queue consists of applied and unapplied patches
215 (if you reached here via the above steps, all of your patches are applied),
216 where the 'stack' consists of the applied patches, and 'top of stack'
217 is the latest applied patch.
219 The following output of `hg qseries` is now used as an example:
220 0 A short_patch_name1
221 1 A short_patch_name2
222 2 A short_patch_name3
223 3 A short_patch_name4
225 You are now able to edit patch 'short_patch_name4' (which is top of stack):
229 <and optionally [-e] reedit the commit message>
231 If you want to edit e.g. patch short_patch_name2, you have to modify
232 mq's stack so this patch gets top of stack.
233 For this purpose see `hg help qgoto`, `hg help qpop`, and `hg help qpush`.
235 hg qgoto short_patch_name2
236 # The patch queue should now look like
238 0 A short_patch_name1
239 1 A short_patch_name2
240 2 U short_patch_name3
241 3 U short_patch_name4
242 # so patch # 1 (short_patch_name2) is top of stack.
243 <now reedit the sources for short_patch_name2>
246 <and optionally [-e] reedit the commit message>
247 # the following command reapplies the now unapplied two patches:
249 # you can also use `hg qgoto short_patch_name4` to get there again.
252 RESENDING YOUR REEDITED PATCHES:
254 By mailing list policy, please resend your complete patch series.
255 --> Go back to section "CONTRIBUTING YOUR PATCHES" and resubmit the full set.
258 SYNCING WITH UPSTREAM AGAIN:
260 You can sync your repo with upstream at any time by executing
261 # first unapply all your patches:
263 # next fetch new changesets from upstream
265 # then update your working copy
267 # optionally remove already upstream integrated patches (see below)
268 hg qdelete <short_name_of_already_applied_patch>
269 # and reapply your patches if any non upstream-integrated left (but see below)
272 Eventually, your patches get included into the upstream repository
273 which you initially cloned.
274 In this case, before executing the hg qpush -a from above
275 you should manually "hg qdelete" the patches that are already integrated upstream.
278 HOW TO FORMAT COMMIT MESSAGES (aka patch desciptions):
280 Commit messages should look like (without leading pipes):
281 |component: short, one-line description
283 |optional longer description
284 |on multiple lines if needed
286 Here is an example commit message (see revision a53a5e1d61db):
287 |comp-libs/cloog: fix building
289 |For CLooG/PPL 0.15.3, the directory name was simply cloog-ppl.
290 |For any later versions, the directory name does have the version, such as