Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Although less precise, one can still understand Xmake in the following way:
Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache
```

If you want to know more, please refer to: the [Documentation](https://xmake.io/#/getting_started), [GitHub](https://github.com/xmake-io/xmake) or [Gitee](https://gitee.com/tboox/xmake). You are also welcome to join our [community](https://xmake.io/#/about/contact).
If you want to know more, please refer to: the [Documentation](https://xmake.io/guide/quick-start), [GitHub](https://github.com/xmake-io/xmake) or [Gitee](https://gitee.com/tboox/xmake). You are also welcome to join our [community](https://xmake.io/about/contact).

The official Xmake repository can be found at [xmake-io/xmake-repo](https://github.com/xmake-io/xmake-repo).

Expand Down
2 changes: 1 addition & 1 deletion docs/api/description/builtin-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ target("test")

## plugin.compile_commands.autoupdate

We can also use this rule to automatically update the generated compile_commandss.json
We can also use this rule to automatically update the generated `compile_commands.json`

```lua
add_rules("plugin.compile_commands.autoupdate", {outputdir = ".vscode"})
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/package-management/package-distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,13 +223,13 @@ $ xmake package -f remote --url=https://xxxx/xxx.tar.gz --shasum=xxxxx --homepag

xmake will also read the relevant configuration information from the target's `set_license` and `set_version` configurations.

## Submit package to the official repository
## Submit packages to the official repository

If you need a package that is not supported by the current official repository, you can commit it to the official repository after local tuning: [xmake-repo](https://github.com/xmake-io/xmake-repo)

For detailed contribution descriptions, see: [CONTRIBUTING.md](https://github.com/xmake-io/xmake-repo/blob/master/CONTRIBUTING.md)

For how to make your own package, you can look at the above: [Submit packages to the official repository](#submit-packages-to-the-official-repository).
For how to make and use your self-built private package, you can read this: [Using self-built private package repository ](/guide/package-management/using-official-packages.html#using-self-built-private-package-repository).

## Distributing and using custom package rules

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/api/description/builtin-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ target("test")

## plugin.compile_commands.autoupdate

我们也可以使用这个规则来自动更新生成 compile_commandss.json
我们也可以使用这个规则来自动更新生成 `compile_commands.json`

```lua
add_rules("plugin.compile_commands.autoupdate", {outputdir = ".vscode"})
Expand Down
4 changes: 2 additions & 2 deletions docs/zh/api/description/project-target.md
Original file line number Diff line number Diff line change
Expand Up @@ -1494,7 +1494,7 @@ target("demo")

### 调整链接顺序

这是 xmake 2.8.5 以后得版本才支持的特性,主要用于调整 target 内部的链接顺序。
这是 xmake 2.8.5 以后的版本才支持的特性,主要用于调整 target 内部的链接顺序。

由于 xmake 提供了 `add_links`, `add_deps`, `add_packages`, `add_options` 接口,可以配置目标、依赖,包和选项中的链接。

Expand Down Expand Up @@ -1598,7 +1598,7 @@ target("demo")

### 添加链接组

这是 xmake 2.8.5 以后得版本才支持的特性,这个链接组的特性,目前主要用于 linux 平台的编译,仅支持 gcc/clang 编译器。
这是 xmake 2.8.5 以后的版本才支持的特性,这个链接组的特性,目前主要用于 linux 平台的编译,仅支持 gcc/clang 编译器。

需要注意的是 gcc/clang 里面的链接组概念主要特指:`-Wl,--start-group`

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/api/scripts/package-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,7 @@ end)

```lua
on_test(function (package)
assert(package:has_cincludes("foo.hpp"))
assert(package:has_cxxincludes("foo.hpp"))
end)
```

Expand Down
4 changes: 2 additions & 2 deletions docs/zh/guide/package-management/package-distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,15 +225,15 @@ $ xmake package -f remote --url=https://xxxx/xxx.tar.gz --shasum=xxxxx --homepag

xmake 也会从 target 的 `set_license` 和 `set_version` 等配置中读取相关配置信息。

## 提交包到官方仓库 {#submit-package-to-official-repository}
## 提交包到官方仓库 {#submit-packages-to-the-official-repository}

目前这个特性刚完成不久,目前官方仓库的包还不是很多,有些包也许还不支持部分平台,不过这并不是太大问题,后期迭代几个版本后,我会不断扩充完善包仓库。

如果你需要的包,目前的官方仓库还没有收录,可以提交 issues 或者自己可以在本地调通后,贡献提交到官方仓库:[xmake-repo](https://github.com/xmake-io/xmake-repo)

详细的贡献说明,见:[CONTRIBUTING.md](https://github.com/xmake-io/xmake-repo/blob/master/CONTRIBUTING.md)

关于如何制作自己的包,可以看下上文:[添加包到仓库](#添加包到仓库)。
关于如何制作使用自建私有包仓库,可以查看:[使用自建私有包仓库](/zh/guide/package-management/using-official-packages.html#using-self-built-private-package-repository)。

## 分发和使用自定义包规则 {#custom-rule-distribution}

Expand Down
4 changes: 2 additions & 2 deletions docs/zh/guide/package-management/using-official-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ add_requires("zlib 1.x", {external = false})
-I /Users/ruki/.xmake/packages/z/zlib/1.2.11/d639b7d6e3244216b403b39df5101abf/include
```

## 使用自建私有包仓库 {#using-self-repository}
## 使用自建私有包仓库 {#using-self-built-private-package-repository}

如果需要的包不在官方仓库[xmake-repo](https://github.com/xmake-io/xmake-repo)中,我们可以提交贡献代码到仓库进行支持。
但如果有些包仅用于个人或者私有项目,我们可以建立一个私有仓库repo,仓库组织结构可参考:[xmake-repo](https://github.com/xmake-io/xmake-repo)
Expand Down Expand Up @@ -315,7 +315,7 @@ target("test")
add_packages("libjpeg")
```

关于如何编写自定义包描述规则,详情见:[添加包到仓库](/zh/guide/package-management/package-distribution.html#submit-package-to-official-repository)
关于如何编写自定义包描述规则,详情见:[添加包到仓库](/zh/guide/package-management/package-distribution.html#submit-packages-to-the-official-repository)

## 依赖包的锁定和升级 {#lock-and-upgrade-package}

Expand Down