path: root/docs
diff options
authorYann E. MORIN" <>2007-07-02 19:40:54 (GMT)
committerYann E. MORIN" <>2007-07-02 19:40:54 (GMT)
commit9265403b8bfd3c1f20f81a52a3f2c6f7711dffb5 (patch)
treea1191f479d39cf9db1858fa4ebaee6c9aac68601 /docs
parent928ccb1f4172c14c01991ca64783c8ac0aeecbaf (diff)
Get rid of eclipse fiels once and for all.
Homogenise the references to crosstool-NG: - the project is named "crosstool-NG" - the front-end is named "ct-ng" - don't use shortcuts (such as "ct-ng" to stand for "crosstool-NG") Default action is to print help. Don't speak of make rules when dumping help, just speak of actions.
Diffstat (limited to 'docs')
2 files changed, 30 insertions, 33 deletions
diff --git a/docs/ b/docs/
index ac033dc..fdf51e2 100644
--- a/docs/
+++ b/docs/
@@ -1,15 +1,15 @@
-." crosstool-ng man page
+." crosstool-NG man page
." Copyright 2007 Yann E. MORIN
." Licensed under the Creative Commons BY-SA, v2.5
." Beautifying URLs
.mso www.tmac
-.TH ct-ng 1 "@@CT_DATE@@" "version @@CT_VERSION@@" "User Commands"
+.TH crosstool-NG 1 "@@CT_DATE@@" "version @@CT_VERSION@@" "User Commands"
-ct-ng, crosstool-ng \- Build cross-toolchains
+ct-ng, crosstool-NG \- Build cross-toolchains
@@ -19,7 +19,7 @@ ct-ng, crosstool-ng \- Build cross-toolchains
Building a cross-toolchain can be a real pain.
-.B ct-ng
+.B crosstool-NG
makes it easy to build cross-toolchains, and allows you to take all the juice
out of your target by configuring the differents components of the toolchain
accordingly to the targeted processor.
@@ -35,7 +35,7 @@ Prints a little help text.
.B menuconfig
-.B ct-ng
+.B crosstool-NG
using a configurator menu very similar to that of the Linux kernel.
@@ -47,7 +47,7 @@ file, and ask for newer options if there are any.
.B saveconfig
Save the current
-.B ct-ng
+.B crosstool-NG
configuration, and associated components' config files, into a sample. Samples
are saved in their own sub-directory, named after the target's triplet, in the
.I samples
@@ -61,11 +61,7 @@ with the target triplet they represent.
.B build
-Builds the configured toolchain. If
-.B ct-ng
-is called without action, then
-.B build
-is impiled.
+Builds the configured toolchain.
.B liststeps
@@ -76,7 +72,7 @@ below).
.B clean
Remove files generated by
-.B ct-ng
+.B crosstool-NG
for itself (these are mostly the configurators' binaries).
@@ -91,7 +87,7 @@ samples which are not removed.
.B regtest
Calls the
-.B ct-ng
+.B crosstool-NG
regression test suite. All samples are build, and the regression test suite is
run against every one of them.
@@ -102,12 +98,12 @@ Updates the
.I config.sub
scripts. These scripts are used by
-.B ct-ng
+.B crosstool-NG
to canonicalise the machines' name (host, build and target machines).
.B tarball
Builds a tarball of the generated toolchain, also saving the scripts from
-.B ct-ng
+.B crosstool-NG
that are needed to rebuild the target, and also saving the tarballs of the
componnents that were used.
@@ -132,27 +128,27 @@ to have the meaning of the exit values.
As of today (@@CT_DATE@@), building tarballs is broken. It is difficult to
foresee how every parts of
-.B ct-ng
+.B crosstool-NG
are going to be installed. Each parts is needed to build a tarball, as it
contains all that is needed to rebuild the toolchain from scratch: toolchain
components' sources,
-.B ct-ng
+.B crosstool-NG
configuration, but also all
-.B ct-ng
+.B crosstool-NG
.B Don't run as root!
Great care has been taken to avoid mistakes, but bug-free programs don't
exist. During normal operation,
-.B ct-ng
+.B crosstool-NG
removes entire directories. If you run as root, and there is a bug or you
-.BR ct-ng ,
+.BR crosstool-NG ,
entire important directories could be removed (eg.
.IR /usr ),
-.B ct-ng
+.B crosstool-NG
will refuse to install in some well known critical directories.
diff --git a/docs/overview.txt b/docs/overview.txt
index e62a44d..b7ec27d 100644
--- a/docs/overview.txt
+++ b/docs/overview.txt
@@ -1,5 +1,5 @@
File.........: overview.txt
-Content......: Overview of how ct-ng works.
+Content......: Overview of how crosstool-NG works.
Copyrigth....: (C) 2007 Yann E. MORIN <>
License......: Creative Commons Attribution Share Alike (CC-by-sa), v2.5
@@ -38,7 +38,7 @@ On the other side, these toolchain offer some advantages:
- they are proven if used by a wide community.
But once you want to get all the juice out of your specific hardware, you will
-want to build your own toolchain. This is where crosstool-ng comes into play.
+want to build your own toolchain. This is where crosstool-NG comes into play.
There are also a number of tools that builds toolchains for specific needs,
which is not really scalable. Examples are:
@@ -80,9 +80,9 @@ in place, and add appropriate support for what I needed, that is uClibc
The only option left to me was rewrite crosstool from scratch. I decided to go
-this way, and name the new implementation ct-ng, standing for crosstool Next
-Generation, as many other comunity projects do, and as a wink at the TV series
-"Star Trek: The Next Generation". ;-)
+this way, and name the new implementation crosstool-NG, standing for crosstool
+Next Generation, as many other comunity projects do, and as a wink at the TV
+series "Star Trek: The Next Generation". ;-)
@@ -126,7 +126,7 @@ Interesting config options |
If you already have sone tarballs in a direcotry, enter it here. That will
- speed up the retrieving phase, where crosstool-ng would otherwise download
+ speed up the retrieving phase, where crosstool-NG would otherwise download
those tarballs.
@@ -148,7 +148,7 @@ ________________________
Running crosstool-NG /
-ct-ng is configured by a configurator presenting a menu-stuctured set of
+crosstool-NG is configured by a configurator presenting a menu-stuctured set of
options. These options let you specify the way you want your toolchain built,
where you want it installed, what architecture and specific processor it
will support, the version of the components you want to use, etc... The
@@ -235,29 +235,30 @@ this as "2 and 2 are 4". Here is how they come into play:
one it is built on, and running again on this exact same machine. You have
to build such a toolchain when you want to use an updated component, such
as a newer gcc for example.
- ct-ng calls it "native".
+ crosstool-NG calls it "native".
2) build == host != target
This is a classic cross-toolchain, which is expected to be run on the same
machine it is compiled on, and generate code to run on a second machine,
the target.
- ct-ng calls it "cross".
+ crosstool-NG calls it "cross".
3) build != host == target
Such a toolchain is also a native toolchain, as it targets the same machine
as it runs on. But it is build on another machine. You want such a
toolchain when porting to a new architecture, or if the build machine is
much faster than the host machine.
- ct-ng calls it "cross-native".
+ crosstool-NG calls it "cross-native".
4) build != host != target
This one is called a canadian-toolchain (*), and is tricky. The three
machines in play are different. You might want such a toolchain if you
have a fast build machine, but the users will use it on another machine,
and will produce code to run on a third machine.
- ct-ng calls it "canadian".
+ crosstool-NG calls it "canadian".
-ct-ng can build all these kinds of toolchains (or is aiming at it, anyway!)
+crosstool-NG can build all these kinds of toolchains (or is aiming at it,
(*) The term Canadian Cross came about because at the time that these issues
were all being hashed out, Canada had three national political parties.