diff options
| author | Oskari Timperi <oskari.timperi@iki.fi> | 2019-10-26 10:40:10 +0300 |
|---|---|---|
| committer | Oskari Timperi <oskari.timperi@iki.fi> | 2019-10-26 10:40:10 +0300 |
| commit | c07ed1986623ab697c1e76822afc416fc76a8caa (patch) | |
| tree | e28e6cbe2fa8481d3493f5794e1f14b9ff68acf1 | |
| parent | 868fba56526185e2939b21af77285f25b4a922aa (diff) | |
| download | xmake-docs-fix-typos.tar.gz xmake-docs-fix-typos.zip | |
Fix typosfix-typos
| -rw-r--r-- | _sidebar.md | 2 | ||||
| -rw-r--r-- | guide/configuration.md | 10 | ||||
| -rw-r--r-- | guide/faq.md | 10 | ||||
| -rw-r--r-- | guide/quickstart.md | 2 | ||||
| -rw-r--r-- | manual/extension_modules.md | 6 | ||||
| -rw-r--r-- | manual/global_interfaces.md | 4 | ||||
| -rw-r--r-- | manual/plugin_task.md | 2 | ||||
| -rw-r--r-- | manual/project_target.md | 24 | ||||
| -rw-r--r-- | plugin/builtin_plugins.md | 4 | ||||
| -rw-r--r-- | plugin/plugin_development.md | 2 |
10 files changed, 33 insertions, 33 deletions
diff --git a/_sidebar.md b/_sidebar.md index 8a361d33..77f723fc 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -24,7 +24,7 @@ - Plugin - [Plugin Development](plugin/plugin_development.md) - - [Bultin Plugins](plugin/builtin_plugins.md) + - [Builtin Plugins](plugin/builtin_plugins.md) - [More Plugins](plugin/more_plugins.md) - API Manual diff --git a/guide/configuration.md b/guide/configuration.md index baca8055..d81a2aec 100644 --- a/guide/configuration.md +++ b/guide/configuration.md @@ -4,7 +4,7 @@ Set compilation configuration before building project with command `xmake f|conf And if you want to known more options, please run: `xmake f --help`。 <p class="tip"> - You can use short or long command option, for exmaple: <br> + You can use short or long command option, for example: <br> `xmake f` or `xmake config`.<br> `xmake f -p linux` or `xmake config --plat=linux`. </p> @@ -91,9 +91,9 @@ Fro other cross platform: ```bash $ xmake f -p cross --sdk=/usr/local/arm-xxx-gcc/ [--bin=/sdk/bin] [--cross=arm-linux-] $ xmake -``` +``` -For custem cross platform (`is_plat("myplat")`): +For custom cross platform (`is_plat("myplat")`): ```bash $ xmake f -p myplat --sdk=/usr/local/arm-xxx-gcc/ [--bin=/sdk/bin] [--cross=arm-linux-] @@ -319,12 +319,12 @@ $ xmake ``` <p class="tip"> - You can use short or long command option, for exmaple: `xmake g` or `xmake global`.<br> + You can use short or long command option, for example: `xmake g` or `xmake global`.<br> </p> ## Clean Configuration -We can clean all cached configuration and re-configure projecct. +We can clean all cached configuration and re-configure project. ```bash $ xmake f -c diff --git a/guide/faq.md b/guide/faq.md index fc6223d2..c12848a1 100644 --- a/guide/faq.md +++ b/guide/faq.md @@ -11,9 +11,9 @@ Get the help info of the configuration command. ```bash $ xmake f [-h|--help] -``` +``` -Get the help info of the givent action or plugin command. +Get the help info of the given action or plugin command. ```bash $ xmake [action|plugin] [-h|--help] @@ -42,7 +42,7 @@ $ xmake If it fails again, please add `-v` or `--verbose` options to get more verbose info. -For exmaple: +For example: ```hash $ xmake [-v|--verbose] @@ -60,7 +60,7 @@ $ xmake -v --backtrace $ xmake [-w|--warning] ``` -## How to scan source code and generate xmake.lua automaticlly? +## How to scan source code and generate xmake.lua automatically? You only need run the following command: @@ -68,7 +68,7 @@ You only need run the following command: $ xmake ``` -xmake will scan all source code in current directory and build it automaticlly. +xmake will scan all source code in current directory and build it automatically. And we can run it directly. diff --git a/guide/quickstart.md b/guide/quickstart.md index afcbde9d..34076d66 100644 --- a/guide/quickstart.md +++ b/guide/quickstart.md @@ -81,6 +81,6 @@ hello`main: ``` <p class="tip"> - You can also use short command option, for exmaple: `xmake r` or `xmake run` + You can also use short command option, for example: `xmake r` or `xmake run` </p> diff --git a/manual/extension_modules.md b/manual/extension_modules.md index c51de69c..db41c58d 100644 --- a/manual/extension_modules.md +++ b/manual/extension_modules.md @@ -149,7 +149,7 @@ function main(...) -- Run the built-in xmake configuration task, equivalent to: xmake f|config --plat=iphoneos --arch=armv7 task.run("config", {plat="iphoneos", arch="armv7"}) -emd +end ``` ### core.tool.linker @@ -289,7 +289,7 @@ For the target, link the specified object file list to generate the correspondin compiler.compile("xxx.c", "xxx.o", "xxx.h.d", {target = target}) ``` -Where [target](#target) is the project target, here is the specific compile option that is mainly used to get the taeget. If you get the project target object, see: [core.project.project](#core-project-project) +Where [target](#target) is the project target, here is the specific compile option that is mainly used to get the target. If you get the project target object, see: [core.project.project](#core-project-project) The `xxx.h.d` file is used to store the header file dependency file list for this source file. Finally, these two parameters are optional. You can not pass them when compiling: @@ -870,7 +870,7 @@ end Load specific language objects from the source file extension: `.cc, .c, .cpp, .mm, .swift, .go ..`, for example: ```lua -local lang = language.load_sk(".cpp") +local lang = language.load_ex(".cpp") if lang then print(lang:name()) end diff --git a/manual/global_interfaces.md b/manual/global_interfaces.md index f47762f2..362e5ca6 100644 --- a/manual/global_interfaces.md +++ b/manual/global_interfaces.md @@ -320,7 +320,7 @@ Of course, if we have no special requirements for the version of the dependency add_requires("tbox", "libpng", "zlib") ``` -This will use the latest known version of the package, or the source code compiled from the master branch. If the current package has a git repo address we can also specify a specific branch version: +This will use the latest known version of the package, or the source code compiled from the master branch. If the current package has a git repository address we can also specify a specific branch version: ```lua add_requires("tbox master") @@ -483,7 +483,7 @@ We can add through this interface: add_repositories("my-repo git@github.com:myrepo/xmake-repo.git") ``` -If we just want to add one or two private packages, this time to build a git repo is too big, we can directly put the package repository into the project, for example: +If we just want to add one or two private packages, this time to build a git repository is too big, we can directly put the package repository into the project, for example: ``` projectdir diff --git a/manual/plugin_task.md b/manual/plugin_task.md index b3bbcde4..4dcf72c8 100644 --- a/manual/plugin_task.md +++ b/manual/plugin_task.md @@ -162,7 +162,7 @@ Options: -P PROJECT, --project=PROJECT Change to the given project directory. Search priority: 1. The Given Command Argument - 2. The Envirnoment Variable: XMAKE_PROJECT_DIR + 2. The Environment Variable: XMAKE_PROJECT_DIR 3. The Current Directory -b, --bright Enable bright. diff --git a/manual/project_target.md b/manual/project_target.md index 48de9038..de911434 100644 --- a/manual/project_target.md +++ b/manual/project_target.md @@ -30,7 +30,7 @@ target("test2") | [set_strip](#targetset_strip) | Strip target symbols | >= 1.0.1 | | [set_enabled](#targetset_enabled) | Enable or disable target | >= 2.2.2 | | [set_default](#targetset_default) | Mark as default target | >= 2.1.3 | -| [set_options](#targetset_options) | Set configuartion options | >= 1.0.1 | +| [set_options](#targetset_options) | Set configuration options | >= 1.0.1 | | [set_symbols](#targetset_symbols) | Set symbol info | >= 1.0.1 | | [set_basename](#targetset_basename) | Set the base name of target file | >= 2.1.2 | | [set_filename](#targetset_filename) | Set the full name of target file | >= 2.1.2 | @@ -43,7 +43,7 @@ target("test2") | [set_dependir](#targetset_dependir) | Set output directories for dependent files | >= 2.2.2 | | [add_imports](#targetadd_imports) | Add imported modules for the custom script | >= 2.1.7 | | [add_rules](#targetadd_rules) | Add custom compilation rule to target | >= 2.1.9 | -| [on_load](#targeton_load) | Run custom load target configuartion script | >= 2.1.5 | +| [on_load](#targeton_load) | Run custom load target configuration script | >= 2.1.5 | | [on_link](#targeton_link) | Run custom link target script | >= 2.2.7 | | [on_build](#targeton_build) | Run custom build target script | >= 2.0.1 | | [on_build_file](#targeton_build_file) | Run custom build single file script | >= 2.2.3 | @@ -113,17 +113,17 @@ target("test2") | [add_frameworkdirs](#targetadd_frameworkdirs) | Add framework search directories | >= 2.1.5 | | [set_tools](#targetset_tools) | Set toolchains | >= 2.2.1 | | [add_tools](#targetadd_tools) | Add toolchains | >= 2.2.1 | -| [set_values](#targetset_values) | Set custom configuartion values | >= 2.2.1 | -| [add_values](#targetadd_values) | Add custom configuartion values | >= 2.2.1 | +| [set_values](#targetset_values) | Set custom configuration values | >= 2.2.1 | +| [add_values](#targetadd_values) | Add custom configuration values | >= 2.2.1 | | [set_rundir](#targetset_rundir) | Set run directory | >= 2.2.7 | | [add_runenvs](#targetadd_runenvs) | Add run environments | >= 2.2.7 | | [set_runenv](#targetset_runenv) | Set run environment | >= 2.2.8 | | [set_installdir](#targetset_installdir) | Set the installation directory | >= 2.2.5 | | [add_installfiles](#targetadd_installfiles) | add installation files | >= 2.2.5 | | [add_headerfiles](#targetadd_headerfiles) | Add header files | >= 2.2.5 | -| [set_configdir](#targetset_configdir) | Set the output directory of configuartion files | >= 2.2.5 | -| [set_configvar](#targetset_configvar) | Set template configuartion variable | >= 2.2.5 | -| [add_configfiles](#targetadd_configfiles) | Add template configuartion files | >= 2.2.5 | +| [set_configdir](#targetset_configdir) | Set the output directory of configuration files | >= 2.2.5 | +| [set_configvar](#targetset_configvar) | Set template configuration variable | >= 2.2.5 | +| [add_configfiles](#targetadd_configfiles) | Add template configuration files | >= 2.2.5 | ### target @@ -137,10 +137,10 @@ target("test") add_files("src/*.c") ``` -And we can call `target("demo")` repeatly to enter the target scope for modifying it's configuartion. +And we can call `target("demo")` repeatedly to enter the target scope for modifying it's configuration. ```lua --- defines target: demo and enter it's scope to set configuartion +-- defines target: demo and enter it's scope to set configuration target("demo") set_kind("binary") add_files("src/demo.c") @@ -155,7 +155,7 @@ target("demo") ``` <p class="tip"> -All configuartion in root scope affects all targets, but does not affect the configuartion of `option()`. +All configuration in root scope affects all targets, but does not affect the configuration of `option()`. </p> For example: @@ -299,7 +299,7 @@ $ xmake install [-a|--all] ### target:set_options -#### Set configuartion options +#### Set configuration options Add option dependencies. If you have customized some options through the [option](#option) interface, you can add associations only if you specify this option under the target target field. @@ -609,7 +609,7 @@ We can also specify the application of local files to the rules, see: [add_files ### target:on_load -#### Run custom load target configuartion script +#### Run custom load target configuration script This script will be executed when the target is initialized and loaded, and some dynamic target configurations can be made to achieve more flexible target description definitions, for example: diff --git a/plugin/builtin_plugins.md b/plugin/builtin_plugins.md index 9b842025..70cd0077 100644 --- a/plugin/builtin_plugins.md +++ b/plugin/builtin_plugins.md @@ -50,7 +50,7 @@ v2.2.8 or later, provides a new version of the vs project generation plugin exte But this mode, there is no way to support the rules of xmake. Because xmake's rules use a lot of custom scripts like `on_build`, they can't be expanded, so projects like qt, wdk can't support exporting to vs. compile. -Therefore, in order to solve this problem, the new version of the vs. build plugin performs the compile operation by directly calling the xmake command under vs, and also supports intellsence and definition jumps, as well as breakpoint debugging. +Therefore, in order to solve this problem, the new version of the vs. build plugin performs the compile operation by directly calling the xmake command under vs, and also supports intellisense and definition jumps, as well as breakpoint debugging. The specific use is similar to the old version: @@ -192,7 +192,7 @@ If you want to cancel multiline input, please input character `q`, for example: We can record and playback our xmake commands and save as macro quickly using this plugin. -And we can run this macro to simplify our jobs repeatly. +And we can run this macro to simplify our jobs repeatably. ### Record Commands diff --git a/plugin/plugin_development.md b/plugin/plugin_development.md index 6fb0f9d1..03fa9491 100644 --- a/plugin/plugin_development.md +++ b/plugin/plugin_development.md @@ -14,7 +14,7 @@ Plugins: ``` * lua: Run a given lua script. -* macro: Record and playback some xmake commands repeatly. +* macro: Record and playback some xmake commands repeatably. * doxygen:Generate doxygen document automatically. * hello: The demo plugin and only print: 'hello xmake!' * project:Generate project file for IDE, only generate makefile now and will generate vs, xcode project in the future |
