diff options
| author | Nik Nyby <nikolas@gnu.org> | 2015-10-22 20:50:29 -0400 |
|---|---|---|
| committer | Nik Nyby <nikolas@gnu.org> | 2015-10-22 20:50:29 -0400 |
| commit | dae22597bd81d0d96370738010cac775bf31afea (patch) | |
| tree | 6b19966240b4d86c9344a86fbb5c8c7bed78f390 /doc/manual/html_node | |
| parent | 78a04a6e5563d7bcfb3b1b506a2698d1fa2d4e97 (diff) | |
| download | librejsxul-dae22597bd81d0d96370738010cac775bf31afea.tar.lz librejsxul-dae22597bd81d0d96370738010cac775bf31afea.tar.xz librejsxul-dae22597bd81d0d96370738010cac775bf31afea.zip | |
update manual with librejs development notes
Diffstat (limited to 'doc/manual/html_node')
| -rw-r--r-- | doc/manual/html_node/Installation-Requirements.html | 6 | ||||
| -rw-r--r-- | doc/manual/html_node/LibreJS-Development-Notes.html | 117 | ||||
| -rw-r--r-- | doc/manual/html_node/Setting-Your-JavaScript-Free.html | 6 | ||||
| -rw-r--r-- | doc/manual/html_node/index.html | 14 |
4 files changed, 135 insertions, 8 deletions
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> [<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> [<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> [<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> [<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> [<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’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 ‘<samp>make info</samp>’ to build the docs with <samp>gendocs.sh</samp>. +</p><ul> +<li> ‘<samp>git commit</samp>’ and ‘<samp>git tag 6.0.4</samp>’ +</li><li> Export a tarball: +<ul> +<li> ‘<samp>git archive --format=tar.gz --prefix=librejs-6.0.4 6.0.4 >librejs-6.0.4.tar.gz</samp>’ +</li><li> ‘<samp>mv librejs-6.0.4.tar.gz ~/releases/librejs-6.0.4/</samp>’ +</li></ul> +</li><li> Make xpi file: ‘<samp>cfx xpi --strip-sdk; mv librejs.xpi librejs-6.0.4.xpi</samp>’ +</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> [<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> [<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> [<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> [<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">• <a href="Setting-Your-JavaScript-Free.html#Setting-Your-JavaScript-Free" accesskey="7">Setting Your JavaScript Free</a>:</td><td> </td><td align="left" valign="top">Information for website owners/maintainers. </td></tr> -<tr><td align="left" valign="top">• <a href="Installation-Requirements.html#Installation-Requirements" accesskey="8">Installation Requirements</a>:</td><td> </td><td align="left" valign="top">Requirements to build and install LibreJS. +<tr><td align="left" valign="top">• <a href="LibreJS-Development-Notes.html#LibreJS-Development-Notes" accesskey="8">LibreJS Development Notes</a>:</td><td> </td><td align="left" valign="top">Documentation about the development of + LibreJS itself. +</td></tr> +<tr><td align="left" valign="top">• <a href="Installation-Requirements.html#Installation-Requirements" accesskey="9">Installation Requirements</a>:</td><td> </td><td align="left" valign="top">Requirements to build and install LibreJS. </td></tr> -<tr><td align="left" valign="top">• <a href="LibreJS-Internals.html#LibreJS-Internals" accesskey="9">LibreJS Internals</a>:</td><td> </td><td align="left" valign="top">How LibreJS works under the hood. +<tr><td align="left" valign="top">• <a href="LibreJS-Internals.html#LibreJS-Internals">LibreJS Internals</a>:</td><td> </td><td align="left" valign="top">How LibreJS works under the hood. </td></tr> <tr><td align="left" valign="top">• <a href="Tests.html#Tests">Tests</a>:</td><td> </td><td align="left" valign="top">Test LibreJS and better understand it. </td></tr> |