Skip to content

Unhelpful documentation for runBuildScriptsCommand #12115

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

Closed
maghoff opened this issue Apr 29, 2022 · 0 comments · Fixed by #12010
Closed

Unhelpful documentation for runBuildScriptsCommand #12115

maghoff opened this issue Apr 29, 2022 · 0 comments · Fixed by #12010
Assignees
Labels
A-config configuration

Comments

@maghoff
Copy link

maghoff commented Apr 29, 2022

The configuration option runBuildScriptsCommand has the following documentation:

    /// Advanced option, fully override the command rust-analyzer uses to
    /// run build scripts and build procedural macros. The command should
    /// include `--message-format=json` or a similar option.

This documentation is just short of helpful. Including a default command line example would be a much better starting point for figuring out what to put in this configuration option. It looks like the default command line is: cargo check --quiet --workspace --message-format=json --all-targets plus optionally target and feature configuration. Maybe rewrite the doc comment to:

    /// Advanced option, fully override the command rust-analyzer uses to
    /// run build scripts and build procedural macros. The command should
    /// include `--message-format=json` or a similar option.
    ///
    /// By default, a cargo invocation will be constructed for the configured
    /// targets and features, with the following base command line:
    ///
    /// ```bash
    /// cargo check --quiet --workspace --message-format=json --all-targets
    /// ```
@Veykril Veykril added the A-config configuration label Apr 29, 2022
@Veykril Veykril self-assigned this Apr 29, 2022
@bors bors closed this as completed in 460e389 May 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-config configuration
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants