summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/overview.txt36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/overview.txt b/docs/overview.txt
index 6229a6f..11cd5b2 100644
--- a/docs/overview.txt
+++ b/docs/overview.txt
@@ -11,6 +11,7 @@ _________________/
Introduction
History
+Referring to crosstool-NG
Installing crosstool-NG
Install method
The hacker's way
@@ -117,6 +118,41 @@ and as a wink at the TV series "Star Trek: The Next Generation" ;-) ) and
made it available to the community, in case it was of interest to any one.
+_____________________________
+ /
+Referring to crosstool-NG /
+__________________________/
+
+
+The long name of the project is crosstool-NG:
+ * no leading uppercase (except as first word in a sentence)
+ * crosstool and NG separated with a hyphen (dash)
+ * NG in uppercase
+
+Crosstool-NG can also be referred to by its short name CT-NG:
+ * all in uppercase
+ * CT and NG separated with a hyphen (dash)
+
+The long name is preferred over the short name, except in mail subjects, where
+the short name is a better fit.
+
+When referring to a specific version of crosstool-NG, append the version number
+either as:
+ * crosstool-NG X.Y.Z
+ - the long name, a space, and the version string
+ * crosstool-ng-X.Y.Z
+ - the long name in lowercase, a hyphen (dash), and the version string
+ - this is used to name the release tarballs
+ * crosstool-ng-X.Y.Z+hg_id
+ - the long name in lowercase, a hyphen, the version string, and the Hg id
+ (as returned by: ct-ng version)
+ - this is used to differentiate between releases and snapshots
+
+The frontend to crosstool-NG is the command ct-ng:
+ * all in lowercase
+ * ct and ng separated by a hyphen (dash)
+
+
___________________________
/
Installing crosstool-NG /