add (max)uploadtarget infos to getnettotals RPC help #6999

pull jonasschnelli wants to merge 1 commits into bitcoin:master from jonasschnelli:2015/11/maxuploadtarget_rpc_help changing 1 files +10 −1

jonasschnelli commented at 12:15 PM on November 12, 2015: contributor

No description provided.
sipa commented at 1:40 PM on November 12, 2015: member

utACK
jonasschnelli commented at 1:43 PM on November 12, 2015: contributor

Same sample output to judge the formatting: <img width="667" alt="bildschirmfoto 2015-11-12 um 14 43 01" src="https://cloud.githubusercontent.com/assets/178464/11119709/b505b42a-894b-11e5-8bbb-1714e6dbb134.png">
paveljanik commented at 1:46 PM on November 12, 2015: contributor

There are two { on uploadtarget line and missing commas after t...
paveljanik commented at 1:48 PM on November 12, 2015: contributor

Boolean entries are described differently in the other help texts.
jonasschnelli force-pushed on Nov 12, 2015
jonasschnelli commented at 1:51 PM on November 12, 2015: contributor

Thanks for the review. Fixed the double "{" and the description for the booleans.
jonasschnelli renamed this:
~~add (max)uploadtarget infos to getnetinfos RPC help~~
add (max)uploadtarget infos to getnettotals RPC help
on Nov 12, 2015
jonasschnelli force-pushed on Nov 12, 2015
add (max)uploadtarget infos to getnettotals RPC help f6d9d5ee75
jonasschnelli force-pushed on Nov 12, 2015

paveljanik commented at 2:23 PM on November 12, 2015: contributor

The output here looks like this:

{
  "totalbytesrecv": 7718519,
  "totalbytessent": 56670,
  "timemillis": 1447337892394,
  "uploadtarget": {
    "timeframe": 86400,
    "target": 0,
    "target_reached": false,
    "serve_historical_blocks": true,
    "bytes_left_in_cycle": 0,
    "time_left_in_cycle": 0
  }
}

Please note the position of { in uploadtarget - it is on the same line. Can you move it there also in the helptext?

And this was the last nit.

ACK

instagibbs commented at 6:54 PM on November 12, 2015: member

Would it hurt just to add "bytes" to "target"? aka "targetbytes" Everything else has bytes in the field name.

nit aside, utACK

Meta-comment: if #6984 gets merged I'd want to know that whitelisted peers existed and I was serving historical blocks to them.
laanwj added the label RPC on Nov 13, 2015
laanwj commented at 9:34 AM on November 13, 2015: member

Would it hurt just to add "bytes" to "target"? aka "targetbytes" Everything else has bytes in the field name.

Hah, yes, we could comment many things on consistency in the RPC interface. Some things have _ separators some have words written together, there are even a few camelCases here and there.

Only if it isn't in a release yet there is still scope for changing it. @jonasschnelli Thanks for documenting it though - as it is.
gmaxwell commented at 7:34 PM on November 13, 2015: contributor

utACK
gmaxwell commented at 12:39 AM on November 17, 2015: contributor

ACK.
gmaxwell merged this on Nov 17, 2015
gmaxwell closed this on Nov 17, 2015
gmaxwell referenced this in commit 972bf9c529 on Nov 17, 2015
dcousens commented at 12:42 AM on November 17, 2015: contributor

ACK
zkbot referenced this in commit fd0d435f72 on Feb 18, 2021
zkbot referenced this in commit 1d378b1eb0 on Feb 18, 2021
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels