aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNik Nyby <nikolas@gnu.org>2015-10-22 20:50:29 -0400
committerNik Nyby <nikolas@gnu.org>2015-10-22 20:50:29 -0400
commitdae22597bd81d0d96370738010cac775bf31afea (patch)
tree6b19966240b4d86c9344a86fbb5c8c7bed78f390
parent78a04a6e5563d7bcfb3b1b506a2698d1fa2d4e97 (diff)
downloadlibrejsxul-dae22597bd81d0d96370738010cac775bf31afea.tar.lz
librejsxul-dae22597bd81d0d96370738010cac775bf31afea.tar.xz
librejsxul-dae22597bd81d0d96370738010cac775bf31afea.zip
update manual with librejs development notes
-rw-r--r--doc/librejs.info74
-rw-r--r--doc/librejs.texi52
-rw-r--r--doc/manual/html_node/Installation-Requirements.html6
-rw-r--r--doc/manual/html_node/LibreJS-Development-Notes.html117
-rw-r--r--doc/manual/html_node/Setting-Your-JavaScript-Free.html6
-rw-r--r--doc/manual/html_node/index.html14
-rw-r--r--doc/manual/index.html4
-rw-r--r--doc/manual/librejs.dvi.gzbin31560 -> 32350 bytes
-rw-r--r--doc/manual/librejs.html68
-rw-r--r--doc/manual/librejs.html.gzbin20620 -> 21395 bytes
-rw-r--r--doc/manual/librejs.html_node.tar.gzbin22423 -> 23391 bytes
-rw-r--r--doc/manual/librejs.info.tar.gzbin18621 -> 19151 bytes
-rw-r--r--doc/manual/librejs.pdfbin204015 -> 206511 bytes
-rw-r--r--doc/manual/librejs.texi.tar.gzbin18364 -> 18873 bytes
-rw-r--r--doc/manual/librejs.txt47
-rw-r--r--doc/manual/librejs.txt.gzbin17654 -> 18124 bytes
16 files changed, 361 insertions, 27 deletions
diff --git a/doc/librejs.info b/doc/librejs.info
index e22957d..f3ee4f9 100644
--- a/doc/librejs.info
+++ b/doc/librejs.info
@@ -36,6 +36,8 @@ This manual is for GNU LibreJS (version 6.0.10.20151023, 23 October
* JavaScript Detection:: How LibreJS detects nontrivial Javascript.
* Free Licenses Detection:: List of licenses detected by LibreJS.
* Setting Your JavaScript Free:: Information for website owners/maintainers.
+* LibreJS Development Notes:: Documentation about the development of
+ LibreJS itself.
* Installation Requirements:: Requirements to build and install LibreJS.
* LibreJS Internals:: How LibreJS works under the hood.
* Tests:: Test LibreJS and better understand it.
@@ -424,7 +426,7 @@ information.
<http://www.gnu.org/licenses/license-list.html>

-File: librejs.info, Node: Setting Your JavaScript Free, Next: Installation Requirements, Prev: Free Licenses Detection, Up: Top
+File: librejs.info, Node: Setting Your JavaScript Free, Next: LibreJS Development Notes, Prev: Free Licenses Detection, Up: Top
7 Setting Your JavaScript Free
******************************
@@ -581,7 +583,52 @@ web page:
<https://www.gnu.org/software/librejs/free-your-javascript.html>

-File: librejs.info, Node: Installation Requirements, Next: LibreJS Internals, Prev: Setting Your JavaScript Free, Up: Top
+File: librejs.info, Node: LibreJS Development Notes, Next: Installation Requirements, Prev: Setting Your JavaScript Free, Up: Top
+
+8 LibreJS Development Notes
+***************************
+
+8.1 Running LibreJS from the source directory
+=============================================
+
+Download Mozilla's Add-on SDK, then do something like this in the
+LibreJS directory:
+
+ cfx run -b `which icecat`
+
+8.2 Debugging
+=============
+
+Uncomment lines 22 and 23 in 'lib/main.js' to enable printing of
+'console.debug()' statements.
+
+8.3 Adding new whitelisted libraries
+====================================
+
+Run the 'data/script_libraries/gethash.sh' script, using the URL to a
+JavaScript file as the argument, then add the output of that command to
+'data/script_libraries/script-libraries.json'.
+
+8.4 Releasing a new version
+===========================
+
+Update the version number in:
+ * 'configure.ac'
+ * 'package.json'
+ * 'doc/version.texi'
+ * 'data/display_panel/content/display-panel.html'
+ *
+ Then run 'make info' to build the docs with 'gendocs.sh'.
+ * 'git commit' and 'git tag 6.0.4'
+ * Export a tarball:
+ * 'git archive --format=tar.gz --prefix=librejs-6.0.4 6.0.4
+ >librejs-6.0.4.tar.gz'
+ * 'mv librejs-6.0.4.tar.gz ~/releases/librejs-6.0.4/'
+ * Make xpi file: 'cfx xpi --strip-sdk; mv librejs.xpi
+ librejs-6.0.4.xpi'
+
+
+File: librejs.info, Node: Installation Requirements, Next: LibreJS Internals, Prev: LibreJS Development Notes, Up: Top
Appendix A Installation Requirements
************************************
@@ -1235,16 +1282,17 @@ their use in free software.

Tag Table:
Node: Top841
-Node: Overview1865
-Node: Disclaimer2712
-Node: Installation3208
-Node: How to Use4061
-Node: JavaScript Detection7303
-Node: Free Licenses Detection10711
-Node: Setting Your JavaScript Free17129
-Node: Installation Requirements23963
-Node: LibreJS Internals26120
-Node: Tests27283
-Node: GNU Free Documentation License31790
+Node: Overview2000
+Node: Disclaimer2847
+Node: Installation3343
+Node: How to Use4196
+Node: JavaScript Detection7438
+Node: Free Licenses Detection10846
+Node: Setting Your JavaScript Free17264
+Node: LibreJS Development Notes24098
+Node: Installation Requirements25470
+Node: LibreJS Internals27624
+Node: Tests28787
+Node: GNU Free Documentation License33294

End Tag Table
diff --git a/doc/librejs.texi b/doc/librejs.texi
index bdae9f4..a19047e 100644
--- a/doc/librejs.texi
+++ b/doc/librejs.texi
@@ -51,6 +51,8 @@ This manual is for GNU LibreJS (version @value{VERSION}, @value{UPDATED}).
* JavaScript Detection:: How LibreJS detects nontrivial Javascript.
* Free Licenses Detection:: List of licenses detected by LibreJS.
* Setting Your JavaScript Free:: Information for website owners/maintainers.
+* LibreJS Development Notes:: Documentation about the development of
+ LibreJS itself.
* Installation Requirements:: Requirements to build and install LibreJS.
* LibreJS Internals:: How LibreJS works under the hood.
* Tests:: Test LibreJS and better understand it.
@@ -715,6 +717,56 @@ remains intact.
For more info on making your JavaScript LibreJS-compliant, see this web
page: @url{https://www.gnu.org/software/librejs/free-your-javascript.html}
+@node LibreJS Development Notes
+@chapter LibreJS Development Notes
+
+@section Running LibreJS from the source directory
+Download Mozilla's Add-on SDK, then do something like this in the LibreJS
+directory:
+
+@example
+cfx run -b `which icecat`
+@end example
+
+@section Debugging
+Uncomment lines 22 and 23 in @file{lib/main.js} to enable printing of
+@code{console.debug()} statements.
+
+@section Adding new whitelisted libraries
+Run the @file{data/script_libraries/gethash.sh} script, using the URL
+to a JavaScript file as the argument, then add the output of that
+command to @file{data/script_libraries/script-libraries.json}.
+
+@section Releasing a new version
+Update the version number in:
+@itemize @bullet
+@item
+@file{configure.ac}
+@item
+@file{package.json}
+@item
+@file{doc/version.texi}
+@item
+@file{data/display_panel/content/display-panel.html}
+@item
+@end itemize
+
+Then run @samp{make info} to build the docs with @file{gendocs.sh}.
+@itemize @bullet
+@item
+@samp{git commit} and @samp{git tag 6.0.4}
+@item
+Export a tarball:
+@itemize @bullet
+@item
+@samp{git archive --format=tar.gz --prefix=librejs-6.0.4 6.0.4 >librejs-6.0.4.tar.gz}
+@item
+@samp{mv librejs-6.0.4.tar.gz ~/releases/librejs-6.0.4/}
+@end itemize
+@item
+Make xpi file: @samp{cfx xpi --strip-sdk; mv librejs.xpi librejs-6.0.4.xpi}
+@end itemize
+
@node Installation Requirements
@appendix Installation Requirements
diff --git a/doc/manual/html_node/Installation-Requirements.html b/doc/manual/html_node/Installation-Requirements.html
index 076c9e1..720d26b 100644
--- a/doc/manual/html_node/Installation-Requirements.html
+++ b/doc/manual/html_node/Installation-Requirements.html
@@ -26,7 +26,7 @@ Texts. A copy of the license is included in the section entitled
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html#Top" rel="up" title="Top">
<link href="LibreJS-Internals.html#LibreJS-Internals" rel="next" title="LibreJS Internals">
-<link href="Setting-Your-JavaScript-Free.html#Setting-Your-JavaScript-Free" rel="prev" title="Setting Your JavaScript Free">
+<link href="LibreJS-Development-Notes.html#LibreJS-Development-Notes" rel="prev" title="LibreJS Development Notes">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
@@ -63,7 +63,7 @@ ul.no-bullet {list-style: none}
<a name="Installation-Requirements"></a>
<div class="header">
<p>
-Next: <a href="LibreJS-Internals.html#LibreJS-Internals" accesskey="n" rel="next">LibreJS Internals</a>, Previous: <a href="Setting-Your-JavaScript-Free.html#Setting-Your-JavaScript-Free" accesskey="p" rel="prev">Setting Your JavaScript Free</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
+Next: <a href="LibreJS-Internals.html#LibreJS-Internals" accesskey="n" rel="next">LibreJS Internals</a>, Previous: <a href="LibreJS-Development-Notes.html#LibreJS-Development-Notes" accesskey="p" rel="prev">LibreJS Development Notes</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Installation-Requirements-1"></a>
@@ -123,7 +123,7 @@ symbolic link in <samp>/usr/bin</samp>, as follows:
<hr>
<div class="header">
<p>
-Next: <a href="LibreJS-Internals.html#LibreJS-Internals" accesskey="n" rel="next">LibreJS Internals</a>, Previous: <a href="Setting-Your-JavaScript-Free.html#Setting-Your-JavaScript-Free" accesskey="p" rel="prev">Setting Your JavaScript Free</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
+Next: <a href="LibreJS-Internals.html#LibreJS-Internals" accesskey="n" rel="next">LibreJS Internals</a>, Previous: <a href="LibreJS-Development-Notes.html#LibreJS-Development-Notes" accesskey="p" rel="prev">LibreJS Development Notes</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
diff --git a/doc/manual/html_node/LibreJS-Development-Notes.html b/doc/manual/html_node/LibreJS-Development-Notes.html
new file mode 100644
index 0000000..f05e766
--- /dev/null
+++ b/doc/manual/html_node/LibreJS-Development-Notes.html
@@ -0,0 +1,117 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!-- This manual is for GNU LibreJS (version 6.0.10.20151023, 23 October 2015),
+a GNU IceCat extension to detect and block nonfree nontrivial
+JavaScript on webpages.
+
+Copyright (C) 2011 2012 2014 2015 Loic J. Duros
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
+Texts. A copy of the license is included in the section entitled
+"GNU Free Documentation License". -->
+<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU LibreJS 6.0.10.20151023: LibreJS Development Notes</title>
+
+<meta name="description" content="GNU LibreJS 6.0.10.20151023: LibreJS Development Notes">
+<meta name="keywords" content="GNU LibreJS 6.0.10.20151023: LibreJS Development Notes">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="makeinfo">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="index.html#Top" rel="up" title="Top">
+<link href="Installation-Requirements.html#Installation-Requirements" rel="next" title="Installation Requirements">
+<link href="Setting-Your-JavaScript-Free.html#Setting-Your-JavaScript-Free" rel="prev" title="Setting Your JavaScript Free">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.indentedblock {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
+div.smalllisp {margin-left: 3.2em}
+kbd {font-style:oblique}
+pre.display {font-family: inherit}
+pre.format {font-family: inherit}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: inherit; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: inherit; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:nowrap}
+span.nolinebreak {white-space:nowrap}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
+</head>
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
+<a name="LibreJS-Development-Notes"></a>
+<div class="header">
+<p>
+Next: <a href="Installation-Requirements.html#Installation-Requirements" accesskey="n" rel="next">Installation Requirements</a>, Previous: <a href="Setting-Your-JavaScript-Free.html#Setting-Your-JavaScript-Free" accesskey="p" rel="prev">Setting Your JavaScript Free</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
+</div>
+<hr>
+<a name="LibreJS-Development-Notes-1"></a>
+<h2 class="chapter">8 LibreJS Development Notes</h2>
+
+<a name="Running-LibreJS-from-the-source-directory"></a>
+<h3 class="section">8.1 Running LibreJS from the source directory</h3>
+<p>Download Mozilla&rsquo;s Add-on SDK, then do something like this in the LibreJS
+directory:
+</p>
+<div class="example">
+<pre class="example">cfx run -b `which icecat`
+</pre></div>
+
+<a name="Debugging"></a>
+<h3 class="section">8.2 Debugging</h3>
+<p>Uncomment lines 22 and 23 in <samp>lib/main.js</samp> to enable printing of
+<code>console.debug()</code> statements.
+</p>
+<a name="Adding-new-whitelisted-libraries"></a>
+<h3 class="section">8.3 Adding new whitelisted libraries</h3>
+<p>Run the <samp>data/script_libraries/gethash.sh</samp> script, using the URL
+to a JavaScript file as the argument, then add the output of that
+command to <samp>data/script_libraries/script-libraries.json</samp>.
+</p>
+<a name="Releasing-a-new-version"></a>
+<h3 class="section">8.4 Releasing a new version</h3>
+<p>Update the version number in:
+</p><ul>
+<li> <samp>configure.ac</samp>
+</li><li> <samp>package.json</samp>
+</li><li> <samp>doc/version.texi</samp>
+</li><li> <samp>data/display_panel/content/display-panel.html</samp>
+</li></ul>
+
+<p>Then run &lsquo;<samp>make info</samp>&rsquo; to build the docs with <samp>gendocs.sh</samp>.
+</p><ul>
+<li> &lsquo;<samp>git commit</samp>&rsquo; and &lsquo;<samp>git tag 6.0.4</samp>&rsquo;
+</li><li> Export a tarball:
+<ul>
+<li> &lsquo;<samp>git archive --format=tar.gz --prefix=librejs-6.0.4 6.0.4 &gt;librejs-6.0.4.tar.gz</samp>&rsquo;
+</li><li> &lsquo;<samp>mv librejs-6.0.4.tar.gz ~/releases/librejs-6.0.4/</samp>&rsquo;
+</li></ul>
+</li><li> Make xpi file: &lsquo;<samp>cfx xpi --strip-sdk; mv librejs.xpi librejs-6.0.4.xpi</samp>&rsquo;
+</li></ul>
+
+
+
+
+</body>
+</html>
diff --git a/doc/manual/html_node/Setting-Your-JavaScript-Free.html b/doc/manual/html_node/Setting-Your-JavaScript-Free.html
index 41e224c..04eb12d 100644
--- a/doc/manual/html_node/Setting-Your-JavaScript-Free.html
+++ b/doc/manual/html_node/Setting-Your-JavaScript-Free.html
@@ -25,7 +25,7 @@ Texts. A copy of the license is included in the section entitled
<link href="index.html#Top" rel="start" title="Top">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html#Top" rel="up" title="Top">
-<link href="Installation-Requirements.html#Installation-Requirements" rel="next" title="Installation Requirements">
+<link href="LibreJS-Development-Notes.html#LibreJS-Development-Notes" rel="next" title="LibreJS Development Notes">
<link href="Free-Licenses-Detection.html#Free-Licenses-Detection" rel="prev" title="Free Licenses Detection">
<style type="text/css">
<!--
@@ -63,7 +63,7 @@ ul.no-bullet {list-style: none}
<a name="Setting-Your-JavaScript-Free"></a>
<div class="header">
<p>
-Next: <a href="Installation-Requirements.html#Installation-Requirements" accesskey="n" rel="next">Installation Requirements</a>, Previous: <a href="Free-Licenses-Detection.html#Free-Licenses-Detection" accesskey="p" rel="prev">Free Licenses Detection</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
+Next: <a href="LibreJS-Development-Notes.html#LibreJS-Development-Notes" accesskey="n" rel="next">LibreJS Development Notes</a>, Previous: <a href="Free-Licenses-Detection.html#Free-Licenses-Detection" accesskey="p" rel="prev">Free Licenses Detection</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Setting-Your-JavaScript-Free-1"></a>
@@ -230,7 +230,7 @@ page: <a href="https://www.gnu.org/software/librejs/free-your-javascript.html">h
<hr>
<div class="header">
<p>
-Next: <a href="Installation-Requirements.html#Installation-Requirements" accesskey="n" rel="next">Installation Requirements</a>, Previous: <a href="Free-Licenses-Detection.html#Free-Licenses-Detection" accesskey="p" rel="prev">Free Licenses Detection</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
+Next: <a href="LibreJS-Development-Notes.html#LibreJS-Development-Notes" accesskey="n" rel="next">LibreJS Development Notes</a>, Previous: <a href="Free-Licenses-Detection.html#Free-Licenses-Detection" accesskey="p" rel="prev">Free Licenses Detection</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
diff --git a/doc/manual/html_node/index.html b/doc/manual/html_node/index.html
index 58b1586..b7e668d 100644
--- a/doc/manual/html_node/index.html
+++ b/doc/manual/html_node/index.html
@@ -99,6 +99,13 @@ ul.no-bullet {list-style: none}
<li><a name="toc-Adding-a-stylized-comment-in-your-JavaScript-files-and-on-your-page" href="Setting-Your-JavaScript-Free.html#Adding-a-stylized-comment-in-your-JavaScript-files-and-on-your-page">7.2 Adding a stylized comment in your JavaScript files and on your page</a></li>
</ul></li>
</li>
+ <li><a name="toc-LibreJS-Development-Notes-1" href="LibreJS-Development-Notes.html#LibreJS-Development-Notes">8 LibreJS Development Notes</a>
+ <ul class="no-bullet">
+ <li><a name="toc-Running-LibreJS-from-the-source-directory" href="LibreJS-Development-Notes.html#Running-LibreJS-from-the-source-directory">8.1 Running LibreJS from the source directory</a></li>
+ <li><a name="toc-Debugging" href="LibreJS-Development-Notes.html#Debugging">8.2 Debugging</a></li>
+ <li><a name="toc-Adding-new-whitelisted-libraries" href="LibreJS-Development-Notes.html#Adding-new-whitelisted-libraries">8.3 Adding new whitelisted libraries</a></li>
+ <li><a name="toc-Releasing-a-new-version" href="LibreJS-Development-Notes.html#Releasing-a-new-version">8.4 Releasing a new version</a></li>
+ </ul></li>
<li><a name="toc-Installation-Requirements-1" href="Installation-Requirements.html#Installation-Requirements">Appendix A Installation Requirements</a>
<ul class="no-bullet">
<li><a name="toc-Mozilla-Browser" href="Installation-Requirements.html#Mozilla-Browser">A.1 Mozilla Browser</a></li>
@@ -137,9 +144,12 @@ Next: <a href="Overview.html#Overview" accesskey="n" rel="next">Overview</a>, Up
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Setting-Your-JavaScript-Free.html#Setting-Your-JavaScript-Free" accesskey="7">Setting Your JavaScript Free</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Information for website owners/maintainers.
</td></tr>
-<tr><td align="left" valign="top">&bull; <a href="Installation-Requirements.html#Installation-Requirements" accesskey="8">Installation Requirements</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Requirements to build and install LibreJS.
+<tr><td align="left" valign="top">&bull; <a href="LibreJS-Development-Notes.html#LibreJS-Development-Notes" accesskey="8">LibreJS Development Notes</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Documentation about the development of
+ LibreJS itself.
+</td></tr>
+<tr><td align="left" valign="top">&bull; <a href="Installation-Requirements.html#Installation-Requirements" accesskey="9">Installation Requirements</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Requirements to build and install LibreJS.
</td></tr>
-<tr><td align="left" valign="top">&bull; <a href="LibreJS-Internals.html#LibreJS-Internals" accesskey="9">LibreJS Internals</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">How LibreJS works under the hood.
+<tr><td align="left" valign="top">&bull; <a href="LibreJS-Internals.html#LibreJS-Internals">LibreJS Internals</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">How LibreJS works under the hood.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Tests.html#Tests">Tests</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Test LibreJS and better understand it.
</td></tr>
diff --git a/doc/manual/index.html b/doc/manual/index.html
index 1bac91c..5f3b6f6 100644
--- a/doc/manual/index.html
+++ b/doc/manual/index.html
@@ -11,7 +11,7 @@
<ul>
<li><a href="librejs.html">HTML
- (72K bytes)</a> - entirely on one web page.</li>
+ (76K bytes)</a> - entirely on one web page.</li>
<li><a href="html_node/index.html">HTML</a> - with one web page per
node.</li>
<li><a href="librejs.html.gz">HTML compressed
@@ -29,7 +29,7 @@
<li><a href="librejs.dvi.gz">TeX dvi file
(32K bytes gzipped)</a>.</li>
<li><a href="librejs.pdf">PDF file
- (200K bytes)</a>.</li>
+ (204K bytes)</a>.</li>
<li><a href="librejs.texi.tar.gz">Texinfo source
(20K bytes gzipped tar file).</a></li>
</ul>
diff --git a/doc/manual/librejs.dvi.gz b/doc/manual/librejs.dvi.gz
index c4cce50..74a1b40 100644
--- a/doc/manual/librejs.dvi.gz
+++ b/doc/manual/librejs.dvi.gz
Binary files differ
diff --git a/doc/manual/librejs.html b/doc/manual/librejs.html
index 13ff618..8569cd8 100644
--- a/doc/manual/librejs.html
+++ b/doc/manual/librejs.html
@@ -98,6 +98,13 @@ ul.no-bullet {list-style: none}
<li><a name="toc-Adding-a-stylized-comment-in-your-JavaScript-files-and-on-your-page" href="#Adding-a-stylized-comment-in-your-JavaScript-files-and-on-your-page">7.2 Adding a stylized comment in your JavaScript files and on your page</a></li>
</ul></li>
</li>
+ <li><a name="toc-LibreJS-Development-Notes-1" href="#LibreJS-Development-Notes">8 LibreJS Development Notes</a>
+ <ul class="no-bullet">
+ <li><a name="toc-Running-LibreJS-from-the-source-directory" href="#Running-LibreJS-from-the-source-directory">8.1 Running LibreJS from the source directory</a></li>
+ <li><a name="toc-Debugging" href="#Debugging">8.2 Debugging</a></li>
+ <li><a name="toc-Adding-new-whitelisted-libraries" href="#Adding-new-whitelisted-libraries">8.3 Adding new whitelisted libraries</a></li>
+ <li><a name="toc-Releasing-a-new-version" href="#Releasing-a-new-version">8.4 Releasing a new version</a></li>
+ </ul></li>
<li><a name="toc-Installation-Requirements-1" href="#Installation-Requirements">Appendix A Installation Requirements</a>
<ul class="no-bullet">
<li><a name="toc-Mozilla-Browser" href="#Mozilla-Browser">A.1 Mozilla Browser</a></li>
@@ -135,9 +142,12 @@ Next: <a href="#Overview" accesskey="n" rel="next">Overview</a>, Up: <a href="di
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Setting-Your-JavaScript-Free" accesskey="7">Setting Your JavaScript Free</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Information for website owners/maintainers.
</td></tr>
-<tr><td align="left" valign="top">&bull; <a href="#Installation-Requirements" accesskey="8">Installation Requirements</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Requirements to build and install LibreJS.
+<tr><td align="left" valign="top">&bull; <a href="#LibreJS-Development-Notes" accesskey="8">LibreJS Development Notes</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Documentation about the development of
+ LibreJS itself.
+</td></tr>
+<tr><td align="left" valign="top">&bull; <a href="#Installation-Requirements" accesskey="9">Installation Requirements</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Requirements to build and install LibreJS.
</td></tr>
-<tr><td align="left" valign="top">&bull; <a href="#LibreJS-Internals" accesskey="9">LibreJS Internals</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">How LibreJS works under the hood.
+<tr><td align="left" valign="top">&bull; <a href="#LibreJS-Internals">LibreJS Internals</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">How LibreJS works under the hood.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Tests">Tests</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Test LibreJS and better understand it.
</td></tr>
@@ -601,7 +611,7 @@ information.
<a name="Setting-Your-JavaScript-Free"></a>
<div class="header">
<p>
-Next: <a href="#Installation-Requirements" accesskey="n" rel="next">Installation Requirements</a>, Previous: <a href="#Free-Licenses-Detection" accesskey="p" rel="prev">Free Licenses Detection</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
+Next: <a href="#LibreJS-Development-Notes" accesskey="n" rel="next">LibreJS Development Notes</a>, Previous: <a href="#Free-Licenses-Detection" accesskey="p" rel="prev">Free Licenses Detection</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<a name="Setting-Your-JavaScript-Free-1"></a>
<h2 class="chapter">7 Setting Your JavaScript Free</h2>
@@ -765,10 +775,60 @@ remains intact.
page: <a href="https://www.gnu.org/software/librejs/free-your-javascript.html">https://www.gnu.org/software/librejs/free-your-javascript.html</a>
</p>
<hr>
+<a name="LibreJS-Development-Notes"></a>
+<div class="header">
+<p>
+Next: <a href="#Installation-Requirements" accesskey="n" rel="next">Installation Requirements</a>, Previous: <a href="#Setting-Your-JavaScript-Free" accesskey="p" rel="prev">Setting Your JavaScript Free</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
+</div>
+<a name="LibreJS-Development-Notes-1"></a>
+<h2 class="chapter">8 LibreJS Development Notes</h2>
+
+<a name="Running-LibreJS-from-the-source-directory"></a>
+<h3 class="section">8.1 Running LibreJS from the source directory</h3>
+<p>Download Mozilla&rsquo;s Add-on SDK, then do something like this in the LibreJS
+directory:
+</p>
+<div class="example">
+<pre class="example">cfx run -b `which icecat`
+</pre></div>
+
+<a name="Debugging"></a>
+<h3 class="section">8.2 Debugging</h3>
+<p>Uncomment lines 22 and 23 in <samp>lib/main.js</samp> to enable printing of
+<code>console.debug()</code> statements.
+</p>
+<a name="Adding-new-whitelisted-libraries"></a>
+<h3 class="section">8.3 Adding new whitelisted libraries</h3>
+<p>Run the <samp>data/script_libraries/gethash.sh</samp> script, using the URL
+to a JavaScript file as the argument, then add the output of that
+command to <samp>data/script_libraries/script-libraries.json</samp>.
+</p>
+<a name="Releasing-a-new-version"></a>
+<h3 class="section">8.4 Releasing a new version</h3>
+<p>Update the version number in:
+</p><ul>
+<li> <samp>configure.ac</samp>
+</li><li> <samp>package.json</samp>
+</li><li> <samp>doc/version.texi</samp>
+</li><li> <samp>data/display_panel/content/display-panel.html</samp>
+</li></ul>
+
+<p>Then run &lsquo;<samp>make info</samp>&rsquo; to build the docs with <samp>gendocs.sh</samp>.
+</p><ul>
+<li> &lsquo;<samp>git commit</samp>&rsquo; and &lsquo;<samp>git tag 6.0.4</samp>&rsquo;
+</li><li> Export a tarball:
+<ul>
+<li> &lsquo;<samp>git archive --format=tar.gz --prefix=librejs-6.0.4 6.0.4 &gt;librejs-6.0.4.tar.gz</samp>&rsquo;
+</li><li> &lsquo;<samp>mv librejs-6.0.4.tar.gz ~/releases/librejs-6.0.4/</samp>&rsquo;
+</li></ul>
+</li><li> Make xpi file: &lsquo;<samp>cfx xpi --strip-sdk; mv librejs.xpi librejs-6.0.4.xpi</samp>&rsquo;
+</li></ul>
+
+<hr>
<a name="Installation-Requirements"></a>
<div class="header">
<p>
-Next: <a href="#LibreJS-Internals" accesskey="n" rel="next">LibreJS Internals</a>, Previous: <a href="#Setting-Your-JavaScript-Free" accesskey="p" rel="prev">Setting Your JavaScript Free</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
+Next: <a href="#LibreJS-Internals" accesskey="n" rel="next">LibreJS Internals</a>, Previous: <a href="#LibreJS-Development-Notes" accesskey="p" rel="prev">LibreJS Development Notes</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<a name="Installation-Requirements-1"></a>
<h2 class="appendix">Appendix A Installation Requirements</h2>
diff --git a/doc/manual/librejs.html.gz b/doc/manual/librejs.html.gz
index 6fd6127..f1c2743 100644
--- a/doc/manual/librejs.html.gz
+++ b/doc/manual/librejs.html.gz
Binary files differ
diff --git a/doc/manual/librejs.html_node.tar.gz b/doc/manual/librejs.html_node.tar.gz
index 60a0649..d5a9c88 100644
--- a/doc/manual/librejs.html_node.tar.gz
+++ b/doc/manual/librejs.html_node.tar.gz
Binary files differ
diff --git a/doc/manual/librejs.info.tar.gz b/doc/manual/librejs.info.tar.gz
index d2737e5..72a1a41 100644
--- a/doc/manual/librejs.info.tar.gz
+++ b/doc/manual/librejs.info.tar.gz
Binary files differ
diff --git a/doc/manual/librejs.pdf b/doc/manual/librejs.pdf
index 5540530..c464ae2 100644
--- a/doc/manual/librejs.pdf
+++ b/doc/manual/librejs.pdf
Binary files differ
diff --git a/doc/manual/librejs.texi.tar.gz b/doc/manual/librejs.texi.tar.gz
index 6efdd13..640a41d 100644
--- a/doc/manual/librejs.texi.tar.gz
+++ b/doc/manual/librejs.texi.tar.gz
Binary files differ
diff --git a/doc/manual/librejs.txt b/doc/manual/librejs.txt
index ebb18f4..5ae723b 100644
--- a/doc/manual/librejs.txt
+++ b/doc/manual/librejs.txt
@@ -17,6 +17,11 @@ LibreJS
7.1.1 Specifying multiple licenses for a single JavaScript file
7.2 Adding a stylized comment in your JavaScript files and on your page
+8 LibreJS Development Notes
+ 8.1 Running LibreJS from the source directory
+ 8.2 Debugging
+ 8.3 Adding new whitelisted libraries
+ 8.4 Releasing a new version
Appendix A Installation Requirements
A.1 Mozilla Browser
A.2 Mozilla's Add-on SDK
@@ -547,6 +552,48 @@ license remains intact.
web page:
<https://www.gnu.org/software/librejs/free-your-javascript.html>
+8 LibreJS Development Notes
+***************************
+
+8.1 Running LibreJS from the source directory
+=============================================
+
+Download Mozilla's Add-on SDK, then do something like this in the
+LibreJS directory:
+
+ cfx run -b `which icecat`
+
+8.2 Debugging
+=============
+
+Uncomment lines 22 and 23 in 'lib/main.js' to enable printing of
+'console.debug()' statements.
+
+8.3 Adding new whitelisted libraries
+====================================
+
+Run the 'data/script_libraries/gethash.sh' script, using the URL to a
+JavaScript file as the argument, then add the output of that command to
+'data/script_libraries/script-libraries.json'.
+
+8.4 Releasing a new version
+===========================
+
+Update the version number in:
+ * 'configure.ac'
+ * 'package.json'
+ * 'doc/version.texi'
+ * 'data/display_panel/content/display-panel.html'
+ *
+ Then run 'make info' to build the docs with 'gendocs.sh'.
+ * 'git commit' and 'git tag 6.0.4'
+ * Export a tarball:
+ * 'git archive --format=tar.gz --prefix=librejs-6.0.4 6.0.4
+ >librejs-6.0.4.tar.gz'
+ * 'mv librejs-6.0.4.tar.gz ~/releases/librejs-6.0.4/'
+ * Make xpi file: 'cfx xpi --strip-sdk; mv librejs.xpi
+ librejs-6.0.4.xpi'
+
Appendix A Installation Requirements
************************************
diff --git a/doc/manual/librejs.txt.gz b/doc/manual/librejs.txt.gz
index aea5432..4c3514b 100644
--- a/doc/manual/librejs.txt.gz
+++ b/doc/manual/librejs.txt.gz
Binary files differ