Module setup

Source
Expand description

First time setup of a dev environment

These are build-and-run steps for ./x.py setup, which allows quickly setting up the directory for modifying, building, and running the compiler and library. Running arbitrary configuration allows setting up things that cannot be simply captured inside the config.toml, in addition to leading people away from manually editing most of the config.toml values.

Structsยง

Editor
Sets up or displays the LSP config for one of the supported editors
Hook
Installs src/etc/pre-push.sh as a Git hook
Link
Creates a toolchain link for stage1 using rustup

Enumsยง

EditorKind ๐Ÿ”’
Handles editor-specific setup differences
Profile
PromptResult ๐Ÿ”’

Staticsยง

PROFILE_DIR ๐Ÿ”’

Functionsยง

attempt_toolchain_link ๐Ÿ”’
create_editor_settings_maybe ๐Ÿ”’
Create the recommended editor LSP config file for rustc development, or just print it If this method should be re-called, it returns false.
ensure_stage1_toolchain_placeholder_exists ๐Ÿ”’
install_git_hook_maybe ๐Ÿ”’
interactive_path
prompt_user ๐Ÿ”’
Prompt a user for a answer, looping until they enter an accepted input or nothing
rustup_installed ๐Ÿ”’
setup
setup_config_toml ๐Ÿ”’
stage_dir_exists ๐Ÿ”’
toolchain_is_linked ๐Ÿ”’
try_link_toolchain ๐Ÿ”’