Skip to content

fix: preserve newlines in bb CLI help text formatting #19638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
johnathan79717 wants to merge 2 commits into
base: merge-train/barretenberg
Choose a base branch
from
Open

fix: preserve newlines in bb CLI help text formatting #19638

johnathan79717 wants to merge 2 commits into from

Conversation

@johnathan79717
Copy link
Contributor

@johnathan79717 johnathan79717 commented Jan 15, 2026 •
edited
Loading

Fixes AztecProtocol/barretenberg#1606

Summary

  • Fixes help text formatting in bb CLI to preserve explicit newlines
  • Formats --verifier_target options as an aligned table for better readability

Before:

-t,--verifier_target [BB_VERIFIER_TARGET]
                     Target verification environment. Determines hash function
                     and ZK settings. evm: Ethereum/Solidity verification
                     (keccak, ZK) evm-no-zk: Ethereum/Solidity without
                     zero-knowledge noir-recursive: Recursive verification in
                     Noir circuits (poseidon2, ZK) ...

After:

-t,--verifier_target [BB_VERIFIER_TARGET]
                     Target verification environment. Determines hash function
                     and ZK settings.

                     Options:
                       evm                  Ethereum/Solidity (keccak, ZK)
                       evm-no-zk            Ethereum/Solidity without ZK
                       noir-recursive       Noir circuits (poseidon2, ZK)
                       noir-recursive-no-zk Noir circuits without ZK
                       noir-rollup          Rollup with IPA (poseidon2, ZK)
                       noir-rollup-no-zk    Rollup without ZK
                       starknet             Starknet via Garaga (ZK)
                       starknet-no-zk       Starknet without ZK

Test plan

  • Built bb and verified bb prove --help shows formatted options

@johnathan79717
fix: preserve newlines in bb CLI help text formatting
d4b35d1 
The wrap_text function was using istringstream which splits on all
whitespace, collapsing explicit newlines in help descriptions. This made
multi-line option descriptions like --verifier_target hard to read.

Now splits by newlines first to preserve explicit line breaks, then
word-wraps within each line.
@johnathan79717
Copy link
Contributor Author

johnathan79717 commented Jan 16, 2026

Didn't realize there was a suggested format in AztecProtocol/barretenberg#1606. Updating.

@johnathan79717 johnathan79717 marked this pull request as draft January 16, 2026 13:42
@johnathan79717 johnathan79717 removed the request for review from ludamad January 16, 2026 13:42
@johnathan79717 johnathan79717 marked this pull request as ready for review January 16, 2026 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ludamad ludamad Awaiting requested review from ludamad

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@johnathan79717