Commit graph

153 commits

Author SHA1 Message Date
David A. Harding
73eb097dd4
Dev Docs: REST: Add Security Note & Reindex Note
Added both notes to both JSON-RPC and REST docs.

Suggested by Jonas Schnelli (thanks!)
2015-01-26 14:41:05 -05:00
David A. Harding
5f532c59da
Dev Docs: Add REST Documentation
* Uses same basic format as JSON-RPC documentation.

Closes #715
2015-01-26 11:29:07 -05:00
David A. Harding
81d4f310d6
Dev Docs: Add Missing Details To ListTransactions RPC
Looks like I lost/forgot to include the variablized-table for this RPC.
2015-01-10 13:32:22 -05:00
shaulkf
e68d8f2f83 Dev Docs: Specify block halving time in regtest mode 2015-01-10 11:45:03 -05:00
David A. Harding
2d46b41e3e
Dev Docs: Update IsStandard ScriptSig Size For BCC 0.9.3/10.0.0
Also fix a few other minor issues in that section.

Thanks to gsalgado for reporting this!  Closes #705
2015-01-08 10:43:39 -05:00
David A. Harding
ddbc448553
Dev Docs: Fix Confusion About Chain Switching
As discussed on BitcoinTalk, there was confusion about whether a
non-upgraded node would switch to the strongest chain despite that chain
not following the consensus rules known to the non-upgraded node.  Also
updated to mention Bitcoin Core 0.10.0 now that it's RC'd.

Ref: https://bitcointalk.org/index.php?topic=909732.msg9999032#msg9999032
2015-01-03 09:36:28 -05:00
David A. Harding
9329c69cf8
Dev Docs: Put RPC Tables In Separate CSS Class
Suggested by Saivann: RPC tables with Name/Type/Presence/Description
format are now in .ntpd CSS class so that we can format them specially.

We also change the style of all dev doc tables to replace bold table
headings (thead) with a double-line border-bottom.  This makes the
theads look less like section headings and prevents us from over-using
bold.

Minor: a Makefile warning message has been made more explicit (also
suggested by Saivann) and another Makefile rule was updated to catch
more broken tables.
2014-12-30 16:03:19 -05:00
David A. Harding
b8abfb2dcd
Dev Docs: Add 114 Pages Of New/Rewritten RPC Docs
* All previously-documented RPCs have had their text completely
  rewritten.

* All new RPCs and changed RPCs in Bitcoin Core 0.10.0 have been
  documented, except for hidden RPCs.

* A new RPC "Quick Reference" section has been added to make finding the
  right RPC easier.

* A "See Also" subsection has been added to the end of every RPC
  pointing to other relevant information.

* All previous examples in the RPC section have been re-run and updated
  as necessary.

* Syntax highlighting has been added wherever possible.

* Hash byte order has been specified as RPC byte order everywhere it's
  used in RPCs.
2014-12-24 18:46:03 -05:00
David A. Harding
e91bbd774c
Merge pull #688: Dev Docs: Briefly Describe JSON-RPC Format & bitcoin-cli 2014-12-23 08:59:37 -05:00
Saivann
d7db481feb Use consistent lowercase "bitcoin-cli" 2014-12-21 13:48:52 -05:00
Saivann
33b989dc34 Align RPC names in tables 2014-12-21 13:48:32 -05:00
Saivann
036493c0d9 Fix a broken icon link 2014-12-20 23:25:43 -05:00
David A. Harding
51a5a1b24a
Dev Docs: Briefly Describe JSON-RPC Format & bitcoin-cli
Briefly describe the JSON-RPC 1.0 format as used by Bitcoin Core and how
bitcoin-cli abstracts away some of the details.   Also link to the
Proper Money Handling wiki page.  (This as a vanguard PR preparing the
way for a larger overhaul of our RPC docs, including updating them for
0.10.)
2014-12-19 16:45:46 -05:00
David A. Harding
82f00e8df9
Dev Docs: Add Subhead-Links To "Not A Spec" Subsection 2014-12-16 07:42:43 -05:00
David A. Harding
f08b3e1bb4 Dev Docs: Remove Majority Mentions In Not A Spec (thanks saivann) 2014-12-16 07:40:01 -05:00
David A. Harding
8f0a80a939 Dev Docs: "Not A Specification"
Make explicit that the docs are not a specification and never will be.
2014-12-16 07:40:01 -05:00
David A. Harding
34edbe8461
Merge pull #682: Dev Docs: Add "Edit|History|Report Issue|Discuss" Links To Subheads 2014-12-16 07:13:19 -05:00
David A. Harding
53d4a6eebe
Dev Docs: Move Manual Sourcefile Lines To Auto Helper (thanks saivann!) 2014-12-14 08:12:12 -05:00
David A. Harding
f368d38e04
Dev Docs: Add "Edit|History|Report Issue|Discuss" Links To Subheads 2014-12-13 17:35:21 -05:00
David A. Harding
66bffab758
Dev Docs: Update Disclaimer (thanks saivann!) 2014-12-12 19:59:20 -05:00
David A. Harding
25acab7584
Clarify Tx Update To Header Hashing I/O (closes #675)
Thanks darren-a and Saïvann.
2014-12-10 20:48:31 -05:00
David A. Harding
217ddb0701
Dev Docs (Formatting Only): Convert Fake Subheadings To Real Subheadings
Converts fake subheadings created using **bold** to real HTML
subheadings without adding them to the table of contents.

Also fixes a link broken by commit 4e067ac89e and adds a Makefile
test to catch future similar breakage.
2014-11-28 19:54:31 -05:00
David A. Harding
464272eeb0
Merge Pull #657: Dev Docs: Describe Filterload Message (Final P2P Message To Document) 2014-11-28 19:30:20 -05:00
Saivann
64a6f780be Merge branch 'license' 2014-11-28 10:54:28 -05:00
David A. Harding
b3c14aad89
Dev Docs: Made Corrections To Filterload Docs Suggested By @saivann (Thanks!) 2014-11-27 21:36:10 -05:00
David A. Harding
a8fd82c6a6 Dev Docs: Describe Filterload Message (Final P2P Message To Document)
New material:

* Add documentation for `filterload` message to devref. This is the last
  P2P protocol message which needed documentation.

* Add an example for creating a bloom filter to the devex, as well as an
  example of checking data against that filter.

Edits:

* Change "object" to "element" in previous `filteradd` text. I decided
  "transaction element" made more sense than the more generic "object".
  Text should be fully consistent across both `filterload` and
  `filteradd` descriptions.

* Mentioned that I think the example hexdump in the `alert` section is
  public domain. (Only the hex is taken from the wiki; the annotation is
  my own work.)
2014-11-27 21:27:01 -05:00
David A. Harding
b9ee23615a
Dev Docs: Change MerkleBlock To Merkle Block (But Not P2P Message Form) 2014-11-27 21:13:14 -05:00
David A. Harding
ecd5a349aa
Dev Docs: Correct Connection Establishment Message Order
Text said: version/verack/version/verack.  Correct order (per code and
my own testing) is version/version/verack/verack.
2014-11-24 10:02:21 -05:00
David A. Harding
4e067ac89e
Merge branch 'control-messages' (pull #649) 2014-11-22 00:06:29 -05:00
David A. Harding
bc69bf573c
Dev Docs: Link To CC-BY License For Covered Code
A code snippet from the wiki was correctly attributed to its author, but
I didn't realize I also had to link to the license.  Corrected.
2014-11-21 23:54:48 -05:00
Saivann
2a139a51a1 Set license files and headers for bitcoin.org's content 2014-11-21 19:09:12 -05:00
David A. Harding
f26a57e10e
Dev Docs: Prefix Table Rows With Added/Updated Status
Suggested by @saivann (thanks!)
2014-11-20 21:08:08 -05:00
David A. Harding
25dc0228f6 Merge remote-tracking branch 'saivann/protocolversions' into control-messages 2014-11-20 20:39:20 -05:00
Saivann
12685e71f3 Fix a few typos 2014-11-20 19:49:16 -05:00
Saivann
022ad12eaf Normalize references to protocol versions 2014-11-20 19:41:03 -05:00
David A. Harding
ff9c3f9886
Dev Docs: Warn That GetWork RPC Will Be Removed In 0.10
Just saw this mentioned in IRC and it's a trivial change.
2014-11-18 10:31:43 -05:00
David A. Harding
a149ae1f37
Dev Docs: Describe Almost All Remaining P2P Network Messages
* Describes all remaining messages except filterload. Specificially, the
  following messages are described: Addr, Alert, FilterAdd, FilterClear,
  GetAddr, Ping, Pong, Reject, VerAck, and Version

* New makefile test: report broken markdown tables

* Put relevant protocol version changes at the top of all message
  subsections.
2014-11-17 01:23:11 -05:00
David A. Harding
e29104fb82
Dev Docs: Fix Broken BitcoinJ Link
The makefile tests caught this, but it looks like I broke it back in
4553439e. Strangely, I did a full build before merging that commit---and
several more full builds since---and this is the first I'm noticing the
error. I'm fixing the broken link now; I'll look into the tests later.
2014-11-16 13:35:16 -05:00
David A. Harding
cc13a10623
Merge branch 'data-messages' (pull #642) 2014-11-16 13:20:54 -05:00
Saivann
bf2a40bdb7 Update hu translations 2014-11-15 16:21:14 -05:00
David A. Harding
9ee7b8b73b
Dev Docs: Fix Typos/Confusions In P2P Data Messages As Reported By @saivann (Thanks!) 2014-11-15 12:12:56 -05:00
David A. Harding
ade6d1aca1
Dev Docs: Tweak Revised Protocol Versions Table Style 2014-11-15 10:41:51 -05:00
Saivann
0437d7c434 Format "protocol versions" table content to improve readability 2014-11-14 20:01:33 -05:00
David A. Harding
1634212dd5
Dev Docs: Add P2P Messages That Request Or Reply With Data
Adds to the devel reference page detailed documentation on the following
messages: block, getblocks, getdata, getheaders, headers, inv, mempool,
merkleblock, notfound, and tx.

Adds to the devel examples page an example of requesting and parsing a
merkleblock message.

Adds to the devel docs overview pages links to the above two new
P2P sections.

Tweaks the autocrossref plugin ignore pattern to not crossref in the
middle of a GIF image name; this allows the inclusion of animated GIFs.
2014-11-12 12:39:36 -05:00
saivann
b9a6c105a1 Merge pull request #636 from bitcoin/bits
Add mentions and definitions for bits
2014-11-11 12:13:36 -05:00
Saivann
01bf6de924 Revert another mention for "bits" 2014-11-11 12:12:27 -05:00
David A. Harding
63b4d03400
Dev Docs: Merkle Tree/nBits Minor Proofreading Edits
Based on feedback from @saivann (thanks!)
2014-11-08 16:39:01 -05:00
Saivann
7a8493124a Display uBTC and bits on a single row 2014-11-08 12:36:17 -05:00
Saivann
8bb1b18498 Drop post-decimal delimiter (thanks @luke-jr) 2014-11-08 11:10:10 -05:00
Saivann
604473059d Add mention for uBTC (thanks @luke-jr) 2014-11-08 11:09:30 -05:00