doc: correct topology requirements in submitpackage helptext #33630

pull glozow wants to merge 1 commits into bitcoin:master from glozow:2025-10-doc-submitpackage changing 1 files +3 −2
  1. glozow commented at 8:02 pm on October 14, 2025: member

    This doc is outdated since #31385. Also made it explicit that a singleton is ok.

    Can be backported to 30.x, but doesn’t need to be backported earlier (“if any” covers #31096).

  2. glozow added the label Docs on Oct 14, 2025
  3. DrahtBot commented at 8:02 pm on October 14, 2025: contributor

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    Code Coverage & Benchmarks

    For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/33630.

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK janb84, instagibbs
    Stale ACK kevkevinpal

    If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

  4. glozow renamed this:
    [doc] correct topology requirements in submitpackage helptext
    doc: correct topology requirements in submitpackage helptext
    on Oct 14, 2025
  5. kevkevinpal commented at 9:31 pm on October 14, 2025: contributor

    ACK 501b030

    Fairly straightforward change and makes it clearer what is accepted

  6. in src/rpc/mempool.cpp:939 in 501b030769
    935@@ -936,7 +936,7 @@ static RPCHelpMan submitpackage()
    936         ,
    937         {
    938             {"package", RPCArg::Type::ARR, RPCArg::Optional::NO, "An array of raw transactions.\n"
    939-                "The package must solely consist of a child transaction and all of its unconfirmed parents, if any. None of the parents may depend on each other.\n"
    940+                "The package must consist of either: exactly 1 transaction, or 1 transaction with its unconfirmed parents. None of the parents may depend on each other. Not all parents need to be present.\n"
    


    janb84 commented at 11:18 am on October 15, 2025:

    Text is not completely clear to me on the parents point. “or 1 transaction with its unconfirmed parents” but “Not all parents need to be present” so some of the unconfirmed parents ? all but not the confirmed parents ?

    Maybe NIT;

    0                "The package must consist of either: exactly 1 transaction, or 1 transaction with (some of) its unconfirmed parents. None of the parents may depend on each other. Not all parents need to be present.\n"
    

    instagibbs commented at 12:57 pm on October 17, 2025:

    maybe?

    0                "The package must consist of either: exactly 1 transaction, or 1 transaction with its unconfirmed parents. None of the parents may depend on each other. Not all in-mempool parents need to be present in the package.\n"
    

    glozow commented at 1:29 pm on October 17, 2025:
    Incorporated this as (some, all, or none of)

    glozow commented at 1:30 pm on October 17, 2025:
    Took this, but reworded a little bit.
  7. fanquake added the label Needs backport (30.x) on Oct 15, 2025
  8. fanquake requested review from instagibbs on Oct 16, 2025
  9. [doc] correct topology requirements in submitpackage helptext 3d22282564
  10. glozow force-pushed on Oct 17, 2025
  11. glozow commented at 1:30 pm on October 17, 2025: member
    Thanks for the reviews! Re-pushed to address comments.
  12. janb84 commented at 1:38 pm on October 17, 2025: contributor

    ACK 3d222825642bfb052ce40cbc1c69318a0d8835bf

    PR updates helptext of submitpackage to be up 2 date with the reent changes in #31385 . New help text reflects changes in #31385 and is clear.

    Thanks for incorporating my nit!

  13. instagibbs approved
  14. instagibbs commented at 1:41 pm on October 17, 2025: member
    ACK 3d222825642bfb052ce40cbc1c69318a0d8835bf
  15. fanquake merged this on Oct 17, 2025
  16. fanquake closed this on Oct 17, 2025

  17. fanquake removed the label Needs backport (30.x) on Oct 17, 2025
  18. fanquake commented at 2:24 pm on October 17, 2025: member
    Backported to 30.x in #33609.
  19. fanquake referenced this in commit 96110f8846 on Oct 17, 2025

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2025-10-19 18:13 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me