final rebranding to NYC3
This commit is contained in:
+11
-11
@@ -22,7 +22,7 @@ Developer Notes
|
||||
- [Threads](#threads)
|
||||
- [Ignoring IDE/editor files](#ignoring-ideeditor-files)
|
||||
- [Development guidelines](#development-guidelines)
|
||||
- [General Bitcoin Core](#general-bitcoin-core)
|
||||
- [General NYC3](#general-bitcoin-core)
|
||||
- [Wallet](#wallet)
|
||||
- [General C++](#general-c)
|
||||
- [C++ data structures](#c-data-structures)
|
||||
@@ -130,7 +130,7 @@ Refer to [/test/functional/README.md#style-guidelines](/test/functional/README.m
|
||||
Coding Style (Doxygen-compatible comments)
|
||||
------------------------------------------
|
||||
|
||||
Bitcoin Core uses [Doxygen](http://www.doxygen.nl/) to generate its official documentation.
|
||||
NYC3 uses [Doxygen](http://www.doxygen.nl/) to generate its official documentation.
|
||||
|
||||
Use Doxygen-compatible comment blocks for functions, methods, and fields.
|
||||
|
||||
@@ -229,7 +229,7 @@ that run in `-regtest` mode.
|
||||
|
||||
### DEBUG_LOCKORDER
|
||||
|
||||
Bitcoin Core is a multi-threaded application, and deadlocks or other
|
||||
NYC3 is a multi-threaded application, and deadlocks or other
|
||||
multi-threading bugs can be very difficult to track down. The `--enable-debug`
|
||||
configure option adds `-DDEBUG_LOCKORDER` to the compiler flags. This inserts
|
||||
run-time checks to keep track of which locks are held, and adds warnings to the
|
||||
@@ -313,7 +313,7 @@ See the functional test documentation for how to invoke perf within tests.
|
||||
|
||||
**Sanitizers**
|
||||
|
||||
Bitcoin Core can be compiled with various "sanitizers" enabled, which add
|
||||
NYC3 can be compiled with various "sanitizers" enabled, which add
|
||||
instrumentation for issues regarding things like memory safety, thread race
|
||||
conditions, or undefined behavior. This is controlled with the
|
||||
`--with-sanitizers` configure flag, which should be a comma separated list of
|
||||
@@ -412,7 +412,7 @@ Ignoring IDE/editor files
|
||||
In closed-source environments in which everyone uses the same IDE it is common
|
||||
to add temporary files it produces to the project-wide `.gitignore` file.
|
||||
|
||||
However, in open source software such as Bitcoin Core, where everyone uses
|
||||
However, in open source software such as NYC3, where everyone uses
|
||||
their own editors/IDE/tools, it is less common. Only you know what files your
|
||||
editor produces and this may change from version to version. The canonical way
|
||||
to do this is thus to create your local gitignore. Add this to `~/.gitconfig`:
|
||||
@@ -442,9 +442,9 @@ Development guidelines
|
||||
============================
|
||||
|
||||
A few non-style-related recommendations for developers, as well as points to
|
||||
pay attention to for reviewers of Bitcoin Core code.
|
||||
pay attention to for reviewers of NYC3 code.
|
||||
|
||||
General Bitcoin Core
|
||||
General NYC3
|
||||
----------------------
|
||||
|
||||
- New features should be exposed on RPC first, then can be made available in the GUI
|
||||
@@ -602,7 +602,7 @@ Strings and formatting
|
||||
|
||||
- For `strprintf`, `LogPrint`, `LogPrintf` formatting characters don't need size specifiers
|
||||
|
||||
- *Rationale*: Bitcoin Core uses tinyformat, which is type safe. Leave them out to avoid confusion
|
||||
- *Rationale*: NYC3 uses tinyformat, which is type safe. Leave them out to avoid confusion
|
||||
|
||||
Variable names
|
||||
--------------
|
||||
@@ -769,12 +769,12 @@ Subtrees
|
||||
|
||||
Several parts of the repository are subtrees of software maintained elsewhere.
|
||||
|
||||
Some of these are maintained by active developers of Bitcoin Core, in which case changes should probably go
|
||||
Some of these are maintained by active developers of NYC3, in which case changes should probably go
|
||||
directly upstream without being PRed directly against the project. They will be merged back in the next
|
||||
subtree merge.
|
||||
|
||||
Others are external projects without a tight relationship with our project. Changes to these should also
|
||||
be sent upstream but bugfixes may also be prudent to PR against Bitcoin Core so that they can be integrated
|
||||
be sent upstream but bugfixes may also be prudent to PR against NYC3 so that they can be integrated
|
||||
quickly. Cosmetic changes should be purely taken upstream.
|
||||
|
||||
There is a tool in `test/lint/git-subtree-check.sh` to check a subtree directory for consistency with
|
||||
@@ -969,7 +969,7 @@ A few guidelines for introducing and reviewing new RPC interfaces:
|
||||
RPCs whose behavior does *not* depend on the current chainstate may omit this
|
||||
call.
|
||||
|
||||
- *Rationale*: In previous versions of Bitcoin Core, the wallet was always
|
||||
- *Rationale*: In previous versions of NYC3, the wallet was always
|
||||
in-sync with the chainstate (by virtue of them all being updated in the
|
||||
same cs_main lock). In order to maintain the behavior that wallet RPCs
|
||||
return results as of at least the highest best-known block an RPC
|
||||
|
||||
Reference in New Issue
Block a user