From 3408c70243f8f9097feed86df427d975d23cc538 Mon Sep 17 00:00:00 2001 From: Nik Nyby Date: Sat, 27 Jun 2015 10:55:46 -0400 Subject: update docs for jpm --- doc/librejs.info | 64 ++++++++------------- doc/librejs.texi | 41 +++++-------- .../html_node/Installation-Requirements.html | 46 +++++---------- doc/manual/html_node/Installation.html | 2 +- doc/manual/html_node/index.html | 2 +- doc/manual/librejs.dvi.gz | Bin 32350 -> 32104 bytes doc/manual/librejs.html | 45 +++++---------- doc/manual/librejs.html.gz | Bin 21395 -> 21250 bytes doc/manual/librejs.html_node.tar.gz | Bin 23391 -> 23263 bytes doc/manual/librejs.info.tar.gz | Bin 19151 -> 18982 bytes doc/manual/librejs.pdf | Bin 206511 -> 206232 bytes doc/manual/librejs.texi.tar.gz | Bin 18873 -> 18692 bytes doc/manual/librejs.txt | 48 ++++++---------- doc/manual/librejs.txt.gz | Bin 18124 -> 17966 bytes 14 files changed, 85 insertions(+), 163 deletions(-) diff --git a/doc/librejs.info b/doc/librejs.info index f3ee4f9..ae23807 100644 --- a/doc/librejs.info +++ b/doc/librejs.info @@ -90,8 +90,8 @@ or by building it from source. 3.1 Building the Package ======================== -After enabling the Add-on SDK, you should be able to use the 'make' -command to build LibreJS from source. +After installing 'jpm', you should be able to use the 'make' command to +build LibreJS from source. After running 'make', a new file, 'librejs.xpi' should be generated. This is the file that can be installed in a Mozilla browser. @@ -647,40 +647,26 @@ LibreJS has been tested extensively on multiple GNU/Linux distributions, but it is compatible any operating system as long as you're using a compatible Mozilla browser. -A.2 Mozilla's Add-on SDK -======================== - -LibreJS uses the Mozilla Add-on SDK (Software Development Kit), a set of -APIs and tools to create add-ons for Mozilla browsers. - - You do not need the Add-on SDK to use LibreJS xpi file or to install -it using the packaged version, but it is required in order to package -the LibreJS source code into an xpi file using 'make'. If you would -like to run the tests for LibreJS or make changes to the source files, -you will need the Add-on SDK as well. For the "make" command to work -properly, you must have the 'cfx' command available on your system from -the command line. - - The latest tarball for the Add-on SDK is available at: - - - - Instructions on how to get it working are available here: +A.2 Mozilla's Jetpack Manager for Node.js +========================================= - +LibreJS uses the Mozilla 'jpm' tool, a set of utilities for creating, +testing, running and packaging Mozilla Jetpack Addons. - In order to use 'make' with LibreJS source, however, it is ideal to -have 'cfx' available at all times and for all users. + You do not need 'jpm' to use the LibreJS xpi file or to install it +using the packaged version, but it is required in order to package the +LibreJS source code into an xpi file. If you would like to run the +tests for LibreJS or make changes to the source files, you will need +'jpm' as well. For the "make" command to work properly, you must have +the 'jpm' command available on your system from the command line. - An easy way to do this is to extract the contents of the tarball and -to place the files inside '/usr/lib/addon-sdk' and then creating a -symbolic link in '/usr/bin', as follows: + You can find information on getting 'jpm' at these links: - sudo ln -s /usr/lib/addon-sdk/bin/cfx /usr/bin/cfx + - The 'cfx' command will then be available to all users. + - The Add-on SDK is released under the Mozilla Public License 2.0. + JPM is released under the Mozilla Public License 2.0.  File: librejs.info, Node: LibreJS Internals, Next: Tests, Prev: Installation Requirements, Up: Top @@ -1285,14 +1271,14 @@ Node: Top841 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 +Node: How to Use4189 +Node: JavaScript Detection7431 +Node: Free Licenses Detection10839 +Node: Setting Your JavaScript Free17257 +Node: LibreJS Development Notes24091 +Node: Installation Requirements25463 +Node: LibreJS Internals27070 +Node: Tests28233 +Node: GNU Free Documentation License32740  End Tag Table diff --git a/doc/librejs.texi b/doc/librejs.texi index a19047e..98c2d62 100644 --- a/doc/librejs.texi +++ b/doc/librejs.texi @@ -106,7 +106,7 @@ file, or by building it from source. @section Building the Package -After enabling the Add-on SDK, you should be able to use the @code{make} +After installing @code{jpm}, you should be able to use the @code{make} command to build LibreJS from source. After running @code{make}, a new file, @file{librejs.xpi} should be @@ -784,40 +784,25 @@ LibreJS has been tested extensively on multiple GNU/Linux distributions, but it is compatible any operating system as long as you're using a compatible Mozilla browser. -@appendixsec Mozilla's Add-on SDK -LibreJS uses the Mozilla Add-on SDK (Software Development Kit), a -set of APIs and tools to create add-ons for Mozilla browsers. +@appendixsec Mozilla's Jetpack Manager for Node.js +LibreJS uses the Mozilla @code{jpm} tool, a set of utilities for +creating, testing, running and packaging Mozilla Jetpack Addons. -You do not need the Add-on SDK to use LibreJS xpi file or to install it +You do not need @code{jpm} to use the LibreJS xpi file or to install it using the packaged version, but it is required in order to package the -LibreJS source code into an xpi file using @code{make}. If you would like -to run the tests for LibreJS or make changes to the source files, you -will need the Add-on SDK as well. For the ``make'' command to work -properly, you must have the @code{cfx} command available on your system +LibreJS source code into an xpi file. If you would like to run the +tests for LibreJS or make changes to the source files, you +will need @code{jpm} as well. For the ``make'' command to work +properly, you must have the @code{jpm} command available on your system from the command line. -The latest tarball for the Add-on SDK is available at: +You can find information on getting @code{jpm} at these links: -@url{https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.tar.gz} +@url{https://www.npmjs.com/package/jpm} -Instructions on how to get it working are available here: +@url{https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_%28jpm%29} -@url{https://addons.mozilla.org/en-US/developers/docs/sdk/latest/dev-guide/tutorials/installation.html} - -In order to use @code{make} with LibreJS source, however, it is ideal to -have @code{cfx} available at all times and for all users. - -An easy way to do this is to extract the contents of the tarball and to -place the files inside @file{/usr/lib/addon-sdk} and then creating a -symbolic link in @file{/usr/bin}, as follows: - -@example -sudo ln -s /usr/lib/addon-sdk/bin/cfx /usr/bin/cfx -@end example - -The @code{cfx} command will then be available to all users. - -The Add-on SDK is released under the Mozilla Public License 2.0. +JPM is released under the Mozilla Public License 2.0. @node LibreJS Internals @appendix LibreJS Internals diff --git a/doc/manual/html_node/Installation-Requirements.html b/doc/manual/html_node/Installation-Requirements.html index 720d26b..61db3c3 100644 --- a/doc/manual/html_node/Installation-Requirements.html +++ b/doc/manual/html_node/Installation-Requirements.html @@ -84,47 +84,27 @@ LibreJS has been tested extensively on multiple GNU/Linux distributions, but it is compatible any operating system as long as you’re using a compatible Mozilla browser.

- -

A.2 Mozilla’s Add-on SDK

-

LibreJS uses the Mozilla Add-on SDK (Software Development Kit), a -set of APIs and tools to create add-ons for Mozilla browsers. + +

A.2 Mozilla’s Jetpack Manager for Node.js

+

LibreJS uses the Mozilla jpm tool, a set of utilities for +creating, testing, running and packaging Mozilla Jetpack Addons.

-

You do not need the Add-on SDK to use LibreJS xpi file or to install it +

You do not need jpm to use the LibreJS xpi file or to install it using the packaged version, but it is required in order to package the -LibreJS source code into an xpi file using make. If you would like -to run the tests for LibreJS or make changes to the source files, you -will need the Add-on SDK as well. For the “make” command to work -properly, you must have the cfx command available on your system +LibreJS source code into an xpi file. If you would like to run the +tests for LibreJS or make changes to the source files, you +will need jpm as well. For the “make” command to work +properly, you must have the jpm command available on your system from the command line.

-

The latest tarball for the Add-on SDK is available at: +

You can find information on getting jpm at these links:

-

https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.tar.gz +

https://www.npmjs.com/package/jpm

-

Instructions on how to get it working are available here: +

https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_%28jpm%29

-

https://addons.mozilla.org/en-US/developers/docs/sdk/latest/dev-guide/tutorials/installation.html +

JPM is released under the Mozilla Public License 2.0.

-

In order to use make with LibreJS source, however, it is ideal to -have cfx available at all times and for all users. -

-

An easy way to do this is to extract the contents of the tarball and to -place the files inside /usr/lib/addon-sdk and then creating a -symbolic link in /usr/bin, as follows: -

-
-
sudo ln -s /usr/lib/addon-sdk/bin/cfx /usr/bin/cfx
-
- -

The cfx command will then be available to all users. -

-

The Add-on SDK is released under the Mozilla Public License 2.0. -

-
-
-

-Next: , Previous: , Up: Top   [Contents]

-
diff --git a/doc/manual/html_node/Installation.html b/doc/manual/html_node/Installation.html index cc65d82..de5dac5 100644 --- a/doc/manual/html_node/Installation.html +++ b/doc/manual/html_node/Installation.html @@ -76,7 +76,7 @@ file, or by building it from source.

3.1 Building the Package

-

After enabling the Add-on SDK, you should be able to use the make +

After installing jpm, you should be able to use the make command to build LibreJS from source.

After running make, a new file, librejs.xpi should be diff --git a/doc/manual/html_node/index.html b/doc/manual/html_node/index.html index b7e668d..41b9b4b 100644 --- a/doc/manual/html_node/index.html +++ b/doc/manual/html_node/index.html @@ -109,7 +109,7 @@ ul.no-bullet {list-style: none}

  • Appendix A Installation Requirements
  • Appendix B LibreJS Internals
  • Appendix C Tests
    • diff --git a/doc/manual/librejs.dvi.gz b/doc/manual/librejs.dvi.gz index 74a1b40..dbae202 100644 Binary files a/doc/manual/librejs.dvi.gz and b/doc/manual/librejs.dvi.gz differ diff --git a/doc/manual/librejs.html b/doc/manual/librejs.html index 8569cd8..14c0847 100644 --- a/doc/manual/librejs.html +++ b/doc/manual/librejs.html @@ -108,7 +108,7 @@ ul.no-bullet {list-style: none}
  • Appendix A Installation Requirements
  • Appendix B LibreJS Internals
  • Appendix C Tests
    • @@ -219,7 +219,7 @@ file, or by building it from source.

    3.1 Building the Package

    -

    After enabling the Add-on SDK, you should be able to use the make +

    After installing jpm, you should be able to use the make command to build LibreJS from source.

    After running make, a new file, librejs.xpi should be @@ -848,41 +848,26 @@ LibreJS has been tested extensively on multiple GNU/Linux distributions, but it is compatible any operating system as long as you’re using a compatible Mozilla browser.

    - -

    A.2 Mozilla’s Add-on SDK

    -

    LibreJS uses the Mozilla Add-on SDK (Software Development Kit), a -set of APIs and tools to create add-ons for Mozilla browsers. + +

    A.2 Mozilla’s Jetpack Manager for Node.js

    +

    LibreJS uses the Mozilla jpm tool, a set of utilities for +creating, testing, running and packaging Mozilla Jetpack Addons.

    -

    You do not need the Add-on SDK to use LibreJS xpi file or to install it +

    You do not need jpm to use the LibreJS xpi file or to install it using the packaged version, but it is required in order to package the -LibreJS source code into an xpi file using make. If you would like -to run the tests for LibreJS or make changes to the source files, you -will need the Add-on SDK as well. For the “make” command to work -properly, you must have the cfx command available on your system +LibreJS source code into an xpi file. If you would like to run the +tests for LibreJS or make changes to the source files, you +will need jpm as well. For the “make” command to work +properly, you must have the jpm command available on your system from the command line.

    -

    The latest tarball for the Add-on SDK is available at: +

    You can find information on getting jpm at these links:

    -

    https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.tar.gz +

    https://www.npmjs.com/package/jpm

    -

    Instructions on how to get it working are available here: +

    https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_%28jpm%29

    -

    https://addons.mozilla.org/en-US/developers/docs/sdk/latest/dev-guide/tutorials/installation.html -

    -

    In order to use make with LibreJS source, however, it is ideal to -have cfx available at all times and for all users. -

    -

    An easy way to do this is to extract the contents of the tarball and to -place the files inside /usr/lib/addon-sdk and then creating a -symbolic link in /usr/bin, as follows: -

    -
    -
    sudo ln -s /usr/lib/addon-sdk/bin/cfx /usr/bin/cfx
-
    - -

    The cfx command will then be available to all users. -

    -

    The Add-on SDK is released under the Mozilla Public License 2.0. +

    JPM is released under the Mozilla Public License 2.0.

    diff --git a/doc/manual/librejs.html.gz b/doc/manual/librejs.html.gz index f1c2743..85809b9 100644 Binary files a/doc/manual/librejs.html.gz and b/doc/manual/librejs.html.gz differ diff --git a/doc/manual/librejs.html_node.tar.gz b/doc/manual/librejs.html_node.tar.gz index d5a9c88..bca049e 100644 Binary files a/doc/manual/librejs.html_node.tar.gz and b/doc/manual/librejs.html_node.tar.gz differ diff --git a/doc/manual/librejs.info.tar.gz b/doc/manual/librejs.info.tar.gz index 72a1a41..8be93b6 100644 Binary files a/doc/manual/librejs.info.tar.gz and b/doc/manual/librejs.info.tar.gz differ diff --git a/doc/manual/librejs.pdf b/doc/manual/librejs.pdf index c464ae2..cdb987d 100644 Binary files a/doc/manual/librejs.pdf and b/doc/manual/librejs.pdf differ diff --git a/doc/manual/librejs.texi.tar.gz b/doc/manual/librejs.texi.tar.gz index 640a41d..12a1ab0 100644 Binary files a/doc/manual/librejs.texi.tar.gz and b/doc/manual/librejs.texi.tar.gz differ diff --git a/doc/manual/librejs.txt b/doc/manual/librejs.txt index 5ae723b..dcbe22a 100644 --- a/doc/manual/librejs.txt +++ b/doc/manual/librejs.txt @@ -24,7 +24,7 @@ LibreJS 8.4 Releasing a new version Appendix A Installation Requirements A.1 Mozilla Browser - A.2 Mozilla's Add-on SDK + A.2 Mozilla's Jetpack Manager for Node.js Appendix B LibreJS Internals Appendix C Tests Appendix D GNU Free Documentation License @@ -72,8 +72,8 @@ or by building it from source. 3.1 Building the Package ======================== -After enabling the Add-on SDK, you should be able to use the 'make' -command to build LibreJS from source. +After installing 'jpm', you should be able to use the 'make' command to +build LibreJS from source. After running 'make', a new file, 'librejs.xpi' should be generated. This is the file that can be installed in a Mozilla browser. @@ -611,40 +611,26 @@ LibreJS has been tested extensively on multiple GNU/Linux distributions, but it is compatible any operating system as long as you're using a compatible Mozilla browser. -A.2 Mozilla's Add-on SDK -======================== - -LibreJS uses the Mozilla Add-on SDK (Software Development Kit), a set of -APIs and tools to create add-ons for Mozilla browsers. - - You do not need the Add-on SDK to use LibreJS xpi file or to install -it using the packaged version, but it is required in order to package -the LibreJS source code into an xpi file using 'make'. If you would -like to run the tests for LibreJS or make changes to the source files, -you will need the Add-on SDK as well. For the "make" command to work -properly, you must have the 'cfx' command available on your system from -the command line. - - The latest tarball for the Add-on SDK is available at: - - - - Instructions on how to get it working are available here: +A.2 Mozilla's Jetpack Manager for Node.js +========================================= - +LibreJS uses the Mozilla 'jpm' tool, a set of utilities for creating, +testing, running and packaging Mozilla Jetpack Addons. - In order to use 'make' with LibreJS source, however, it is ideal to -have 'cfx' available at all times and for all users. + You do not need 'jpm' to use the LibreJS xpi file or to install it +using the packaged version, but it is required in order to package the +LibreJS source code into an xpi file. If you would like to run the +tests for LibreJS or make changes to the source files, you will need +'jpm' as well. For the "make" command to work properly, you must have +the 'jpm' command available on your system from the command line. - An easy way to do this is to extract the contents of the tarball and -to place the files inside '/usr/lib/addon-sdk' and then creating a -symbolic link in '/usr/bin', as follows: + You can find information on getting 'jpm' at these links: - sudo ln -s /usr/lib/addon-sdk/bin/cfx /usr/bin/cfx + - The 'cfx' command will then be available to all users. + - The Add-on SDK is released under the Mozilla Public License 2.0. + JPM is released under the Mozilla Public License 2.0. Appendix B LibreJS Internals **************************** diff --git a/doc/manual/librejs.txt.gz b/doc/manual/librejs.txt.gz index 4c3514b..90735a4 100644 Binary files a/doc/manual/librejs.txt.gz and b/doc/manual/librejs.txt.gz differ -- cgit v1.2.3