Bug 629489 - Update mozStorage.h on how to add more errors
authorAllison Naaktgeboren <a.m.naaktgeboren@gmail.com>
Mon, 11 Apr 2011 13:56:06 -0700
changeset 67862 e72813d821b8c50f541418663c9ab8fa163bff35
parent 67861 f548afb7caca2700314b42f46a42400aba13cfaa
child 67863 832de5e41bd2f7a99038df4d9eb902f86c68d6bb
push id1
push userroot
push dateTue, 26 Apr 2011 22:38:44 +0000
treeherdermozilla-beta@bfdb6e623a36 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
bugs629489
milestone2.2a1pre
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 629489 - Update mozStorage.h on how to add more errors r=sdwilsh
storage/public/mozStorage.h
--- a/storage/public/mozStorage.h
+++ b/storage/public/mozStorage.h
@@ -31,16 +31,27 @@
  * use your version of this file under the terms of the MPL, indicate your
  * decision by deleting the provisions above and replace them with the notice
  * and other provisions required by the GPL or the LGPL. If you do not delete
  * the provisions above, a recipient may use your version of this file under
  * the terms of any one of the MPL, the GPL or the LGPL.
  *
  * ***** END LICENSE BLOCK ***** */
 
+/**
+ * To add additional errors to Storage, please append entries to the bottom of
+ * the list in the following format:
+ * '#define NS_ERROR_STORAGE_YOUR_ERR \
+ *    NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_STORAGE, n)'
+ * where n is the next unique positive integer.  You must also add an entry to
+ * js/src/xpconnect/src/xpc.msg under the code block beginning with the comment
+ * 'storage related codes (from mozStorage.h)', in the following format:
+ * 'XPC_MSG_DEF(NS_ERROR_STORAGE_YOUR_ERR, "brief description of your error")'
+ */
+
 #ifndef MOZSTORAGE_H
 #define MOZSTORAGE_H
 
 #define NS_ERROR_STORAGE_BUSY \
   NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_STORAGE, 1)
 
 #define NS_ERROR_STORAGE_IOERR \
   NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_STORAGE, 2)