docs/overview.txt
changeset 1581 f8143840971d
parent 1580 2b43f4952b53
child 1643 19205498184e
     1.1 --- a/docs/overview.txt	Mon Oct 12 19:25:41 2009 +0200
     1.2 +++ b/docs/overview.txt	Mon Oct 12 19:31:50 2009 +0200
     1.3 @@ -11,6 +11,7 @@
     1.4  
     1.5  Introduction
     1.6  History
     1.7 +Referring to crosstool-NG
     1.8  Installing crosstool-NG
     1.9    Install method
    1.10    The hacker's way
    1.11 @@ -117,6 +118,41 @@
    1.12  made it available to the community, in case it was of interest to any one.
    1.13  
    1.14  
    1.15 +_____________________________
    1.16 +                            /
    1.17 +Referring to crosstool-NG  /
    1.18 +__________________________/
    1.19 +
    1.20 +
    1.21 +The long name of the project is crosstool-NG:
    1.22 +  * no leading uppercase (except as first word in a sentence)
    1.23 +  * crosstool and NG separated with a hyphen (dash)
    1.24 +  * NG in uppercase
    1.25 +
    1.26 +Crosstool-NG can also be referred to by its short name CT-NG:
    1.27 +  * all in uppercase
    1.28 +  * CT and NG separated with a hyphen (dash)
    1.29 +
    1.30 +The long name is preferred over the short name, except in mail subjects, where
    1.31 +the short name is a better fit.
    1.32 +
    1.33 +When referring to a specific version of crosstool-NG, append the version number
    1.34 +either as:
    1.35 +  * crosstool-NG X.Y.Z
    1.36 +    - the long name, a space, and the version string
    1.37 +  * crosstool-ng-X.Y.Z
    1.38 +    - the long name in lowercase, a hyphen (dash), and the version string
    1.39 +    - this is used to name the release tarballs
    1.40 +  * crosstool-ng-X.Y.Z+hg_id
    1.41 +    - the long name in lowercase, a hyphen, the version string, and the Hg id
    1.42 +      (as returned by: ct-ng version)
    1.43 +    - this is used to differentiate between releases and snapshots
    1.44 +
    1.45 +The frontend to crosstool-NG is the command ct-ng:
    1.46 +  * all in lowercase
    1.47 +  * ct and ng separated by a hyphen (dash)
    1.48 +
    1.49 +
    1.50  ___________________________
    1.51                            /
    1.52  Installing crosstool-NG  /