-
Notifications
You must be signed in to change notification settings - Fork 839
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.
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
adding verbose rustdoc to diff between build-spec and chain-spec-builder #7698
Merged
seemantaggarwal
merged 12 commits into
master
from
seemant-update-build-spec-documentation
Mar 6, 2025
+23
−4
Merged
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
d6c193a
adding verbose rustdoc to diff between build-spec and chain-spec-builder
seemantaggarwal d166320
Update cumulus/polkadot-omni-node/lib/src/cli.rs
seemantaggarwal 8365abb
Update cumulus/polkadot-omni-node/lib/src/cli.rs
seemantaggarwal 7612705
addressing comments
seemantaggarwal 0d97dbe
addressing comments, cleaning rustdoc
seemantaggarwal 633183d
Merge branch 'master' into seemant-update-build-spec-documentation
seemantaggarwal 575b47c
fixing rustdoc hyperlinks
seemantaggarwal b5bbf6d
fixing the deprecation notice and passing the failed test
seemantaggarwal 2ff27fb
Update from seemantaggarwal running command 'fmt'
github-actions[bot] 646b668
adding #[allow(deprecated)]
seemantaggarwal e2b747e
Merge branch 'master' into seemant-update-build-spec-documentation
seemantaggarwal e949e8d
Merge branch 'master' into seemant-update-build-spec-documentation
seemantaggarwal File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
|
@@ -72,6 +72,16 @@ pub enum Subcommand { | |||||||
Key(sc_cli::KeySubcommand), | ||||||||
|
||||||||
/// Build a chain specification. | ||||||||
/// The `build-spec` command relies on the chain specification built (hard-coded) into the node | ||||||||
/// binary, and may utilize the genesis presets of the runtimes also embedded in the nodes | ||||||||
/// that support this command. Since `polkadot-omni-node` does not contain any embedded | ||||||||
/// runtime, and requires a `chain-spec` path to be passed to its `--chain` flag, the command | ||||||||
/// isn't bringing significant value as it does for other node binaries (e.g. the | ||||||||
/// `polkadot` binary). | ||||||||
/// | ||||||||
/// For a more versatile `chain-spec` manipulation experience please check out the | ||||||||
/// `polkadot-omni-node chain-spec-builder` subcommand. | ||||||||
/// #[deprecated(note = "build-spec will be removed after 1/06/2025. Use chain-spec-builder instead")] | ||||||||
BuildSpec(sc_cli::BuildSpecCmd), | ||||||||
|
||||||||
/// Validate blocks. | ||||||||
|
@@ -90,11 +100,16 @@ pub enum Subcommand { | |||||||
Revert(sc_cli::RevertCmd), | ||||||||
|
||||||||
/// Subcommand for generating and managing chain specifications. | ||||||||
/// | ||||||||
/// Unlike `build-spec`, which generates a chain specification based on existing | ||||||||
/// configurations, `chain-spec-builder` provides a more interactive and customizable approach | ||||||||
/// to defining a chain spec. It allows users to create specifications with additional | ||||||||
/// parameters and validation steps before finalizing the output. | ||||||||
/// `chain-spec-builder` subcommand corresponds to the existing `chain-spec-builder` tool | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
/// (https://crates.io/crates/staging-chain-spec-builder), which can be used already standalone. | ||||||||
/// It provides the same functionality as the tool but bundled with `polkadot-omni-node` to | ||||||||
/// enable easier access to chain-spec generation, patching, converting to raw or validation, | ||||||||
/// from a single binary, which can be used as a parachain node tool | ||||||||
/// For a detailed usage guide please check out the standalone tool's crates.io or docs.rs | ||||||||
/// pages: | ||||||||
/// - https://crates.io/crates/staging-chain-spec-builder | ||||||||
/// - https://docs.rs/staging-chain-spec-builder/latest/staging_chain_spec_builder/ | ||||||||
/// --- | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Three dashes are leftover? |
||||||||
ChainSpecBuilder(ChainSpecBuilder), | ||||||||
|
||||||||
/// Remove the whole chain. | ||||||||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressed in 0d97dbe