croc/vendor/golang.org/x/text
Zack Scholl 0b9eaa1e1e Vendoring 2017-10-17 18:58:16 -06:00
..
cases Vendoring 2017-10-17 18:58:16 -06:00
cmd/gotext Vendoring 2017-10-17 18:58:16 -06:00
collate Vendoring 2017-10-17 18:58:16 -06:00
currency Vendoring 2017-10-17 18:58:16 -06:00
encoding Vendoring 2017-10-17 18:58:16 -06:00
feature/plural Vendoring 2017-10-17 18:58:16 -06:00
internal Vendoring 2017-10-17 18:58:16 -06:00
language Vendoring 2017-10-17 18:58:16 -06:00
message Vendoring 2017-10-17 18:58:16 -06:00
number Vendoring 2017-10-17 18:58:16 -06:00
runes Vendoring 2017-10-17 18:58:16 -06:00
search Vendoring 2017-10-17 18:58:16 -06:00
secure Vendoring 2017-10-17 18:58:16 -06:00
transform Vendoring 2017-10-17 18:58:16 -06:00
unicode Vendoring 2017-10-17 18:58:16 -06:00
width Vendoring 2017-10-17 18:58:16 -06:00
.gitattributes Vendoring 2017-10-17 18:58:16 -06:00
.gitignore Vendoring 2017-10-17 18:58:16 -06:00
AUTHORS Vendoring 2017-10-17 18:58:16 -06:00
CONTRIBUTING.md Vendoring 2017-10-17 18:58:16 -06:00
CONTRIBUTORS Vendoring 2017-10-17 18:58:16 -06:00
LICENSE Vendoring 2017-10-17 18:58:16 -06:00
PATENTS Vendoring 2017-10-17 18:58:16 -06:00
README.md Vendoring 2017-10-17 18:58:16 -06:00
codereview.cfg Vendoring 2017-10-17 18:58:16 -06:00
doc.go Vendoring 2017-10-17 18:58:16 -06:00
gen.go Vendoring 2017-10-17 18:58:16 -06:00

README.md

Go Text

This repository holds supplementary Go libraries for text processing, many involving Unicode.

Semantic Versioning

This repo uses Semantic versioning (http://semver.org/), so

  1. MAJOR version when you make incompatible API changes,
  2. MINOR version when you add functionality in a backwards-compatible manner, and
  3. PATCH version when you make backwards-compatible bug fixes.

A Unicode major and minor version bump is mapped to a major version bump in x/text. A path version bump in Unicode is mapped to a minor version bump in x/text. Note that, consistent with the definitions in semver, until version 1.0.0 of x/text is reached, the minor version is considered a major version. So going from 0.1.0 to 0.2.0 is considered to be a major version bump.

A major new CLDR version is mapped to a minor version increase in x/text. Any other new CLDR version is mapped to a patch version increase in x/text.

Download/Install

The easiest way to install is to run go get -u golang.org/x/text. You can also manually git clone the repository to $GOPATH/src/golang.org/x/text.

Contribute

To submit changes to this repository, see http://golang.org/doc/contribute.html.

To generate the tables in this repository (except for the encoding tables), run go generate from this directory. By default tables are generated for the Unicode version in core and the CLDR version defined in golang.org/x/text/unicode/cldr.

Running go generate will as a side effect create a DATA subdirectory in this directory, which holds all files that are used as a source for generating the tables. This directory will also serve as a cache.

Testing

Run

go test ./...

from this directory to run all tests. Add the "-tags icu" flag to also run ICU conformance tests (if available). This requires that you have the correct ICU version installed on your system.

TODO:

  • updating unversioned source files.

Generating Tables

To generate the tables in this repository (except for the encoding tables), run go generate from this directory. By default tables are generated for the Unicode version in core and the CLDR version defined in golang.org/x/text/unicode/cldr.

Running go generate will as a side effect create a DATA subdirectory in this directory which holds all files that are used as a source for generating the tables. This directory will also serve as a cache.

Versions

To update a Unicode version run

UNICODE_VERSION=x.x.x go generate

where x.x.x must correspond to a directory in http://www.unicode.org/Public/. If this version is newer than the version in core it will also update the relevant packages there. The idna package in x/net will always be updated.

To update a CLDR version run

CLDR_VERSION=version go generate

where version must correspond to a directory in http://www.unicode.org/Public/cldr/.

Note that the code gets adapted over time to changes in the data and that backwards compatibility is not maintained. So updating to a different version may not work.

The files in DATA/{iana|icu|w3|whatwg} are currently not versioned.

Report Issues / Send Patches

This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.

The main issue tracker for the image repository is located at https://github.com/golang/go/issues. Prefix your issue with "x/image:" in the subject line, so it is easy to find.