diff options
| author | Tamas Bunth <tamas.bunth@collabora.co.uk> | 2019-03-04 16:54:06 +0100 |
|---|---|---|
| committer | Andras Timar <andras.timar@collabora.com> | 2019-03-19 15:16:51 +0100 |
| commit | 7a9f6df7fb83ec23d09cb5744c2c865fa22e7143 (patch) | |
| tree | 62af385480790172d4d55ccc05d88432c41aa6db /readlicense_oo/README | |
| parent | 37399c71004d338bab9bfaba9023f6d7b463a286 (diff) | |
single source file for licensing info with conditional text
... for easier maintenance. This commit only introduces the
framework. Follow up commits will update the license file.
Advantages:
* single source, multiple outputs (html, txt)
* conditional text, i.e. output will not include license
terms of components that are not configured in the build
Change-Id: I0ffad41119228a0a26fd1b6ce19930ca6085adb2
Reviewed-on: https://gerrit.libreoffice.org/69396
Tested-by: Jenkins
Reviewed-by: Andras Timar <andras.timar@collabora.com>
Diffstat (limited to 'readlicense_oo/README')
| -rw-r--r-- | readlicense_oo/README | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/readlicense_oo/README b/readlicense_oo/README index f4c46c85499e..cd73b2040285 100644 --- a/readlicense_oo/README +++ b/readlicense_oo/README @@ -1,2 +1,33 @@ Contains the stock libreoffice licensing blurb, as distributed in the install directory, and also potentially at run-time. + +Generating licence files +------------------------ + +License files are generated from a single source file (licese/license.xml). +Output file formats are plain text and html. + +- The plain text and the html format is generated with xslt. There are two + separate xsl files for plain text and html. + +Conditional text +---------------- + +The contents of the license file depends on the build configuration. Several +externals may or may not be shipped with LibreOffice. Therefore, we need to pass +information about build configuration to the xslt processor. + +Variables used for conditional text: + +- BUILD_TYPE: A space separated list of libraries/externals. If an external is + present in that list, then the related license text should be included. + +- MPL_SUBSET: If the variable is defined, then GPL and LGPL license text will not + be included, because none of the built-in code need it. + +- OS: The target platform. E.g. MSVC Runtime is packaged and used only on Windows. + +- WITH_THEMES: A space separated list of icon sets that are used in the build. + +Conditional text are surrounded by and extra <div> tag. The class attribute of +that <div> tag decides which parameter values are taken into consideration. |