Skip to content

Commit c86416d

Browse files
fdovingHyperPeek
authored andcommitted
Doc: general updates to multiple files. (PR #959)
The following files are removed: - doc/gitian-building.md - doc/release-notes-pr12924.md - doc/travis-ci.md General updates to multiple other files to reflect the current workflow.
1 parent 88853c5 commit c86416d

13 files changed

+46
-308
lines changed

CONTRIBUTING.md

+15-12
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To contribute a patch, the workflow is as follows:
2626

2727
- Fork repository
2828
- Create topic branch
29-
- Commit patches
29+
- Create pull request
3030

3131
The project coding conventions in the [developer notes](doc/developer-notes.md)
3232
must be adhered to.
@@ -55,9 +55,12 @@ about Git.
5555
The title of the pull request should be prefixed by the component or area that
5656
the pull request affects. Valid areas as:
5757

58+
59+
- *Build* for changes to the build-system
5860
- *Consensus* for changes to consensus critical code
61+
- *Depends* for changes to depends
5962
- *Docs* for changes to the documentation
60-
- *Qt* for changes to raven-qt
63+
- *GUI* for changes to raven-qt
6164
- *Mining* for changes to the mining code
6265
- *Net* or *P2P* for changes to the peer-to-peer network code
6366
- *RPC/REST/ZMQ* for changes to the RPC, REST or ZMQ APIs
@@ -78,7 +81,7 @@ Examples:
7881

7982
Consensus: Add new opcode for RIP-XXXX OP_CHECKAWESOMESIG
8083
Net: Automatically create hidden service, listen on Tor
81-
Qt: Add feed bump button
84+
GUI: Add feed bump button
8285
Trivial: Fix typo in init.cpp
8386

8487
Note that translations should not be submitted as pull requests, please see
@@ -169,11 +172,11 @@ workload on reviewing.
169172
"Decision Making" Process
170173
-------------------------
171174

172-
The following applies to code changes to the Raven Core project (and related
173-
projects such as libsecp256k1), and is not to be confused with overall Raven
175+
The following applies to code changes to the Ravencoin project (and related
176+
projects) and is not to be confused with overall Ravencoin
174177
Network Protocol consensus changes.
175178

176-
Whether a pull request is merged into Raven Core rests with the project merge
179+
Whether a pull request is merged into Ravencoin rests with the project merge
177180
maintainers and ultimately the project lead.
178181

179182
Maintainers will take into consideration if a patch is in line with the general
@@ -191,7 +194,7 @@ In general, all pull requests must:
191194
- Where bugs are fixed, where possible, there should be unit tests
192195
demonstrating the bug and also proving the fix. This helps prevent regression.
193196

194-
Patches that change Raven consensus rules are considerably more involved than
197+
Patches that change Ravencoin consensus rules are considerably more involved than
195198
normal because they affect the entire ecosystem and so must be preceded by
196199
extensive mailing list discussions and have a numbered RIP. While each case will
197200
be different, one should be prepared to expend more time and effort than for
@@ -232,9 +235,9 @@ higher in terms of discussion and peer review requirements, keeping in mind that
232235
mistakes could be very costly to the wider community. This includes refactoring
233236
of consensus critical code.
234237

235-
Where a patch set proposes to change the Raven consensus, it must have been
236-
discussed extensively on the mailing list and Discord, be accompanied by a widely
237-
discussed RIP and have a generally widely perceived technical consensus of being
238+
Where a patch set proposes to change the Ravencoin consensus, it must have been
239+
discussed extensively, be accompanied by a widely discussed RIP and
240+
have a generally widely perceived technical consensus of being
238241
a worthwhile change based on the judgement of the maintainers.
239242

240243
### Finding Reviewers
@@ -263,7 +266,7 @@ about:
263266
[Git Blame feature](https://help.github.com/articles/tracing-changes-in-a-file/). Simply
264267
find the person touching the code you are touching before you and see if you can find
265268
them and give them a nudge. Don't be incessant about the nudging though.
266-
- Finally, if all else fails, ask on IRC or elsewhere for someone to give your pull request
269+
- Finally, if all else fails, ask on Discord or elsewhere for someone to give your pull request
267270
a look. If you think you've been waiting an unreasonably long amount of time (month+) for
268271
no particular reason (few lines changed, etc), this is totally fine. Try to return the favor
269272
when someone else is asking for feedback on their code, and universe balances out.
@@ -272,7 +275,7 @@ about:
272275
Release Policy
273276
--------------
274277

275-
The project leader is the release manager for each Raven Core release.
278+
The RavenQT-SIG selects a release manager for each Ravencoin release.
276279

277280
Copyright
278281
---------

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ The `master` branch is regularly built and tested, but is not guaranteed to be
2828
completely stable. [Tags](https://github.com/RavenProject/Ravencoin/tags) are created
2929
regularly to indicate new official, stable release versions of Raven Core.
3030

31+
Active development is done in the `develop` branch.
32+
3133
The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).
3234

3335
Developer IRC is inactive please join us on discord in #development. https://discord.gg/fndp4NBGct
@@ -40,9 +42,7 @@ requests than we can review and test on short notice. Please be patient and help
4042
other people's pull requests, and remember this is a security-critical project where any mistake might cost people
4143
lots of money.
4244

43-
Testnet is now up and running and available to use during development. There is an issue when connecting to the testnet that requires the use of the -maxtipage parameter in order to connect to the test network initially. After the initial launch the -maxtipage parameter is not required.
44-
45-
Use this command to initially start ravend on the testnet. <code>./ravend -testnet -maxtipage=259200</code>
45+
Testnet is up and running and available to use during development.
4646

4747
### Automated Testing
4848

doc/README.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,9 @@ sudo apt update
3636
sudo apt install libevent-dev libboost-all-dev libminiupnpc10 libzmq5 software-properties-common
3737
```
3838

39-
The wallet requires version 4.8 of the Berkeley DB. The easiest way to get it is from the bitcoin repository:
39+
The wallet requires version 4.8 of the Berkeley DB. The easiest way to get it is to build it with the script contrib/install_db4.sh
40+
4041

41-
```
42-
sudo add-apt-repository ppa:bitcoin/bitcoin
43-
sudo apt update
44-
sudo apt install libdb4.8-dev libdb4.8++-dev
4542
```
4643
4744
The GUI wallet requires the QR Code encoding library. Install with:

doc/benchmarking.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Benchmarking
22
============
33

4-
Raven Core has an internal benchmarking framework, with benchmarks
4+
Ravencoin has an internal benchmarking framework, with benchmarks
55
for cryptographic algorithms such as SHA1, SHA256, SHA512 and RIPEMD160. As well as the rolling bloom filter.
66

77
After compiling raven-core, the benchmarks can be run with:

doc/bips.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
BIPs that are implemented by Raven Core (up-to-date up to **v0.13.0**):
1+
BIPs that are implemented by Ravencoin (up-to-date up to **v0.13.0**):
22

33
* [`BIP 9`](https://github.com/bitcoin/bips/blob/master/bip-0009.mediawiki): The changes allowing multiple soft-forks to be deployed in parallel have been implemented since **v0.12.1** ([PR #7575](https://github.com/bitcoin/bitcoin/pull/7575))
44
* [`BIP 11`](https://github.com/bitcoin/bips/blob/master/bip-0011.mediawiki): Multisig outputs are standard since **v0.6.0** ([PR #669](https://github.com/bitcoin/bitcoin/pull/669)).

doc/developer-notes.md

+2-9
Original file line numberDiff line numberDiff line change
@@ -489,13 +489,10 @@ Subtrees
489489
----------
490490

491491
Several parts of the repository are subtrees of software maintained elsewhere.
492-
493-
Some of these are maintained by active developers of Raven Core, in which case changes should probably go
494-
directly upstream without being PRed directly against the project. They will be merged back in the next
495-
subtree merge.
492+
They will be merged back in the next subtree merge.
496493

497494
Others are external projects without a tight relationship with our project. Changes to these should also
498-
be sent upstream but bugfixes may also be prudent to PR against Raven Core so that they can be integrated
495+
be sent upstream but bugfixes may also be prudent to PR against Ravencoin so that they can be integrated
499496
quickly. Cosmetic changes should be purely taken upstream.
500497

501498
There is a tool in contrib/devtools/git-subtree-check.sh to check a subtree directory for consistency with
@@ -709,7 +706,3 @@ A few guidelines for introducing and reviewing new RPC interfaces:
709706
- *Rationale*: If a RPC response is not a JSON object then it is harder to avoid API breakage if
710707
new data in the response is needed.
711708

712-
713-
IRC Required Commit
714-
---------------------
715-
Required to register on IRC

doc/fuzzing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Fuzz-testing Raven Core
1+
Fuzz-testing Ravencoin
22
==========================
33

44
A special test harness `test_raven_fuzzy` is provided to provide an easy

doc/gitian-building.md

-4
This file was deleted.

doc/reduce-memory.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The size of some in-memory caches can be reduced. As caches trade off memory usa
2020

2121
- Do not use this when using the client to broadcast transactions as any transaction sent will stick out like a sore thumb, affecting privacy. When used with the wallet it should be combined with `-walletbroadcast=0` and `-spendzeroconfchange=0`. Another mechanism for broadcasting outgoing transactions (if any) should be used.
2222

23-
- Since `0.14.0`, unused memory allocated to the mempool (default: 300MB) is shared with the UTXO cache, so when trying to reduce memory usage you should limit the mempool, with the `-maxmempool` command line argument.
23+
- Since bitcoin `0.14.0`, unused memory allocated to the mempool (default: 300MB) is shared with the UTXO cache, so when trying to reduce memory usage you should limit the mempool, with the `-maxmempool` command line argument.
2424

2525
## Number of peers
2626

doc/release-notes-pr12924.md

-11
This file was deleted.

0 commit comments

Comments
 (0)