[Python-modules-commits] [jupyter-notebook] 02/02: Expand comments in README.source concerning caja

[Gordon Ball]

This is an automated email from the git hooks/post-receive script.

chronitis-guest pushed a commit to branch master
in repository jupyter-notebook.

commit 7315e95da6fa426609d912a5048c264f7ea03559
Author: Gordon Ball <gordon at chronitis.net>
Date:   Mon Oct 24 16:08:30 2016 +0200

    Expand comments in README.source concerning caja
---
 debian/README.source | 31 ++++++++++++++++++++++++-------
 1 file changed, 24 insertions(+), 7 deletions(-)

diff --git a/debian/README.source b/debian/README.source
index 32554ff..f817d1e 100644
--- a/debian/README.source
+++ b/debian/README.source
@@ -11,13 +11,30 @@ run during build, but the latter requires phantomjs and casperjs (unpackaged)
 so is not currently run. (The <nocheck> option is supported, which should
 significantly shorten the build-depends).
 
-All javascript except google-caja are symlinked from libjs-* packages, both
-during build and for the binary package. Google-caja (HTML and CSS sanitizer)
-javascript files are included in debian/missing-source. These files come from
-[1], which appears to have been set up by the jupyter team to provide a
-bower-installable javascript package containing files picked from upstream [2].
-The relevant files are concat'd and minified during build, and all appear to
-contain Apache-2.0 grants.
+All javascript except caja (see below) are symlinked from libjs-* packages,
+both at build and runtime. In some cases the naming used by jupyter is not a
+match to the libjs packages and individual files are symlinked instead of
+directories - see d/rules.
+
+caja
+----
+
+Google-caja (HTML and CSS sanitizer) javascript files are included in
+debian/missing-source. These files come from [1], which appears to have been
+set up by the jupyter team to provide a bower-installable javascript package
+containing files picked from upstream [2].
+
+Of the files in missing-source, five are "bona-fide" source files cherry-picked
+from upstream (from `src/com/google/caja/plugin` in [2]), but the remaining two
+(`html4-defs.js` and `css-defs.js`) are generated by upstream caja. These are
+arguably data - they contain lists of HTML and CSS entities along with their
+expected properties ultimately extracted from W3C files, but the exact
+transformation is performed by java classes from the caja
+(`com.google.caja.lang.css.CssPropertyPatterns$Builder` and
+`com.google.caja.lang.html.HtmlDefinitions$Builder`). The generated files
+are not obfuscated and contain a declaration that they are Apache-licensed.
+
+These files are concatenated and minified during build.
 
 [1]: https://github.com/minrk/google-caja-bower
 [2]: https://github.com/google/caja

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/jupyter-notebook.git