You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Add generated docs for CommandExecutorConfig
Summary:
Looks like function parameter docs are not supported in Rust: rust-lang/rust#57525
Move them up so that they are displayed as in our docs, would be nice to move it back once it is supported.
Differential Revision: D44629092
fbshipit-source-id: 6124f70f2e31ddc9d268e5aedbc674a42f994add
/// Contains configurations for how actions should be executed
64
+
///
65
+
/// * `local_enabled` : Whether to use local execution for this execution platform.
66
+
/// If both remote_enabled and local_enabled are `True`, we will use the hybrid executor
67
+
/// * `remote_enabled`: Whether to use remote execution for this execution platform
68
+
/// * `remote_cache_enabled`: Whether to query RE caches
69
+
/// * `remote_execution_properties`: Properties for remote execution for this platform
70
+
/// * `remote_execution_action_key`: A component to inject into the action key
71
+
/// This should typically used to inject variability into the action key so that
72
+
/// it's different across e.g. build modes (RE uses the action key for things like expected memory utilization)
73
+
/// * `remote_execution_max_input_files_mebibytes`: The maximum input file size (in bytes) that remote execution can support
74
+
/// * `remote_execution_queue_time_threshold_s`: The maximum time in seconds we are willing to wait
75
+
/// in the RE queue for remote execution to start running our action
76
+
/// * `remote_execution_use_case`: The use case to use when communicating with RE
77
+
/// * `use_limited_hybrid`: Whether to use the limited hybrid executor
78
+
/// * `allow_limited_hybrid_fallbacks`: Whether to allow fallbacks
79
+
/// * `allow_hybrid_fallbacks_on_failure`: Whether to allow fallbacks when the result is failure (i.e. the command failed on the primary, but the infra worked)
80
+
/// * `use_windows_path_separators`: Whether to use Windows path separators in command line arguments
81
+
/// * `allow_cache_uploads`: Whether to upload local actions to the RE cache
82
+
/// * `max_cache_upload_mebibytes`: Maximum size to upload in cache uploads
83
+
/// * `experimental_low_pass_filter`: Whether to use the experimental low pass filter
84
+
/// * `remote_output_paths`: How to express output paths to RE
63
85
#[starlark(type = "command_executor_config")]
64
86
fnCommandExecutorConfig<'v>(
65
-
// Whether to use local execution for this execution platform. If both
66
-
// remote_enabled and local_enabled are `True`, we will use the hybrid executor.
67
87
local_enabled:bool,
68
-
// Whether to use remote execution for this execution platform
0 commit comments