README
author jenda
Sun, 30 Aug 2009 07:26:31 +0200
changeset 50 b191f935a85f
parent 46 6317236727a7
child 51 5568b29b641c
permissions -rw-r--r--
fix typos in README
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
46
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
     5
This file describes the structure and contains the instructions for
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
     6
downloading and building the G11n Locale workspace for OpenSolaris.
33
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
46
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    12
This workspace is a part of G11n Common Workspace (CWS). Along with other parts
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    13
it allows to build all OpenSolaris.org G11n packages. See build instructions at:
50
b191f935a85f fix typos in README
jenda
parents: 46
diff changeset
    14
  http://www.opensolaris.org/os/project/nv-g11n/documents/building/
33
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    15
46
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    16
The workspace allows to compile OpenSolaris locale data objects (locales) based
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    17
on the CLDR data (http://cldr.unicode.org/). This workspace does not contain the
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    18
upstream sources and tools. The sources are downloaded during the build process,
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    19
so internet access is required to build the workspace.
33
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, 
46
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    28
			'make clean' does not clean this directory
33
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    29
./jars/			all jars necessary to build the locale data,
46
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    30
			some are built from upstream
45
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    31
./locales/*.spec	locale spec files (see 'Locale Spec File Structure' section)
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    32
./locales/charmap/	charmap files are generated there
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    33
./locales/src/		posix src files are generated there
33
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
45
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    43
Locale Specification File Structure
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    44
-----------------------------------
33
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    45
46
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    46
Locale is described by files locale/*.spec. The files are named:
45
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    47
	locales/xx_YY.eee[@variant].spec
33
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    48
46
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    49
Format of the files is:
33
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
46
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    53
If a key is missing default value is used. The default value is perfect for
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    54
most of the locales, so for ordinary locales the file is empty.
45
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    55
33
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    56
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    57
Keys:
45
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    58
	pkg_name	pkg name for the locale
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    59
			default: 'lang-xx'
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    60
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    61
	cldr_variant	cldr locale variant, see XXX for description
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    62
			default: 'xx_YY@platform=solaris,yesno=solaris,copy_ctype=locales/src/eee.charmap'
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    63
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    64
	locale_desc	locale description (/usr/lib/locales/<loc>/locale_description file)
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    65
			default: 'Language, Country (Encoding)'
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    66
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    67
	prototype	pkg prototype 
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    68
			default: misc/prototype.default
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    69
	
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    70
	locale_map	locale_map (/usr/lib/locale/<loc>/locale_mask file)
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    71
			default: misc/locale_map.default
33
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    72
148cd47161cf add README, fix minor bugs in makefiles
jenda
parents:
diff changeset
    73
46
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    74
Build Instructions
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    75
------------------
45
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    76
46
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    77
The following build instructions are for OpenSolaris 2009.06 (and later).
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    78
Building on older versions of Solaris/OpenSolaris is possible, but there
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    79
would be difference in installation of the build tools.
6317236727a7 fix some minor bugs
jenda
parents: 45
diff changeset
    80
45
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    81
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    82
Prepare the build environment:
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    83
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    84
 $ pfexec pkg install SUNWmercurial SUNWgmake SUNWant sunstudio
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    85
 $ # 'pfexec svccfg -s application/pkg/server setprop pkg/port=10000' 
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    86
 $ # 	or 'export PKG_REPO=http://localhost:80'
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    87
 $ # pfexec svccfg -s application/pkg/server setprop pkg/inst_root=/export/home/jl149544/repository2
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    88
 $ pfexec svcadm refresh application/pkg/server
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    89
 $ pfexec svcadm restart pkg/server
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    90
50
b191f935a85f fix typos in README
jenda
parents: 46
diff changeset
    91
 $ hg clone ssh://[email protected]/hg/nv-g11n/locale g11n-locale
45
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    92
 $ cd g11n-locale
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    93
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    94
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    95
Build the workspace:
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    96
 
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    97
 $ gmake 
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    98
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
    99
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
   100
Test the pkgs:
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
   101
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
   102
 $ gmake ips
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
   103
 $ pfexec pkg install SUNWlang-xx
2d5bffd4fb27 update README, fix CDDL headers
jenda
parents: 33
diff changeset
   104