coding.txt converted to Unix EOL format
authoralexhz <balthazar@yandex.ru>
Mon, 15 Apr 2013 18:23:17 +0000 (18:23 +0000)
committeralexhz <balthazar@yandex.ru>
Mon, 15 Apr 2013 18:23:17 +0000 (18:23 +0000)
doc/README_windows.txt
doc/coding.txt

index 53545ab..f2ec585 100644 (file)
@@ -1,4 +1,4 @@
-NovaCoin 0.3.0 BETA\r
+NovaCoin 0.4.0 BETA\r
 \r
 Copyright (c) 2013 NovaCoin Developers\r
 Copyright (c) 2011-2013 PPCoin Developers\r
index b3c812a..46da661 100644 (file)
@@ -1,99 +1,99 @@
-Please be consistent with the existing coding style.\r
-\r
-Block style:\r
-\r
-bool Function(char* psz, int n)\r
-{\r
-    // Comment summarising what this section of code does\r
-    for (int i = 0; i < n; i++)\r
-    {\r
-        // When something fails, return early\r
-        if (!Something())\r
-            return false;\r
-        ...\r
-    }\r
-\r
-    // Success return is usually at the end\r
-    return true;\r
-}\r
-\r
-- ANSI/Allman block style\r
-- 4 space indenting, no tabs\r
-- No extra spaces inside parenthesis; please don't do ( this )\r
-- No space after function names, one space after if, for and while\r
-\r
-Variable names begin with the type in lowercase, like nSomeVariable.\r
-Please don't put the first word of the variable name in lowercase like\r
-someVariable.\r
-\r
-Common types:\r
-n       integer number: short, unsigned short, int, unsigned int,\r
-            int64, uint64, sometimes char if used as a number\r
-d       double, float\r
-f       flag\r
-hash    uint256\r
-p       pointer or array, one p for each level of indirection\r
-psz     pointer to null terminated string\r
-str     string object\r
-v       vector or similar list objects\r
-map     map or multimap\r
-set     set or multiset\r
-bn      CBigNum\r
-\r
--------------------------\r
-Locking/mutex usage notes\r
-\r
-The code is multi-threaded, and uses mutexes and the\r
-CRITICAL_BLOCK/TRY_CRITICAL_BLOCK macros to protect data structures.\r
-\r
-Deadlocks due to inconsistent lock ordering (thread 1 locks cs_main\r
-and then cs_wallet, while thread 2 locks them in the opposite order:\r
-result, deadlock as each waits for the other to release its lock) are\r
-a problem. Compile with -DDEBUG_LOCKORDER to get lock order\r
-inconsistencies reported in the debug.log file.\r
-\r
-Re-architecting the core code so there are better-defined interfaces\r
-between the various components is a goal, with any necessary locking\r
-done by the components (e.g. see the self-contained CKeyStore class\r
-and its cs_KeyStore lock for example).\r
-\r
--------\r
-Threads\r
-\r
-StartNode : Starts other threads.\r
-\r
-ThreadGetMyExternalIP : Determines outside-the-firewall IP address,\r
-sends addr message to connected peers when it determines it. \r
-\r
-ThreadIRCSeed : Joins IRC bootstrapping channel, watching for new\r
-peers and advertising this node's IP address. \r
-\r
-ThreadSocketHandler : Sends/Receives data from peers on port 8333.\r
-\r
-ThreadMessageHandler : Higher-level message handling (sending and\r
-receiving).\r
-\r
-ThreadOpenConnections : Initiates new connections to peers.\r
-\r
-ThreadTopUpKeyPool : replenishes the keystore's keypool.\r
-\r
-ThreadCleanWalletPassphrase : re-locks an encrypted wallet after user\r
-has unlocked it for a period of time. \r
-\r
-SendingDialogStartTransfer : used by pay-via-ip-address code (obsolete)\r
-\r
-ThreadDelayedRepaint : repaint the gui \r
-\r
-ThreadFlushWalletDB : Close the wallet.dat file if it hasn't been used\r
-in 500ms.\r
-\r
-ThreadRPCServer : Remote procedure call handler, listens on port 8332\r
-for connections and services them.\r
-\r
-ThreadBitcoinMiner : Generates bitcoins\r
-\r
-ThreadMapPort : Universal plug-and-play startup/shutdown\r
-\r
-Shutdown : Does an orderly shutdown of everything\r
-\r
-ExitTimeout : Windows-only, sleeps 5 seconds then exits application\r
+Please be consistent with the existing coding style.
+
+Block style:
+
+bool Function(char* psz, int n)
+{
+    // Comment summarising what this section of code does
+    for (int i = 0; i < n; i++)
+    {
+        // When something fails, return early
+        if (!Something())
+            return false;
+        ...
+    }
+
+    // Success return is usually at the end
+    return true;
+}
+
+- ANSI/Allman block style
+- 4 space indenting, no tabs
+- No extra spaces inside parenthesis; please don't do ( this )
+- No space after function names, one space after if, for and while
+
+Variable names begin with the type in lowercase, like nSomeVariable.
+Please don't put the first word of the variable name in lowercase like
+someVariable.
+
+Common types:
+n       integer number: short, unsigned short, int, unsigned int,
+            int64, uint64, sometimes char if used as a number
+d       double, float
+f       flag
+hash    uint256
+p       pointer or array, one p for each level of indirection
+psz     pointer to null terminated string
+str     string object
+v       vector or similar list objects
+map     map or multimap
+set     set or multiset
+bn      CBigNum
+
+-------------------------
+Locking/mutex usage notes
+
+The code is multi-threaded, and uses mutexes and the
+CRITICAL_BLOCK/TRY_CRITICAL_BLOCK macros to protect data structures.
+
+Deadlocks due to inconsistent lock ordering (thread 1 locks cs_main
+and then cs_wallet, while thread 2 locks them in the opposite order:
+result, deadlock as each waits for the other to release its lock) are
+a problem. Compile with -DDEBUG_LOCKORDER to get lock order
+inconsistencies reported in the debug.log file.
+
+Re-architecting the core code so there are better-defined interfaces
+between the various components is a goal, with any necessary locking
+done by the components (e.g. see the self-contained CKeyStore class
+and its cs_KeyStore lock for example).
+
+-------
+Threads
+
+StartNode : Starts other threads.
+
+ThreadGetMyExternalIP : Determines outside-the-firewall IP address,
+sends addr message to connected peers when it determines it. 
+
+ThreadIRCSeed : Joins IRC bootstrapping channel, watching for new
+peers and advertising this node's IP address. 
+
+ThreadSocketHandler : Sends/Receives data from peers on port 8333.
+
+ThreadMessageHandler : Higher-level message handling (sending and
+receiving).
+
+ThreadOpenConnections : Initiates new connections to peers.
+
+ThreadTopUpKeyPool : replenishes the keystore's keypool.
+
+ThreadCleanWalletPassphrase : re-locks an encrypted wallet after user
+has unlocked it for a period of time. 
+
+SendingDialogStartTransfer : used by pay-via-ip-address code (obsolete)
+
+ThreadDelayedRepaint : repaint the gui 
+
+ThreadFlushWalletDB : Close the wallet.dat file if it hasn't been used
+in 500ms.
+
+ThreadRPCServer : Remote procedure call handler, listens on port 8332
+for connections and services them.
+
+ThreadBitcoinMiner : Generates bitcoins
+
+ThreadMapPort : Universal plug-and-play startup/shutdown
+
+Shutdown : Does an orderly shutdown of everything
+
+ExitTimeout : Windows-only, sleeps 5 seconds then exits application