DOCS-83 Document exit codes

Author: Ed Costello

source/reference/exit-codes.txt

@@ -0,0 +1,48 @@
+============================
+MongoDB Exit and Error Codes
+============================
+
+.. errors::
+
+.. include:: /reference/exit-codes/exit_clean.txt
+   :start-after: mongod
+
+.. include:: /reference/exit-codes/exit_bad_options.txt
+   :start-after: mongod
+
+.. include:: /reference/exit-codes/exit_replication_error.txt
+   :start-after: mongod
+
+.. include:: /reference/exit-codes/exit_need_upgrade.txt
+   :start-after: mongod
+
+.. include:: /reference/exit-codes/exit_sharding_error.txt
+   :start-after: mongod
+
+.. include:: /reference/exit-codes/exit_kill.txt
+   :start-after: mongod
+
+.. include:: /reference/exit-codes/exit_abrupt.txt
+   :start-after: mongod
+
+.. include:: /reference/exit-codes/exit_ntservice_error.txt
+   :start-after: mongod
+
+.. include:: /reference/exit-codes/exit_ntservice_error.txt
+   :start-after: mongod
+
+.. include:: /reference/exit-codes/exit_fs.txt
+   :start-after: mongod
+
+.. include:: /reference/exit-codes/exit_clock_skew.txt
+   :start-after: mongod
+
+.. include:: /reference/exit-codes/exit_net_error.txt
+   :start-after: mongod
+
+.. include:: /reference/exit-codes/exit_windows_service_stop.txt
+   :start-after: mongod
+
+.. include:: /reference/exit-codes/exit_uncaught.txt
+   :start-after: mongod
+

source/reference/exit-codes/exit_abrupt.txt

@@ -0,0 +1,18 @@
+==============
+14 Abrupt Exit
+==============
+
+.. default-domain:: mongodb
+
+.. error:: 14
+
+   Returned by MongoDB applications which encounter an unrecoverable
+   error, an uncaught exception or uncaught signal.  The system exits
+   without performing a clean shut down.
+
+.. symbol: EXIT_ABRUPT = 14
+.. mongo/src/mongo/client/mongo_client_lib.cpp
+.. mongo/src/mongo/db/db.cpp
+.. mongo/src/mongo/s/server.cpp
+.. mongo/src/mongo/util/exit_code.h
+.. mongo/src/mongo/util/signal_handlers.cpp

source/reference/exit-codes/exit_bad_options.txt

@@ -0,0 +1,20 @@
+========================
+2 Bad Options
+========================
+
+.. default-domain:: mongodb
+
+.. error:: 2
+
+   The specified options are in error or are incompatible
+   with other options.
+   
+.. symbol: EXIT_BADOPTIONS 2
+
+.. /Users/epc/Documents/github/epc/mongo/src/mongo/db/db.cpp
+.. /Users/epc/Documents/github/epc/mongo/src/mongo/db/repl.cpp
+.. /Users/epc/Documents/github/epc/mongo/src/mongo/dbtests/framework.cpp
+.. /Users/epc/Documents/github/epc/mongo/src/mongo/s/config.cpp
+.. /Users/epc/Documents/github/epc/mongo/src/mongo/shell/dbshell.cpp
+.. /Users/epc/Documents/github/epc/mongo/src/mongo/tools/tool.cpp
+.. /Users/epc/Documents/github/epc/mongo/src/mongo/util/ntservice.cpp

source/reference/exit-codes/exit_clean.txt

@@ -0,0 +1,19 @@
+============
+0 Clean exit
+============
+
+.. default-domain:: mongodb
+
+.. error:: 0
+
+   Returned by MongoDB applications upon successful exit.
+   
+.. symbol: EXIT_CLEAN
+.. ./src/mongo/db/db.cpp
+.. ./src/mongo/db/dbcommands_generic.cpp
+.. ./src/mongo/dbtests/framework.cpp
+.. ./src/mongo/s/server.cpp
+.. ./src/mongo/shell/dbshell.cpp
+.. ./src/mongo/tools/restore.cpp
+.. ./src/mongo/tools/tool.cpp
+.. ./src/mongo/util/ntservice.cpp

source/reference/exit-codes/exit_clock_skew.txt

@@ -0,0 +1,13 @@
+===============
+47 Clock Skewed
+===============
+
+.. default-domain:: mongodb
+
+.. error:: 47
+
+   MongoDB applications exit cleanly if a large clock skew (32768 
+   milliseconds) occurs.
+
+.. symbol: EXIT_CLOCK_SKEW
+.. mongo/src/mongo/db/db.cpp

source/reference/exit-codes/exit_fs.txt

@@ -0,0 +1,14 @@
+===================
+45 Cannot open file
+===================
+
+.. default-domain:: mongodb
+
+.. error:: 45
+
+   Returned when a MongoDB application cannot open a file or cannot
+   obtain a lock on a file.
+
+.. Symbol: EXIT_FS
+.. found-in: mongo/db/namespace_details.cpp:192
+.. found-in: mongo/tools/tool.cpp:238

source/reference/exit-codes/exit_kill.txt

@@ -0,0 +1,13 @@
+===================
+12 Killed (Windows)
+===================
+
+.. default-domain:: mongodb
+
+.. error: 12
+
+   Returned by the :program:`mongod.exe` process on Windows when it
+   receives a Control-C, Close, Break or Shutdown event.
+
+.. symbol: EXIT_KILL = 12
+.. mongo/src/mongo/db/db.cpp

source/reference/exit-codes/exit_need_upgrade.txt

@@ -0,0 +1,17 @@
+================================
+4 Database Format Upgrade Needed
+================================
+
+.. default-domain:: mongodb
+
+.. error: 4
+
+   The version of the database is different from the version supported
+   by the :program:`mongod` (or :program:`mongod.exe`) instance.  The
+   instance exits cleanly.  Restart :program:`mongod` with the
+   :option:`--upgrade <mongod --upgrade>` option to upgrade the
+   database to the version supported by this :program:`mongod` 
+   instance.
+   
+.. symbol: EXIT_NEED_UPGRADE = 4 
+.. mongo/src/mongo/db/db.cpp

source/reference/exit-codes/exit_net_error.txt

@@ -0,0 +1,15 @@
+================
+48 Network Error
+================
+
+.. default-domain:: mongodb
+
+.. error:: 48
+
+   :program:`mongod` exits cleanly if the server socket (either
+   `27017` or the port specified with :option:`--port <mongod --port>`). 
+
+
+.. symbol: EXIT_NET_ERROR = 48 ,
+.. mongo/src/mongo/s/server.cpp
+.. mongo/src/mongo/db/db.cpp

source/reference/exit-codes/exit_ntservice_error.txt

@@ -0,0 +1,22 @@
+==============================
+20 NT Service Errors (Windows)
+============================== 
+
+.. default-domain:: mongodb
+
+   :program:`mongod.exe` returns this error code for multiple errors.
+   
+.. error:: 20 ERROR: wsastartup failed {reason}
+
+   Returned by MongoDB applications on Windows due to an error in the
+   WSAStartup function.
+   
+.. error:: 20 NT Service Error
+
+   Returned by MongoDB applications for Windows due to failures installing,
+   starting or removing the NT Service for the application.
+
+.. symbol: EXIT_NTSERVICE_ERROR = 20
+
+.. mongo/src/mongo/util/net/sock.cpp
+.. mongo/src/mongo/util/ntservice.cpp