README
author jenda
Fri, 28 Aug 2009 21:06:50 +0200
changeset 33 148cd47161cf
child 45 2d5bffd4fb27
permissions -rw-r--r--
add README, fix minor bugs in makefiles
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
     1
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
     2
OPENSOLARIS.ORG G11N LOCALE WORKSPACE
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
     3
=====================================
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
     4
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
     5
This file contains the structure and the instructions for downloading and
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
     6
building the G11n Locale workspace for OpenSolaris.
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
     7
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
     8
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
     9
Description of the Workspace
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    10
----------------------------
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    11
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    12
The workspace is part of Common G11n Workspace (CWS). Together with other parts it 
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    13
allows to build all OpenSolaris.org G11n packages. See build instructions at
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    14
  http://XXX
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    15
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    16
The workspace allow to compile OpenSolaris locale data objects (locales) based
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    17
on CLDR data.  This workspace does not contain the upstream sources and tools,
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    18
the sources are downloaed during the build process so you need internet access
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    19
to build this workspace.
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    20
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    21
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    22
Structure of the Workspace
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    23
--------------------------
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    24
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    25
./Makefile		master makefile
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    26
./config.mk		build configuration
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    27
./downloads/		all data downloaded from internet, 
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    28
			'make clean' does not clean this dir
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    29
./jars/			all jars necessary to build the locale data,
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    30
			some of the jars are builded from upstream
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    31
./locale/*.spec	locale spec files (see 'Locale Spec File Structure' section)
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    32
./locale/charmap/	charmap files are generated there
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    33
./locale/src/		posix src files are generated there
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    34
./misc/			misc files for locale object generation
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    35
./misc/patches/		patches of upstream code
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    36
./misc/patches/cldr_core/	patches of CLDR locale data, 
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    37
			fix known bugs or add solaris specific code
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    38
./misc/patches/cldr_tools/	patches of CLDR tools, 
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    39
			fix known bugs and add solaris specific code
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    40
./tools			tools used for build
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    41
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    42
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    43
Locale Spec File Structure
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    44
--------------------------
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    45
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    46
If you need add a new locale, usually all you need is to createa locale spec file to locale/<locale name>.spec
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    47
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    48
Format of the file is 
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    49
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    50
	# comments ...
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    51
	<key>TAB+<data>
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    52
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    53
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    54
Keys:
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    55
	cldr_variant	cldr locale variant, see XXX for description	(*)
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    56
	pkg_name	pkg name for the locale				(*)
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    57
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    58
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    59
* mandatory keys