gecko-dev/addon-sdk/source
Jim Blandy 7e20285e70 Bug 914753: Make Emacs file variable header lines correct, or at least consistent. DONTBUILD r=ehsan
The -*- file variable lines -*- establish per-file settings that Emacs will
pick up. This patch makes the following changes to those lines (and touches
nothing else):

 - Never set the buffer's mode.

   Years ago, Emacs did not have a good JavaScript mode, so it made sense
   to use Java or C++ mode in .js files. However, Emacs has had js-mode for
   years now; it's perfectly serviceable, and is available and enabled by
   default in all major Emacs packagings.

   Selecting a mode in the -*- file variable line -*- is almost always the
   wrong thing to do anyway. It overrides Emacs's default choice, which is
   (now) reasonable; and even worse, it overrides settings the user might
   have made in their '.emacs' file for that file extension. It's only
   useful when there's something specific about that particular file that
   makes a particular mode appropriate.

 - Correctly propagate settings that establish the correct indentation
   level for this file: c-basic-offset and js2-basic-offset should be
   js-indent-level. Whatever value they're given should be preserved;
   different parts of our tree use different indentation styles.

 - We don't use tabs in Mozilla JS code. Always set indent-tabs-mode: nil.
   Remove tab-width: settings, at least in files that don't contain tab
   characters.

 - Remove js2-mode settings that belong in the user's .emacs file, like
   js2-skip-preprocessor-directives.
2014-06-24 22:12:07 -07:00
..
app-extension Bug 1029207 - Uplift Add-on SDK to Firefox r=me 2014-06-24 10:36:52 -07:00
bin Bug 923719: Uplift Addon SDK to Firefox. r=me 2013-10-04 16:48:52 -07:00
examples Bug 1021280 - Uplift Add-on SDK to Firefox r=me 2014-06-05 16:22:03 -07:00
lib Bug 914753: Make Emacs file variable header lines correct, or at least consistent. DONTBUILD r=ehsan 2014-06-24 22:12:07 -07:00
python-lib Bug 1029207 - Uplift Add-on SDK to Firefox r=me 2014-06-24 10:36:52 -07:00
test Bug 1029207 - Uplift Add-on SDK to Firefox r=me 2014-06-24 10:36:52 -07:00
.gitattributes
.gitignore
.hgignore
.hgtags
LICENSE Bug 844183: Uplift Add-on SDK changeset 2bee189e1cb87f5fbe38ce862c8ff35ee0978480 2013-02-22 10:22:25 -08:00
mapping.json Bug 972925 - Uplift Add-on SDK to Firefox 2014-03-03 11:22:07 -08:00
package.json Bug 1029207 - Uplift Add-on SDK to Firefox r=me 2014-06-24 10:36:52 -07:00
README Bug 985956 - Uplift Add-on SDK to Firefox 2014-03-20 08:07:16 -07:00

Add-on SDK README
==================

Before proceeding, please make sure you've installed Python 2.5,
2.6, or 2.7 (if it's not already on your system):

  http://python.org/download/

Note that Python 3 is not supported.

For Windows users, MozillaBuild (https://wiki.mozilla.org/MozillaBuild)
will install the correct version of Python and the MSYS package, which
will make it easier to work with the SDK.

To get started, first enter the same directory that this README file
is in (the SDK's root directory) using a shell program. On Unix systems
or on Windows with MSYS, you can execute the following command:

  source bin/activate

Windows users using cmd.exe should instead run:

  bin\activate.bat

Then go to https://developer.mozilla.org/en-US/Add-ons/SDK/
to browse the SDK documentation.

If you get an error when running cfx or have any other problems getting
started, see the "Troubleshooting" guide at:
https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Troubleshooting

Bugs
-------

* file a bug: https://bugzilla.mozilla.org/enter_bug.cgi?product=Add-on%20SDK


Style Guidelines
--------------------

* https://github.com/mozilla/addon-sdk/wiki/Coding-style-guide