Skip to content

update function name in target: set_prefix → set_prefixdir #251

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

Merged
merged 1 commit into from
Oct 26, 2025
Merged

update function name in target: set_prefix → set_prefixdir #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/api/description/project-target.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4850,7 +4850,7 @@ installdir
If we configure:

```lua
set_prefix("prefixdir")
set_prefixdir("prefixdir")
```

It is to add a general subdirectory:
Expand All @@ -4866,7 +4866,7 @@ installdir
We can also configure bin, lib and include subdirectories separately, for example:

```lua
set_prefix("prefixdir", {bindir = "mybin", libdir = "mylib", includedir = "myinc"})
set_prefixdir("prefixdir", {bindir = "mybin", libdir = "mylib", includedir = "myinc"})
Copy link

@gemini-code-assist gemini-code-assist bot Oct 26, 2025

Choose a reason for hiding this comment

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

medium

This example correctly uses set_prefixdir with two arguments. However, the function prototype documented for set_prefixdir on line 4826 only shows one argument (prefixdir: <string>). To avoid confusion and improve documentation quality, please consider updating the function prototype to include the optional second table argument, for example: set_prefixdir(prefixdir: <string>, options?: <table>).

```

```sh
Expand All @@ -4880,7 +4880,7 @@ installdir
If we do not configure prefixdir and only modify the bin subdirectory, we can configure prefixdir to `/`.

```lua
set_prefix("/", {bindir = "mybin", libdir = "mylib", includedir = "myinc"})
set_prefixdir("/", {bindir = "mybin", libdir = "mylib", includedir = "myinc"})
```

```sh
Expand Down
6 changes: 3 additions & 3 deletions docs/zh/api/description/project-target.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4934,7 +4934,7 @@ installdir
如果我们配置：

```lua
set_prefix("prefixdir")
set_prefixdir("prefixdir")
```

就是增加一个总的子目录：
Expand All @@ -4950,7 +4950,7 @@ installdir
我们还可以单独配置 bin, lib 和 include 子目录，例如：

```lua
set_prefix("prefixdir", {bindir = "mybin", libdir = "mylib", includedir = "myinc"})
set_prefixdir("prefixdir", {bindir = "mybin", libdir = "mylib", includedir = "myinc"})
Copy link

@gemini-code-assist gemini-code-assist bot Oct 26, 2025

Choose a reason for hiding this comment

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

medium

This example correctly uses set_prefixdir with two arguments. However, the function prototype documented for set_prefixdir on line 4910 only shows one argument (prefixdir: <string>). To avoid confusion and improve documentation quality, please consider updating the function prototype to include the optional second table argument, for example: set_prefixdir(prefixdir: <string>, options?: <table>).

```

```sh
Expand All @@ -4964,7 +4964,7 @@ installdir
如果，我们不配置 prefixdir，仅仅修改 bin 子目录，可以将 prefixdir 配置成 `/`。

```lua
set_prefix("/", {bindir = "mybin", libdir = "mylib", includedir = "myinc"})
set_prefixdir("/", {bindir = "mybin", libdir = "mylib", includedir = "myinc"})
```

```sh
Expand Down