Annotate the locale schema to help developers understanding what is stored in some of the far from obvious fields. Patch by myself.

1 files changed, 20 insertions, 0 deletions

diff --git a/modules/locale/locale.schema b/modules/locale/locale.schema
index 6973aeead..3b60c8150 100644
--- a/modules/locale/locale.schema
+++ b/modules/locale/locale.schema
@@ -4,16 +4,27 @@
 function locale_schema() {
   $schema['languages'] = array(
     'fields' => array(
+      // Language code, eg 'de' or 'en-US'.
       'language'   => array('type' => 'varchar', 'length' => 12, 'not null' => TRUE, 'default' => ''),
+      // Language name in English.
       'name'       => array('type' => 'varchar', 'length' => 64, 'not null' => TRUE, 'default' => ''),
+      // Native language name.
       'native'     => array('type' => 'varchar', 'length' => 64, 'not null' => TRUE, 'default' => ''),
+      // LANGUAGE_RTL or LANGUAGE_LTR
       'direction'  => array('type' => 'int', 'not null' => TRUE, 'default' => 0),
+      // Enabled flag.
       'enabled'    => array('type' => 'int', 'not null' => TRUE, 'default' => 0),
+      // Number of plural indexes in this language.
       'plurals'    => array('type' => 'int', 'not null' => TRUE, 'default' => 0),
+      // Plural formula in PHP code to evaluate to get plural indexes.
       'formula'    => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''),
+      // Domain to use for this language.
       'domain'     => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''),
+      // Path prefix to use for this language.
       'prefix'     => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''),
+      // Weight, used in lists of languages.
       'weight'     => array('type' => 'int', 'not null' => TRUE, 'default' => 0),
+      // Location of JavaScript translation file.
       'javascript' => array('type' => 'varchar', 'length' => 32, 'not null' => TRUE, 'default' => ''),
     ),
     'primary key' => array('language'),
@@ -21,9 +32,13 @@ function locale_schema() {
 
   $schema['locales_source'] = array(
     'fields' => array(
+      // Unique indentifier of this string.
       'lid'       => array('type' => 'serial', 'not null' => TRUE),
+      // Drupal path in case of online discovered translations or file path in case of imported strings.
       'location'  => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''),
+      // A module defined group of translations, see hook_locale().
       'textgroup' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE, 'default' => ''),
+      // The original string in English.
       'source'    => array('type' => 'text', 'mysql_type' => 'blob', 'not null' => TRUE),
     ),
     'primary key' => array('lid'),
@@ -33,10 +48,15 @@ function locale_schema() {
 
   $schema['locales_target'] = array(
     'fields' => array(
+      // References locales_source.
       'lid'         => array('type' => 'int', 'not null' => TRUE, 'default' => 0),
+      // Translation string value in this language.
       'translation' => array('type' => 'text', 'mysql_type' => 'blob', 'not null' => TRUE),
+      // Language code referencing the languages table.
       'language'    => array('type' => 'varchar', 'length' => 12, 'not null' => TRUE, 'default' => ''),
+      // Parent lid (lid of the singular form) in case of plural strings.
       'plid'        => array('type' => 'int', 'not null' => TRUE, 'default' => 0),
+      // Plural index number in case of plural strings.
       'plural'      => array('type' => 'int', 'not null' => TRUE, 'default' => 0)
     ),
     'indexes' => array(