[Libreoffice-commits] .: icc/README instsetoo_native/README io/README ios/README jpeg/README languagetool/README libexttextcat/README mdds/README packimages/README postprocess/README psprint_config/README registry/README xmlscript/README xmlsecurity/README

Tue Mar 6 08:30:38 PST 2012

icc/README              |    4 +---
 instsetoo_native/README |    8 ++++++++
 io/README               |    3 ++-
 ios/README              |    1 +
 jpeg/README             |    7 ++++++-
 languagetool/README     |    4 ++++
 libexttextcat/README    |    6 ++++++
 mdds/README             |    3 +++
 packimages/README       |   16 ++++++++++++++++
 postprocess/README      |    5 ++++-
 psprint_config/README   |    6 ++++--
 registry/README         |   14 ++++++++++++++
 xmlscript/README        |    5 +++++
 xmlsecurity/README      |    3 +++
 14 files changed, 77 insertions(+), 8 deletions(-)

New commits:
commit 4f688fd794a7e04a294f0b215889ce076c91823f
Author: Michael Meeks <michael.meeks at suse.com>
Date:   Tue Mar 6 16:28:44 2012 +0000

    more documentation and cleanups for various modules.

diff --git a/icc/README b/icc/README
index 0c1a730..61066f2 100644
--- a/icc/README
+++ b/icc/README
@@ -25,7 +25,7 @@ For information on ICC profiles, you may want to visit:
 
 == Notes for porters ==
 
-Ehe endianess and other platform specific configuration
+The endianess and other platform specific configuration
 are in:
 
 icc/<build>/misc/build/SampleICC-1.3.2/IccProfLib/IccProfLibConf.h
@@ -33,5 +33,3 @@ icc/<build>/misc/build/SampleICC-1.3.2/IccProfLib/IccProfLibConf.h
 The patchs:
 SampleICC-1.3.2.patch tweaks the build to use the endianness
 detected in sal.
-
-beppec56 at openoffice.org
diff --git a/instsetoo_native/README b/instsetoo_native/README
new file mode 100644
index 0000000..0b0f395
--- /dev/null
+++ b/instsetoo_native/README
@@ -0,0 +1,8 @@
+native install-set creation
+
+This is where you will find your natively packaged builds after the
+build has completed. On windows these would live in:
+
+instsetoo_native/wntmsci12.pro/LibreOffice_Dev/native/install/en-US/*.msi
+
+for example (nothing like a few long directory names before breakfast).
\ No newline at end of file
diff --git a/io/README b/io/README
index b721ef4..229153f 100644
--- a/io/README
+++ b/io/README
@@ -1,2 +1,3 @@
-Simple IO wrappers.
+Simple IO wrapper UNO components
+
 
diff --git a/ios/README b/ios/README
new file mode 100644
index 0000000..76a1299
--- /dev/null
+++ b/ios/README
@@ -0,0 +1 @@
+iOS specific code and tests
diff --git a/jpeg/README b/jpeg/README
index edd1c99..a5c3c02 100644
--- a/jpeg/README
+++ b/jpeg/README
@@ -1 +1,6 @@
-Support for jpeg-format. (Which library, where used ???)
+External library for reading/writing jpegs
+
+This is only used by the svtools jpeg import filter that is provided
+for use by VCL see [[svtools/source/filter/jpeg]]
+
+
diff --git a/languagetool/README b/languagetool/README
index 3657ab6..72d7041 100644
--- a/languagetool/README
+++ b/languagetool/README
@@ -1 +1,5 @@
 Style and grammar checker for various languages written in Java, from [http://www.languagetool.org/]
+
+Shipping this is a compile-time option for LibreOffice, but our
+downloadable builds use the light-weight lightproof grammer checker
+instead to avoid the Java bootstrapping performance issues.
\ No newline at end of file
diff --git a/libexttextcat/README b/libexttextcat/README
new file mode 100644
index 0000000..c35b88f
--- /dev/null
+++ b/libexttextcat/README
@@ -0,0 +1,6 @@
+N-Gram-Based Text Categorization library
+
+This guesses the language that input text is written in. Fundamentally
+an adaption of of wiseguys libtextcat extended to be UTF-8 aware.
+
+It is hosted at: [http://cgit.freedesktop.org/libreoffice/libexttextcat/]
diff --git a/mdds/README b/mdds/README
index 22478ad..bd635ee 100644
--- a/mdds/README
+++ b/mdds/README
@@ -1 +1,4 @@
 Multi-dimensional data structure (mdds) library, available from [http://code.google.com/p/multidimalgorithm/].
+
+mdds primarily provides data structures that are used by the calc
+core.
\ No newline at end of file
diff --git a/packimages/README b/packimages/README
new file mode 100644
index 0000000..cf7b96e
--- /dev/null
+++ b/packimages/README
@@ -0,0 +1,16 @@
+Packs used images in sorted order into theme .zip files
+
+The essence of this module is contained within [[solenv/bin/packimages.pl]].
+This script takes several sources of information:
+
+* the list of images used in every .src file that is compiled
+* the configuration XML describing every command that is used
+* [[packimages/pack/iamge-sort.lst]] which provides a profile based
+  ordering of images.
+
+It then tries to pack the images together into the .zip file into an
+order that matches / is similar to that which we want at run-time, ie.
+an entire toolbar's images should (ideally) be next to each other in a
+nice linear run, to reduce LibreOffice's working set, and improve
+startup performance: we require all these images to get paged in on
+start.
diff --git a/postprocess/README b/postprocess/README
index 197d6cb..a295967 100644
--- a/postprocess/README
+++ b/postprocess/README
@@ -1,3 +1,6 @@
 Postprocessing and checking of files delivered by other modules.
 
-This module hast to be the last one before creating install sets in module 'instset_native'.
+This module has to be the last one built before creating install sets
+in module 'instset_native'. Thus it ties together all the dependencies
+of all the other de-coupled modules. See the first line of
+[[postprocess/prj/build.lst]] for that.
diff --git a/psprint_config/README b/psprint_config/README
index 15eb3f1..c39237a 100644
--- a/psprint_config/README
+++ b/psprint_config/README
@@ -1,3 +1,5 @@
-Contains ppds for use by psprint when not using CUPS.
+Contains ppds for use by vcl when not using CUPS
 
-(CH: psprint seems to have been gone ???)
+This is used for the print-to-file functionality. These two PPDs
+describe the range of paper sizes and postscript options necessary for
+printing to postscript without a configured printer.
diff --git a/registry/README b/registry/README
index b455809..914db30 100644
--- a/registry/README
+++ b/registry/README
@@ -1 +1,15 @@
 Registry reading, etc.
+
+This provides tools for dealing with the legacy binary types database
+format, still in use by extensions and the core code. While the actual
+binary file format is implemented by the [[store]] code, the wrapper
+that turns this into a type registry is implemented here.
+
+While this code is primarily used in only two modes:
+
+* linear write / concatenate
+* random access read
+
+The API unfortunately exposes a random-access write approach, which -
+while ~unused needs before we can re-write this away from the store
+backend.
diff --git a/xmlscript/README b/xmlscript/README
index 24faaa4..84cfec6 100644
--- a/xmlscript/README
+++ b/xmlscript/README
@@ -1 +1,6 @@
 XML dialogs.
+
+This code is used to (de)serialize basic dialogs to XML for storage
+inside documents. While the XML -appears- to have some hierarchical
+structure, that is only a fabrication, parsing and underlying toolkit
+widget structure is sadly linear and flat.
\ No newline at end of file
diff --git a/xmlsecurity/README b/xmlsecurity/README
index 3d18558..5eec54a 100644
--- a/xmlsecurity/README
+++ b/xmlsecurity/README
@@ -1 +1,4 @@
 Stuff for document signing.
+
+This code provides dialogs, and infrastructure wrapping libxmlsec that
+implements document signing.
