Skip to content
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

add doc_auto_cfg to relevant sdk crates #3121

Merged
merged 4 commits into from
Oct 12, 2024
Merged

add doc_auto_cfg to relevant sdk crates #3121

merged 4 commits into from
Oct 12, 2024

Conversation

kevinheavey
Copy link

@kevinheavey kevinheavey commented Oct 9, 2024 •
edited
Loading

Problem

The new SDK crates put a bunch of code behind feature gates, which means those items won't be visible on docs.rs. This wasn't a big issue with solana_sdk and solana_program because those crates enable almost all their features by default.

Summary of Changes

For each crate in sdk/ where this is an issue, add

all-features = true
rustdoc-args = ["--cfg=docsrs"]

to [package.metadata.docs.rs]
and add #![cfg_attr(docsrs, feature(doc_auto_cfg))] to each module that contains feature-gated public items.

This makes docs.rs show these items with a note that they require certain features (or targets etc). This solution is fairly common: tokio is a prominent crate that does this.

To emulate what docs.rs generates, you can cd to the individual crate directory and run RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --no-deps

I published a toy example crate to demonstrate that this works on docs.rs: https://docs.rs/doc-feature-examples/latest/doc_feature_examples/

@kevinheavey kevinheavey requested a review from yihau October 9, 2024 16:42
@kevinheavey kevinheavey mentioned this pull request Oct 10, 2024
Merged
yihau
yihau previously approved these changes Oct 10, 2024
View reviewed changes
Copy link
Member

@yihau yihau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks quite good to me! thank you!

@yihau
Copy link
Member

yihau commented Oct 10, 2024 •
edited
Loading

if don't mind, we can wait @joncinque or @febo to have a chance to take a look

joncinque
joncinque reviewed Oct 11, 2024
View reviewed changes
Copy link

@joncinque joncinque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for noticing and fixing this! Just a few little things to clean up

sdk/hash/src/lib.rs
@@ -1,4 +1,5 @@
#![no_std]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also add the change to sdk/hash/Cargo.toml for all-features and rustdoc-args?

sdk/instruction/src/error.rs Outdated
@@ -1,3 +1,4 @@
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this required here since it's already enabled in lib.rs?

sdk/signature/src/lib.rs
@@ -1,5 +1,6 @@
//! 64-byte signature type.
#![no_std]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add the appropriate flags to sdk/signature/Cargo.toml?

@kevinheavey kevinheavey force-pushed the docs-features-cleanup branch from 36c6426 to a06f515 Compare October 11, 2024 17:24
joncinque
joncinque approved these changes Oct 11, 2024
View reviewed changes
Copy link

@joncinque joncinque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks!

@joncinque joncinque added the automerge automerge Merge this Pull Request automatically once CI passes label Oct 11, 2024
@mergify Mergify
Copy link

mergify bot commented Oct 11, 2024

automerge label removed due to a CI failure

@mergify mergify bot removed the automerge automerge Merge this Pull Request automatically once CI passes label Oct 11, 2024
@kevinheavey kevinheavey force-pushed the docs-features-cleanup branch from a06f515 to 8ac2ec3 Compare October 11, 2024 18:02
@joncinque joncinque added the automerge automerge Merge this Pull Request automatically once CI passes label Oct 11, 2024
@mergify Mergify
Copy link

mergify bot commented Oct 11, 2024

automerge label removed due to a CI failure

@mergify mergify bot removed the automerge automerge Merge this Pull Request automatically once CI passes label Oct 11, 2024
@kevinheavey kevinheavey force-pushed the docs-features-cleanup branch from 8ac2ec3 to e2a47f5 Compare October 12, 2024 09:28
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 12, 2024
@kevinheavey
use doc_auto_cfg like in anza-xyz#3121
6ce6203
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 12, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
3628c03
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 12, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
d92eb14
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 12, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
0cb5a50
@kevinheavey kevinheavey added the automerge automerge Merge this Pull Request automatically once CI passes label Oct 12, 2024
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 12, 2024
@kevinheavey
use doc_auto_cfg like in anza-xyz#3121
29c1992
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 12, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
ca8286f
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 12, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
6e6c08f
@kevinheavey
Copy link
Author

@joncinque could you merge please? Looks like automerge is still disabled

kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 22, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
04c1682
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 22, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
9db14fd
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 22, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
64ec370
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 22, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
2f2e8c3
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 24, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
dda3c7e
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 26, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
647adc5
mergify bot pushed a commit that referenced this pull request Oct 28, 2024
@kevinheavey
extract packet crate (#3029)
8045d36 
* extract packet crate

* typo

* sort deps

* update digest

* add doc_auto_cfg like in #3121

* fix frozen-abi
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 28, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
c58f638
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 28, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
c810ab2
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 28, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
6d44fe4
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 29, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
f6b6165
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 29, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
1e002af
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 29, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
bd2f86a
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 29, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
ffcddf5
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 29, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
99a25db
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 29, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
c07d7f3
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 29, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
52c3b5a
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Oct 30, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
5bc017b
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Nov 1, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
e616a0f
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Nov 1, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
c97724e
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Nov 2, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
4252bb7
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Nov 5, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
937f4de
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Nov 5, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
fcf962c
mergify bot pushed a commit that referenced this pull request Nov 6, 2024
@kevinheavey @joncinque
Extract signer crates (#3087)
e752b38 
* extract signer crate

* fmt

* fix bs58 std usage

* extract seed-derivable crate

* extract seed-phrase crate

* fix copy-pasted doc

* extract presigner crate

* make keypair module optional in solana-signer

* remove serde_json dep and fix test features

* remove thiserror from solana-signer

* lint

* more lint

* fix dev dep feature

* sort deps

* remove itertools from solana-signer

* move wasm impl to signer crate

* add doc_auto_cfg like in #3121

* post-rebase fix

* another post-rebase fix

* fmt

* make keypair functionality of solana-seed-phrase optional

* fix feature-gated imports

* Extract solana-keypair, move other things around

* Cleanup things that I missed

* Remove space

* Add deprecated notice

* Add deprecation notices

* Refactor SeedDerivable trait implementation

---------

Co-authored-by: Jon C <[email protected]>
kevinheavey added a commit to kevinheavey/agave that referenced this pull request Nov 6, 2024
@kevinheavey
add doc_auto_cfg like in anza-xyz#3121
1567546
joncinque pushed a commit that referenced this pull request Nov 7, 2024
@kevinheavey
Extract reserved-account-keys and sdk-ids crates (#3141)
b8ac678 
* minimize solana_sdk use in reserved_account_keys

* extract reserved-account-keys crate

* fix frozen-abi support in reserved-account-keys

* move id definitions to sdk-ids

* also move the IDs of zk_token_proof_program and zk_elgamal_proof_program

* fix some paths

* missing dev dep

* add doc_auto_cfg like in #3121

* fix copied sysvar id

* fix missing dep after rebase

* move stake::program::declare_id to stake::declare_id

* post-rebase fix
ray-kast pushed a commit to abklabs/agave that referenced this pull request Nov 27, 2024
@kevinheavey @ray-kast
add doc_auto_cfg to relevant sdk crates (anza-xyz#3121)
bee5e62
ray-kast pushed a commit to abklabs/agave that referenced this pull request Nov 27, 2024
@kevinheavey @ray-kast
Extract account-decoder-client-types (anza-xyz#2872)
1add705 
* extract account-decoder-client-types and convert UiAccount::encode to a free func encode_ui_account

* rip out more types and replace some usage in rpc-client and rpc-client-api

* rip out more types

* remove remaining account-decoder usage from rpc-client

* remove account-decoder from rpc-client-api and transaction-status-client-types

* make zstd optional

* fix import

* ignore some lint

* update some conversions

* missing import

* missing import

* unused imports

* fmt

* don't feature-gate any variants of UiAccountEncoding

* fmt

* update newer code that used UiAccount::encode

* remove sdk dep from account-decoder-client-types

* add doc_auto_cfg like in anza-xyz#3121
ray-kast pushed a commit to abklabs/agave that referenced this pull request Nov 27, 2024
@kevinheavey @ray-kast
extract transaction-error crate (anza-xyz#2295)
ecce38d 
* extract transaction-error crate

* update TransactionError usage in sdk

* fix frozen-abi support

* make serde optional in solana-transaction-error

* update lock file

* fmt

* add #[cfg(not(target_os = "solana"))] where applicable

* fmt

* put solana-transaction-error behind feature "full"

* use workspace lints

* update digest

* make rustc_version optional

* avoid frozen-abi build script

* add back workspace lints

* remove thiserror

* remove unused build deps

* use solana-instruction directly

* move AddressLoaderError and SanitizeMessageError to transaction-error, and fix its solana-instruction dep features

* lint

* move TransportError to transaction-error crate

* use doc_auto_cfg like in anza-xyz#3121

* missing comma

* add deprecations to re-exports
ray-kast pushed a commit to abklabs/agave that referenced this pull request Nov 27, 2024
@kevinheavey @ray-kast
extract packet crate (anza-xyz#3029)
6db0e6c 
* extract packet crate

* typo

* sort deps

* update digest

* add doc_auto_cfg like in anza-xyz#3121

* fix frozen-abi
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joncinque joncinque joncinque approved these changes

@yihau yihau yihau left review comments

Assignees
No one assigned
Labels
automerge automerge Merge this Pull Request automatically once CI passes need:merge-assist
Projects
SDK Breakup + Breakout
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kevinheavey @yihau @joncinque