Make all arguments required to reduce the probability of incorrect
implicit behavior. Use keyword arguments for clarity.
Signed-off-by: Tamir Duberstein <tamird@gmail.com>
---
scripts/generate_rust_analyzer.py | 90 +++++++++++++++++++++++++++------------
1 file changed, 62 insertions(+), 28 deletions(-)
diff --git a/scripts/generate_rust_analyzer.py b/scripts/generate_rust_analyzer.py
index b37d8345486a..badcef4126cf 100755
--- a/scripts/generate_rust_analyzer.py
+++ b/scripts/generate_rust_analyzer.py
@@ -69,9 +69,10 @@ def generate_crates(
def build_crate(
display_name: str,
root_module: pathlib.Path,
+ *,
deps: List[str],
- cfg: List[str] = [],
- is_workspace_member: bool = True,
+ cfg: List[str],
+ is_workspace_member: bool,
) -> Crate:
return {
"display_name": display_name,
@@ -92,21 +93,34 @@ def generate_crates(
def append_crate(
display_name: str,
root_module: pathlib.Path,
+ *,
deps: List[str],
- cfg: List[str] = [],
- is_workspace_member: bool = True,
+ cfg: List[str],
) -> None:
register_crate(
- build_crate(display_name, root_module, deps, cfg, is_workspace_member)
+ build_crate(
+ display_name,
+ root_module,
+ deps=deps,
+ cfg=cfg,
+ is_workspace_member=True,
+ )
)
def append_proc_macro_crate(
display_name: str,
root_module: pathlib.Path,
+ *,
deps: List[str],
- cfg: List[str] = [],
+ cfg: List[str],
) -> None:
- crate = build_crate(display_name, root_module, deps, cfg)
+ crate = build_crate(
+ display_name,
+ root_module,
+ deps=deps,
+ cfg=cfg,
+ is_workspace_member=True,
+ )
proc_macro_dylib_name = (
subprocess.check_output(
[
@@ -133,66 +147,75 @@ def generate_crates(
def append_sysroot_crate(
display_name: str,
+ *,
deps: List[str],
- cfg: List[str] = [],
+ cfg: List[str],
) -> None:
- append_crate(
- display_name,
- sysroot_src / display_name / "src" / "lib.rs",
- deps,
- cfg,
- is_workspace_member=False,
+ register_crate(
+ build_crate(
+ display_name,
+ sysroot_src / display_name / "src" / "lib.rs",
+ deps=deps,
+ cfg=cfg,
+ is_workspace_member=False,
+ )
)
# NB: sysroot crates reexport items from one another so setting up our transitive dependencies
# here is important for ensuring that rust-analyzer can resolve symbols. The sources of truth
# for this dependency graph are `(sysroot_src / crate / "Cargo.toml" for crate in crates)`.
- append_sysroot_crate("core", [], cfg=crates_cfgs["core"])
- append_sysroot_crate("alloc", ["core"])
- append_sysroot_crate("std", ["alloc", "core"])
- append_sysroot_crate("proc_macro", ["core", "std"])
+ append_sysroot_crate("core", deps=[], cfg=crates_cfgs["core"])
+ append_sysroot_crate("alloc", deps=["core"], cfg=[])
+ append_sysroot_crate("std", deps=["alloc", "core"], cfg=[])
+ append_sysroot_crate("proc_macro", deps=["core", "std"], cfg=[])
append_crate(
"compiler_builtins",
srctree / "rust" / "compiler_builtins.rs",
- [],
+ deps=[],
+ cfg=[],
)
append_proc_macro_crate(
"macros",
srctree / "rust" / "macros" / "lib.rs",
- ["std", "proc_macro"],
+ deps=["std", "proc_macro"],
+ cfg=[],
)
append_crate(
"build_error",
srctree / "rust" / "build_error.rs",
- ["core", "compiler_builtins"],
+ deps=["core", "compiler_builtins"],
+ cfg=[],
)
append_proc_macro_crate(
"pin_init_internal",
srctree / "rust" / "pin-init" / "internal" / "src" / "lib.rs",
- [],
+ deps=[],
cfg=["kernel"],
)
append_crate(
"pin_init",
srctree / "rust" / "pin-init" / "src" / "lib.rs",
- ["core", "pin_init_internal", "macros"],
+ deps=["core", "pin_init_internal", "macros"],
cfg=["kernel"],
)
def append_crate_with_generated(
display_name: str,
+ *,
deps: List[str],
+ cfg: List[str],
) -> None:
crate = build_crate(
display_name,
srctree / "rust" / display_name / "lib.rs",
- deps,
+ deps=deps,
cfg=cfg,
+ is_workspace_member=True,
)
crate["env"]["OBJTREE"] = str(objtree.resolve(True))
crate_with_generated: CrateWithGenerated = {
@@ -207,9 +230,20 @@ def generate_crates(
}
register_crate(crate_with_generated)
- append_crate_with_generated("bindings", ["core"])
- append_crate_with_generated("uapi", ["core"])
- append_crate_with_generated("kernel", ["core", "macros", "build_error", "bindings", "pin_init", "uapi"])
+ append_crate_with_generated("bindings", deps=["core"], cfg=[])
+ append_crate_with_generated("uapi", deps=["core"], cfg=[])
+ append_crate_with_generated(
+ "kernel",
+ deps=[
+ "core",
+ "macros",
+ "build_error",
+ "bindings",
+ "pin_init",
+ "uapi",
+ ],
+ cfg=[],
+ )
def is_root_crate(build_file: pathlib.Path, target: str) -> bool:
try:
@@ -239,7 +273,7 @@ def generate_crates(
append_crate(
name,
path,
- ["core", "kernel"],
+ deps=["core", "kernel"],
cfg=cfg,
)
--
2.49.0On Tue, Mar 25, 2025 at 3:07 PM Tamir Duberstein <tamird@gmail.com> wrote: > > Make all arguments required to reduce the probability of incorrect > implicit behavior. Use keyword arguments for clarity. > > Signed-off-by: Tamir Duberstein <tamird@gmail.com> > --- > scripts/generate_rust_analyzer.py | 90 +++++++++++++++++++++++++++------------ > 1 file changed, 62 insertions(+), 28 deletions(-) Reviewed-by: Trevor Gross <tmgross@umich.edu>
Hi Tamir,
This patch looks good to me but,
> On 25 Mar 2025, at 17:06, Tamir Duberstein <tamird@gmail.com> wrote:
>
> Make all arguments required to reduce the probability of incorrect
> implicit behavior. Use keyword arguments for clarity.
>
> Signed-off-by: Tamir Duberstein <tamird@gmail.com>
> ---
> scripts/generate_rust_analyzer.py | 90 +++++++++++++++++++++++++++------------
> 1 file changed, 62 insertions(+), 28 deletions(-)
>
> diff --git a/scripts/generate_rust_analyzer.py b/scripts/generate_rust_analyzer.py
> index b37d8345486a..badcef4126cf 100755
> --- a/scripts/generate_rust_analyzer.py
> +++ b/scripts/generate_rust_analyzer.py
> @@ -69,9 +69,10 @@ def generate_crates(
> def build_crate(
> display_name: str,
> root_module: pathlib.Path,
> + *,
> deps: List[str],
> - cfg: List[str] = [],
> - is_workspace_member: bool = True,
> + cfg: List[str],
> + is_workspace_member: bool,
> ) -> Crate:
> return {
> "display_name": display_name,
> @@ -92,21 +93,34 @@ def generate_crates(
> def append_crate(
> display_name: str,
> root_module: pathlib.Path,
> + *,
> deps: List[str],
> - cfg: List[str] = [],
> - is_workspace_member: bool = True,
> + cfg: List[str],
> ) -> None:
> register_crate(
> - build_crate(display_name, root_module, deps, cfg, is_workspace_member)
> + build_crate(
> + display_name,
> + root_module,
> + deps=deps,
> + cfg=cfg,
> + is_workspace_member=True,
> + )
> )
>
> def append_proc_macro_crate(
> display_name: str,
> root_module: pathlib.Path,
> + *,
> deps: List[str],
> - cfg: List[str] = [],
> + cfg: List[str],
> ) -> None:
> - crate = build_crate(display_name, root_module, deps, cfg)
> + crate = build_crate(
> + display_name,
> + root_module,
> + deps=deps,
> + cfg=cfg,
> + is_workspace_member=True,
> + )
> proc_macro_dylib_name = (
> subprocess.check_output(
> [
> @@ -133,66 +147,75 @@ def generate_crates(
>
> def append_sysroot_crate(
> display_name: str,
> + *,
> deps: List[str],
> - cfg: List[str] = [],
> + cfg: List[str],
> ) -> None:
> - append_crate(
> - display_name,
> - sysroot_src / display_name / "src" / "lib.rs",
> - deps,
> - cfg,
> - is_workspace_member=False,
> + register_crate(
> + build_crate(
> + display_name,
> + sysroot_src / display_name / "src" / "lib.rs",
> + deps=deps,
> + cfg=cfg,
> + is_workspace_member=False,
> + )
> )
Why the change from append to register+build here? Maybe this change
should be in another patch?
— Daniel
On Tue, Apr 1, 2025 at 8:59 AM Daniel Almeida
<daniel.almeida@collabora.com> wrote:
>
> Hi Tamir,
>
> This patch looks good to me but,
>
> > On 25 Mar 2025, at 17:06, Tamir Duberstein <tamird@gmail.com> wrote:
> >
> > Make all arguments required to reduce the probability of incorrect
> > implicit behavior. Use keyword arguments for clarity.
> >
> > Signed-off-by: Tamir Duberstein <tamird@gmail.com>
> > ---
> > scripts/generate_rust_analyzer.py | 90 +++++++++++++++++++++++++++------------
> > 1 file changed, 62 insertions(+), 28 deletions(-)
> >
> > diff --git a/scripts/generate_rust_analyzer.py b/scripts/generate_rust_analyzer.py
> > index b37d8345486a..badcef4126cf 100755
> > --- a/scripts/generate_rust_analyzer.py
> > +++ b/scripts/generate_rust_analyzer.py
> > @@ -69,9 +69,10 @@ def generate_crates(
> > def build_crate(
> > display_name: str,
> > root_module: pathlib.Path,
> > + *,
> > deps: List[str],
> > - cfg: List[str] = [],
> > - is_workspace_member: bool = True,
> > + cfg: List[str],
> > + is_workspace_member: bool,
> > ) -> Crate:
> > return {
> > "display_name": display_name,
> > @@ -92,21 +93,34 @@ def generate_crates(
> > def append_crate(
> > display_name: str,
> > root_module: pathlib.Path,
> > + *,
> > deps: List[str],
> > - cfg: List[str] = [],
> > - is_workspace_member: bool = True,
> > + cfg: List[str],
> > ) -> None:
> > register_crate(
> > - build_crate(display_name, root_module, deps, cfg, is_workspace_member)
> > + build_crate(
> > + display_name,
> > + root_module,
> > + deps=deps,
> > + cfg=cfg,
> > + is_workspace_member=True,
> > + )
> > )
> >
> > def append_proc_macro_crate(
> > display_name: str,
> > root_module: pathlib.Path,
> > + *,
> > deps: List[str],
> > - cfg: List[str] = [],
> > + cfg: List[str],
> > ) -> None:
> > - crate = build_crate(display_name, root_module, deps, cfg)
> > + crate = build_crate(
> > + display_name,
> > + root_module,
> > + deps=deps,
> > + cfg=cfg,
> > + is_workspace_member=True,
> > + )
> > proc_macro_dylib_name = (
> > subprocess.check_output(
> > [
> > @@ -133,66 +147,75 @@ def generate_crates(
> >
> > def append_sysroot_crate(
> > display_name: str,
> > + *,
> > deps: List[str],
> > - cfg: List[str] = [],
> > + cfg: List[str],
> > ) -> None:
> > - append_crate(
> > - display_name,
> > - sysroot_src / display_name / "src" / "lib.rs",
> > - deps,
> > - cfg,
> > - is_workspace_member=False,
> > + register_crate(
> > + build_crate(
> > + display_name,
> > + sysroot_src / display_name / "src" / "lib.rs",
> > + deps=deps,
> > + cfg=cfg,
> > + is_workspace_member=False,
> > + )
> > )
>
> Why the change from append to register+build here? Maybe this change
> should be in another patch?
The reason is that `append_crate` has lost its `is_workspace_member`
parameter, so the only way to pass `False` now is to use
`build_crate`. I chose to remove the argument from `append_crate`
because the alternative would have introduced many instances of
`is_workspace_member=True`, which I judged to be less-good than this.
Cheers.
Tamir
Hi Tamir,
> On 1 Apr 2025, at 10:34, Tamir Duberstein <tamird@gmail.com> wrote:
>
> On Tue, Apr 1, 2025 at 8:59 AM Daniel Almeida
> <daniel.almeida@collabora.com> wrote:
>>
>> Hi Tamir,
>>
>> This patch looks good to me but,
>>
>>> On 25 Mar 2025, at 17:06, Tamir Duberstein <tamird@gmail.com> wrote:
>>>
>>> Make all arguments required to reduce the probability of incorrect
>>> implicit behavior. Use keyword arguments for clarity.
>>>
>>> Signed-off-by: Tamir Duberstein <tamird@gmail.com>
>>> ---
>>> scripts/generate_rust_analyzer.py | 90 +++++++++++++++++++++++++++------------
>>> 1 file changed, 62 insertions(+), 28 deletions(-)
>>>
>>> diff --git a/scripts/generate_rust_analyzer.py b/scripts/generate_rust_analyzer.py
>>> index b37d8345486a..badcef4126cf 100755
>>> --- a/scripts/generate_rust_analyzer.py
>>> +++ b/scripts/generate_rust_analyzer.py
>>> @@ -69,9 +69,10 @@ def generate_crates(
>>> def build_crate(
>>> display_name: str,
>>> root_module: pathlib.Path,
>>> + *,
>>> deps: List[str],
>>> - cfg: List[str] = [],
>>> - is_workspace_member: bool = True,
>>> + cfg: List[str],
>>> + is_workspace_member: bool,
>>> ) -> Crate:
>>> return {
>>> "display_name": display_name,
>>> @@ -92,21 +93,34 @@ def generate_crates(
>>> def append_crate(
>>> display_name: str,
>>> root_module: pathlib.Path,
>>> + *,
>>> deps: List[str],
>>> - cfg: List[str] = [],
>>> - is_workspace_member: bool = True,
>>> + cfg: List[str],
>>> ) -> None:
>>> register_crate(
>>> - build_crate(display_name, root_module, deps, cfg, is_workspace_member)
>>> + build_crate(
>>> + display_name,
>>> + root_module,
>>> + deps=deps,
>>> + cfg=cfg,
>>> + is_workspace_member=True,
>>> + )
>>> )
>>>
>>> def append_proc_macro_crate(
>>> display_name: str,
>>> root_module: pathlib.Path,
>>> + *,
>>> deps: List[str],
>>> - cfg: List[str] = [],
>>> + cfg: List[str],
>>> ) -> None:
>>> - crate = build_crate(display_name, root_module, deps, cfg)
>>> + crate = build_crate(
>>> + display_name,
>>> + root_module,
>>> + deps=deps,
>>> + cfg=cfg,
>>> + is_workspace_member=True,
>>> + )
>>> proc_macro_dylib_name = (
>>> subprocess.check_output(
>>> [
>>> @@ -133,66 +147,75 @@ def generate_crates(
>>>
>>> def append_sysroot_crate(
>>> display_name: str,
>>> + *,
>>> deps: List[str],
>>> - cfg: List[str] = [],
>>> + cfg: List[str],
>>> ) -> None:
>>> - append_crate(
>>> - display_name,
>>> - sysroot_src / display_name / "src" / "lib.rs",
>>> - deps,
>>> - cfg,
>>> - is_workspace_member=False,
>>> + register_crate(
>>> + build_crate(
>>> + display_name,
>>> + sysroot_src / display_name / "src" / "lib.rs",
>>> + deps=deps,
>>> + cfg=cfg,
>>> + is_workspace_member=False,
>>> + )
>>> )
>>
>> Why the change from append to register+build here? Maybe this change
>> should be in another patch?
>
> The reason is that `append_crate` has lost its `is_workspace_member`
> parameter, so the only way to pass `False` now is to use
> `build_crate`. I chose to remove the argument from `append_crate`
> because the alternative would have introduced many instances of
> `is_workspace_member=True`, which I judged to be less-good than this.
Fine with me.
Reviewed-by: Daniel Almeida <daniel.almeida@collabora.com>
>
> Cheers.
> Tamir
— Daniel
© 2016 - 2026 Red Hat, Inc.