Commit graph

22 commits

Author SHA1 Message Date
Chris Arnesen
e5aa4f812f rename "JSON-RPC request batching" link 2015-08-28 09:57:52 -05:00
Chris Arnesen
532fc416ad incorporate suggestions from feedback, closes #1025 2015-08-27 11:53:24 -05:00
Chris Arnesen
9a0f234168 Polish, correct, and expand RPC interface intro 2015-08-25 19:45:23 -05:00
David A. Harding
cf11cc8240
Dev Docs: Add details about score in getnetworkinfo
Thanks to Wladimir van der Laan for describing it on #bitcoin IRC
2015-08-17 09:31:29 -04:00
David A. Harding
f4f23d9680
Dev Docs: Further correct LockUnspent RPC docs 2015-07-31 12:07:16 -04:00
ChainQuery
32b98e2a2c Correct true/false for Lock or Unlock
unlock (boolean, required) Whether to unlock (true) or lock (false) the specified transactions
2015-07-31 10:13:08 -04:00
Casey Rodarmor
f50eb7c964 Update settxfee description to match actual behavior
Currently, Bitcoin Core accepts 0 as an argument to settxfee, see settxfee() in https://github.com/bitcoin/bitcoin/blob/master/src/wallet/rpcwallet.cpp

Update the description to match this
2015-07-28 13:35:10 -04:00
David A. Harding
224127f2f0
Merge pulls #824 and #830
* 824: Dev Docs: Update For New 'generate' RPC
* 830: Link "quantum computing" in FAQ to related Bitcoin Magazine article
2015-04-22 17:38:44 -04:00
David A. Harding
a2a5f454cb
Revert "Revert "Merge pull #793: Dev Docs: New Glossary & JS Search Box""
This reverts commit 961d6c988f.
2015-04-14 08:55:53 -04:00
David A. Harding
ab7ca1f26f
Dev Docs: RPCs: Add New 'generate' & Note 'getgenerate' Change 2015-04-12 20:30:59 -04:00
David A. Harding
961d6c988f
Revert "Merge pull #793: Dev Docs: New Glossary & JS Search Box"
This reverts commit e3dcf0ce1f, reversing
changes made to c71e9fdf2d.

Once again we had a broken new plugin that Travis CI and local building
didn't catch.
2015-04-10 19:33:39 -04:00
David A. Harding
801ea9f4ad
Fix links for new glossary entries 2015-03-19 15:32:09 -04:00
Diogo Quintela
15b779049b typo on timereceived (was timerecived) 2015-03-11 13:55:02 +00:00
David A. Harding
2c44b59d88
Dev Docs: Use Sed To Convert Tables To YAML
Run sed -i -f <this_file.sed> _includes/ref/bitcoin-core/rpcs/rpcs/* _includes/ref/bitcoin-core/rest/requests/get_* _includes/helpers/vars.md

    ## On lines that start with a pipe:
    /^|/ {
        ## Delete all table header/table body divider lines
        /|----/d;

        ## Escape all double quotes
        s/"/\\"/g;

        ## Replace lines that look like NTPD headers with a itemplate start block
        s/^| Name *| Type.*/{% itemplate ntpd1 %}/;

        ## Delete extraneous whitespace
        s/ *|/|/g;

        ## Replace the first pipe with "- name:" plus a start quote
        s/^| */- n: "/;

        ## Replace the remaining pipes, starting each one with a newline and two spaces
        s/| */"\n  t: "/;
        s/| */"\n  p: "/;
        s/| */"\n  d: "/;

        ## Add a close quote and an empty line after the last list item
        ## built from a single table row, except for the header row. This
        ## improves readability/maintainability
        /[^}]$/s/$/"\n/;
    }

    ## Replace the old table class with the itemplate close tag
    s/{:.ntpd}/{% enditemplate %}/
2015-02-20 15:39:10 -05:00
David A. Harding
848429f0c9
Dev Docs: Tweak GetHashesPerSec Deprecation
* Ran `make manual-updates` to grab new summary

* Clarified that GHPS is part of 0.10.0 and is removed in master

* Autocrossref'd "Bitcoin Core master" to GitHub repo

* Removed GHPS from list of Mining RPCs now that it's in Removed RPCs
2015-02-02 09:59:20 -05:00
Rui Marinho
f2e268da4a Dev Docs: Deprecate gethashespersec rpc call in 0.10.0. 2015-02-02 01:19:36 +00:00
David A. Harding
2312aa10fd
Dev Docs: Merge RPC and RPC Intro
This commit merges the RPC introduction section (h4), "JSON-RPC &
bitcoin-cli" into the currently-empty RPC section (h3).  To do this, it
splits the contents of the file `_includes/ref_core_rpc_intro.md` into
the new files `_includes/ref/bitcoin-core/api-intro.md` and
`_includes/ref/bitcoin-core/rpcs/intro.md`
2015-01-27 18:40:20 -05:00
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
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