From 68036c7bbc6ea2a89648c661107fff8d8c83deeb Mon Sep 17 00:00:00 2001 From: Liviu Ionescu Date: Mon, 9 Dec 2024 10:41:42 +0200 Subject: [PATCH] website update --- website/docs/cli/xpm/index.mdx | 75 ++++++----- website/docs/cli/xpm/init/index.mdx | 173 +++++++++++-------------- website/docs/cli/xpm/install/index.mdx | 171 ++++++++++++++---------- website/docs/cli/xpm/list/index.mdx | 2 + 4 files changed, 226 insertions(+), 195 deletions(-) diff --git a/website/docs/cli/xpm/index.mdx b/website/docs/cli/xpm/index.mdx index e58efa2..a576a22 100644 --- a/website/docs/cli/xpm/index.mdx +++ b/website/docs/cli/xpm/index.mdx @@ -11,6 +11,12 @@ date: 2017-10-09 12:50:00 +0300 --- +import CodeBlock from '@theme/CodeBlock'; + +import customField from '@site/src/libs/customField'; + +{/* ------------------------------------------------------------------------ */} + # xpm ## Synopsis @@ -21,8 +27,9 @@ xpm [...] [ ...] [...] ## Description -`xpm` is the xPacks project manager. It manages dependencies -and puts packages in known places so that builds can find them. +`xpm` is the xPacks project manager. It handles dependencies and +places packages in designated locations, ensuring that builds can +locate them efficiently. :::info @@ -32,23 +39,24 @@ uses the same public registry at https://registry.npmjs.org." ::: -The program accepts a command name, possibly one or more subcommand -names, options (that start with a dash) and possibly one or more -arguments, like names, files, etc. +The programme accepts a command name, potentially accompanied by one +or more subcommand names, options (which begin with a dash), and +possibly one or more arguments, such as names or files. The list of accepted options and arguments is specific to a given -command, or set of command and subcommands. +command or set of commands and subcommands. ## Common options ### Help (`-h|--help`) -To get an initial glimpse on the program, ask for help: +To gain an initial understanding of the programme, request help: -```console -$ xpm --help -The xPack package manager command line tool + { +`% xpm --help + +The xPack project manager command line tool Usage: xpm [...] [ ...] [...] where is one of: @@ -70,20 +78,20 @@ xpm -h|--help Quick help on command xpm --version Show version xpm -i|--interactive Enter interactive mode -npm xpm@0.9.0 '/Users/ilg/.nvm/versions/node/v14.16.0/lib/node_modules/xpm' -Home page: -Bug reports: -``` +npm xpm@${customField('releaseVersion')} '/Users/ilg/.nvm/versions/node/v20.18.0/lib/node_modules/xpm' +Home page: +Bug reports: +`} -This works both at top level and with commands/subcommands. +This functions both at top level and with commands/subcommands. ### Log level (`--loglevel`) The default behaviour of the program is to display only a minimum amount of messages. -This can be changed, from not displaying any messages at all (`--silent`) -to displaying lots of debugging trace messages (`--trace`). +This can be adjusted, ranging from not displaying any messages at all +(`--silent`) to displaying numerous debugging trace messages (`--trace`). ```console --loglevel Set log level (silent|warn|info|verbose|debug|trace) @@ -97,27 +105,26 @@ to displaying lots of debugging trace messages (`--trace`). ### Current folder (`-C`) -By default the program is executed in the context of the current shell -folder, but it can be changed to any folder using `-C `. +By default, the program is executed within the context of the current shell +folder> However, this can be changed to any folder using `-C `. ### Program version (`--version`) -As for most command line tools, it is possible to ask for the current -version, with `--version`: +As with most command line tools, it is possible to request the current version, with `--version`: -```console -$ xpm --version -0.9.0 -``` + { +`% xpm --version +${customField('releaseVersion')} +`} -The result is written to the standard output stream, and consists of the -semver string, without any `v` prefix, so it can be directly used in -automated scripts, without any post processing. +The result is written to the standard output stream and consists of the +semver string, without any `v` prefix. This allows it to be directly +used in automated scripts without any post-processing. ### Skip checks (`--no-update-notifier`) -By default, before exiting, `xpm` checks, once a day, if there is a -new version of the program available. +By default, before exiting, `xpm` checks once a day if a new version +of the programme is available. For environments where this check is not necessary, it can be disabled. @@ -128,13 +135,13 @@ The common use case is to start the program for each single command. It is also possible to start the program with a prompt, and issue as many commands as needed. -```console -$ xpm -i + { +`% xpm -i xpm> version -0.9.0 +${customField('releaseVersion')} xpm> ... -``` +`} ## Commands diff --git a/website/docs/cli/xpm/init/index.mdx b/website/docs/cli/xpm/init/index.mdx index 9144a79..7d172b4 100644 --- a/website/docs/cli/xpm/init/index.mdx +++ b/website/docs/cli/xpm/init/index.mdx @@ -7,11 +7,17 @@ keywords: - xpm - cli - init - + date: 2017-10-09 12:55:00 +0300 --- +import CodeBlock from '@theme/CodeBlock'; + +import customField from '@site/src/libs/customField'; + +{/* ------------------------------------------------------------------------ */} + # xpm init ## Synopsis @@ -27,17 +33,17 @@ Aliases: ## Description -Initialise the current folder as an xpm package, by creating a skeleton -`package.json` file. This file needs further editing to update most +Initialise the current folder as an xpm package by creating a skeleton +`package.json` file. This file requires further editing to update most of the objects. -If called with a template, use the template and create a custom -project with as many files and folders as necessary. +If invoked with a template, use the template to create a custom project +with as many files and folders as necessary. :::info The current behaviour may change, -the template API is not yet final. +as the template API is not yet final. ::: @@ -46,17 +52,18 @@ the template API is not yet final. ### Help (`--help`) -```console -$ xpm init --help + { +`% xpm init --help -xPack manager - create an xPack, empty or from a template +xPack project manager - create an xpm package, empty or from a template Usage: xpm init [options...] [--template ] [--name ] - [--property ]* + [--property ]* [--ignore-errors] Init options: - -t|--template The xPack implementing the template (optional) + -t|--template The xpm package implementing the template (optional) -n|--name Project name (optional) -p|--property Substitution variables (optional, multiple) + --ignore-errors Ignore script errors (optional) Common options: --loglevel Set log level (silent|warn|info|verbose|debug|trace) @@ -69,67 +76,54 @@ Common options: --no-update-notifier Skip check for a more recent version -C Set current folder -xpm -h|--help Quick help -xpm --version Show version -xpm -i|--interactive Enter interactive mode +xpm -h|--help Quick help +xpm --version Show version +xpm -i|--interactive Enter interactive mode -npm xpm@0.9.0 '/Users/ilg/.nvm/versions/node/v14.16.0/lib/node_modules/xpm' -Home page: -Bug reports: -$ -``` +npm xpm@${customField('releaseVersion')} '/Users/ilg/.nvm/versions/node/v20.18.0/lib/node_modules/xpm' +Home page: +Bug reports: +`} ### Template (`-t|--template `) Create the xpm package using a template. The template itself is an xpm package -with a specific code that implements a template API. +containing a specific code that implements the template API. -Example: Create a project in an interactive session by answering -lots of questions: +#### Example + +Create a project in an interactive session by answering +several questions: ```console -$ xpm init --template @sifive/templates --verbose -xPack manager - create an xPack, empty or from a template - -Processing @sifive/templates@1.0.4... - -Programming language? (c, cpp, ?) [cpp]: -Board? (hifive1, e31arty, e51arty, ?) [hifive1]: -Content? (empty, blinky, ?) [blinky]: -Use system calls? (none, retarget, semihosting, ?) [retarget]: -Trace output? (none, uart0ftdi, stdout, debug, ?) [uart0ftdi]: -Check some warnings? (true, false, ?) [true]: -Check most warnings? (true, false, ?) [false]: -Enable -Werror? (true, false, ?) [false]: -Use -Og on debug? (true, false, ?) [false]: -Use newlib nano? (true, false, ?) [true]: - -Creating the C++ project 'hifive1-blinky-cpp'... +% mkdir my-project && cd my-project +% xpm init --template @xpack/hello-world-template@latest + +Checking package @xpack/hello-world-template@latest metadata... +Processing @xpack/hello-world-template@0.6.1... + +Programming language? (c, cpp, ?) [cpp]: c +Build System? (cmake, meson, autotools, ?) [cmake]: +Toolchain? (gcc, clang, system, ?) [gcc]: clang +Creating the C project 'my-project'... +File 'include/hello-world.h' copied. +File 'src/hello-world.c' copied. +File 'libs/adder/include/add/add.h' copied. +File 'libs/adder/src/add.c' copied. +Folder 'cmake' copied. +File 'CMakeLists.txt' generated. +File '.vscode/tasks.json' copied. +File '.vscode/settings.json' copied. +File '.gitignore' copied. +File '.npmignore' copied. +File 'README.md' generated. File 'LICENSE' generated. -File 'oocd.launch' generated. -File 'jlink.launch' generated. File 'package.json' generated. -File 'README.md' generated. -File 'xmake.json' generated. -File 'include/led.h' generated. -File 'include/sysclock.h' copied. -File 'ldscripts/libs.ld' copied. -File 'ldscripts/mem.ld' copied. -File 'ldscripts/sections.ld' copied. -File 'src/initialize-hardware.cpp' generated. -File 'src/interrupts-handlers.cpp' generated. -File 'src/led.cpp' copied. -File 'src/main.cpp' generated. -File 'src/newlib-syscalls.c' copied. -File 'src/sysclock.cpp' copied. - -'xpm init' completed in 77 ms. -$ ``` ### Name (`--name `) -Define a name for the new xpm package. If missing, the package name is +Define a name for the new xpm package. If omitted, the package name is derived from the current folder name. ### Properties (`-p|--property `) @@ -139,45 +133,34 @@ properties can be defined. The names, values and behaviours are all specific to each template engine. -Example: the same template as before, if it receives a mandatory -`boardName` property, -can create the new xpm package without further questions, by using defaults: +#### Example -```console -$ xpm init --template @sifive/templates --property boardName=hifive1 -xPack manager - create an xPack, empty or from a template - -Processing @sifive/templates@1.0.4... - -Creating the C++ project 'hifive1-blinky-cpp'... -- boardName=hifive1 -- content=blinky -- syscalls=retarget -- trace=uart0ftdi -- useSomeWarnings=true -- useMostWarnings=false -- useWerror=false -- useOg=false -- useNano=true +The same template as before, if it receives a mandatory +`language` property, +can create the new xpm package without further questions by using defaults: +```console +% mkdir -p my-project && cd my-project +% xpm init --template @xpack/hello-world-template@latest --property language=c --property toolchain=clang + +Installing @xpack/hello-world-template@0.6.1... +Processing @xpack/hello-world-template@0.6.1... + +Creating the C project 'my-project'... +- buildGenerator=cmake +- toolchain=clang + +File 'include/hello-world.h' copied. +File 'src/hello-world.c' copied. +File 'libs/adder/include/add/add.h' copied. +File 'libs/adder/src/add.c' copied. +Folder 'cmake' copied. +File 'CMakeLists.txt' generated. +File '.vscode/tasks.json' copied. +File '.vscode/settings.json' copied. +File '.gitignore' copied. +File '.npmignore' copied. +File 'README.md' generated. File 'LICENSE' generated. -File 'oocd.launch' generated. -File 'jlink.launch' generated. File 'package.json' generated. -File 'README.md' generated. -File 'xmake.json' generated. -File 'include/led.h' generated. -File 'include/sysclock.h' copied. -File 'ldscripts/libs.ld' copied. -File 'ldscripts/mem.ld' copied. -File 'ldscripts/sections.ld' copied. -File 'src/initialize-hardware.cpp' generated. -File 'src/interrupts-handlers.cpp' generated. -File 'src/led.cpp' copied. -File 'src/main.cpp' generated. -File 'src/newlib-syscalls.c' copied. -File 'src/sysclock.cpp' copied. - -'xpm init' completed in 1.144 sec. -$ ``` diff --git a/website/docs/cli/xpm/install/index.mdx b/website/docs/cli/xpm/install/index.mdx index 38ae60a..f07d8ae 100644 --- a/website/docs/cli/xpm/install/index.mdx +++ b/website/docs/cli/xpm/install/index.mdx @@ -47,86 +47,123 @@ As for npm, a package is any of the following: 6. A `` that has a `latest` tag satisfying (5). 7. A `git` url that, when cloned, results in (1). -Even if you never publish your package, you can still get a lot of -benefits of using xpm to conveniently install dependencies, -and perhaps -to automate path management for dependent tools. +Even if you never publish your package, you can still gain numerous +benefits from using xpm to conveniently install dependencies and +potentially automate path management for dependent tools. ### Install dependencies When invoked without arguments in a package folder, `xpm install` installs the dependencies listed in the `dependencies` and `devDependencies` -field in `package.json`. +fields in `package.json`. -If the dependencies are xPacks, they are installed in the local `xpacks` -folder. For binary xPacks, soft links to the executables are created +The dependencies are installed in the local `xpacks` +folder. For binary xpm packages, soft links to the executables are created in the `xpacks/.bin` folder (on Windows `.cmd` stubs are created). -To maintain compatibility with npm, dependencies -must not necessarily be xPacks, they can also be npm modules, -and are installed as usual in `node_modules`. - -Example: +#### Example ```console -$ cd /tmp/hifive1-blinky-cpp -$ xpm install --verbose -xPack manager - install package(s) - -Installing dependencies for 'hifive1-blinky-cpp'... -Folder 'micro-os-plus-diag-trace' linked to '@micro-os-plus/diag-trace/1.0.6'. -Folder 'sifive-hifive1-board' linked to '@sifive/hifive1-board/1.0.3'. -Folder 'sifive-devices' linked to '@sifive/devices/1.0.2'. -Folder 'micro-os-plus-riscv-arch' linked to '@micro-os-plus/riscv-arch/1.0.2'. -Folder 'micro-os-plus-startup' linked to '@micro-os-plus/startup/1.0.7'. -Folder 'micro-os-plus-c-libs' linked to '@micro-os-plus/c-libs/1.0.6'. -Folder 'micro-os-plus-cpp-libs' linked to '@micro-os-plus/cpp-libs/1.0.4'. -Folder 'xmake' linked to 'xmake/0.3.8'. -File 'xmake' linked to 'xmake/bin/xmake.js' -Folder 'gnu-mcu-eclipse-riscv-none-gcc' linked to '@gnu-mcu-eclipse/riscv-none-gcc/7.2.0-2.1'. -File 'riscv-none-embed-addr2line' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-addr2line' -File 'riscv-none-embed-ar' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-ar' -File 'riscv-none-embed-as' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-as' -File 'riscv-none-embed-c++' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-c++' -File 'riscv-none-embed-c++filt' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-c++filt' -File 'riscv-none-embed-cpp' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-cpp' -File 'riscv-none-embed-elfedit' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-elfedit' -File 'riscv-none-embed-g++' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-g++' -File 'riscv-none-embed-gcc' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-gcc' -File 'riscv-none-embed-gcc-7.2.0' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-gcc-7.2.0' -File 'riscv-none-embed-gcc-ar' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-gcc-ar' -File 'riscv-none-embed-gcc-nm' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-gcc-nm' -File 'riscv-none-embed-gcc-ranlib' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-gcc-ranlib' -File 'riscv-none-embed-gcov' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-gcov' -File 'riscv-none-embed-gcov-dump' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-gcov-dump' -File 'riscv-none-embed-gcov-tool' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-gcov-tool' -File 'riscv-none-embed-gdb' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-gdb' -File 'riscv-none-embed-gprof' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-gprof' -File 'riscv-none-embed-ld' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-ld' -File 'riscv-none-embed-ld.bfd' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-ld.bfd' -File 'riscv-none-embed-nm' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-nm' -File 'riscv-none-embed-objcopy' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-objcopy' -File 'riscv-none-embed-objdump' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-objdump' -File 'riscv-none-embed-ranlib' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-ranlib' -File 'riscv-none-embed-readelf' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-readelf' -File 'riscv-none-embed-run' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-run' -File 'riscv-none-embed-size' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-size' -File 'riscv-none-embed-strings' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-strings' -File 'riscv-none-embed-strip' linked to 'gnu-mcu-eclipse-riscv-none-gcc/.content/bin/riscv-none-embed-strip' -Folder 'gnu-mcu-eclipse-openocd' linked to '@gnu-mcu-eclipse/openocd/0.10.0-7.1'. -File 'openocd' linked to 'gnu-mcu-eclipse-openocd/.content/bin/openocd' -Folder 'gnu-mcu-eclipse-windows-build-tools' linked to '@gnu-mcu-eclipse/windows-build-tools/2.10.1'. - -'xpm install' completed in 6.086 sec. -$ +% cd my-project +% xpm install --verbose +xPack project manager - install package(s) + +Collecting dependencies for package @my-scope/my-project... +Identified @xpack-dev-tools/clang@18.1.8-2.1 as a dev dependency +Identified @xpack-dev-tools/cmake@3.28.6-1.1 as a dev dependency +Identified @xpack-dev-tools/ninja-build@1.11.1-3.1 as a dev dependency + +Installing 3 dependencies... +Folder 'xpacks/@xpack-dev-tools/cmake' linked to global '@xpack-dev-tools/cmake/3.28.6-1.1' +Folder 'xpacks/@xpack-dev-tools/ninja-build' linked to global '@xpack-dev-tools/ninja-build/1.11.1-3.1' +Folder 'xpacks/@xpack-dev-tools/clang' linked to global '@xpack-dev-tools/clang/18.1.8-2.1' +File 'xpacks/.bin/ccmake' linked to '../@xpack-dev-tools/cmake/.content/bin/ccmake' +File 'xpacks/.bin/ninja' linked to '../@xpack-dev-tools/ninja-build/.content/bin/ninja' +File 'xpacks/.bin/analyze-build' linked to '../@xpack-dev-tools/clang/.content/bin/analyze-build' +File 'xpacks/.bin/cmake' linked to '../@xpack-dev-tools/cmake/.content/bin/cmake' +File 'xpacks/.bin/clang' linked to '../@xpack-dev-tools/clang/.content/bin/clang' +File 'xpacks/.bin/cpack' linked to '../@xpack-dev-tools/cmake/.content/bin/cpack' +File 'xpacks/.bin/clang++' linked to '../@xpack-dev-tools/clang/.content/bin/clang++' +File 'xpacks/.bin/ctest' linked to '../@xpack-dev-tools/cmake/.content/bin/ctest' +File 'xpacks/.bin/clang-check' linked to '../@xpack-dev-tools/clang/.content/bin/clang-check' +File 'xpacks/.bin/clang-cl' linked to '../@xpack-dev-tools/clang/.content/bin/clang-cl' +File 'xpacks/.bin/clang-cpp' linked to '../@xpack-dev-tools/clang/.content/bin/clang-cpp' +File 'xpacks/.bin/clang-doc' linked to '../@xpack-dev-tools/clang/.content/bin/clang-doc' +File 'xpacks/.bin/clang-format' linked to '../@xpack-dev-tools/clang/.content/bin/clang-format' +File 'xpacks/.bin/clang-include-cleaner' linked to '../@xpack-dev-tools/clang/.content/bin/clang-include-cleaner' +File 'xpacks/.bin/clang-linker-wrapper' linked to '../@xpack-dev-tools/clang/.content/bin/clang-linker-wrapper' +File 'xpacks/.bin/clang-refactor' linked to '../@xpack-dev-tools/clang/.content/bin/clang-refactor' +File 'xpacks/.bin/clang-rename' linked to '../@xpack-dev-tools/clang/.content/bin/clang-rename' +File 'xpacks/.bin/clang-repl' linked to '../@xpack-dev-tools/clang/.content/bin/clang-repl' +File 'xpacks/.bin/clang-scan-deps' linked to '../@xpack-dev-tools/clang/.content/bin/clang-scan-deps' +File 'xpacks/.bin/clang-tblgen' linked to '../@xpack-dev-tools/clang/.content/bin/clang-tblgen' +File 'xpacks/.bin/clang-tidy' linked to '../@xpack-dev-tools/clang/.content/bin/clang-tidy' +File 'xpacks/.bin/clangd' linked to '../@xpack-dev-tools/clang/.content/bin/clangd' +File 'xpacks/.bin/darwin-debug' linked to '../@xpack-dev-tools/clang/.content/bin/darwin-debug' +File 'xpacks/.bin/diagtool' linked to '../@xpack-dev-tools/clang/.content/bin/diagtool' +File 'xpacks/.bin/git-clang-format' linked to '../@xpack-dev-tools/clang/.content/bin/git-clang-format' +File 'xpacks/.bin/hmaptool' linked to '../@xpack-dev-tools/clang/.content/bin/hmaptool' +File 'xpacks/.bin/ld.lld' linked to '../@xpack-dev-tools/clang/.content/bin/ld.lld' +File 'xpacks/.bin/ld64.lld' linked to '../@xpack-dev-tools/clang/.content/bin/ld64.lld' +File 'xpacks/.bin/llc' linked to '../@xpack-dev-tools/clang/.content/bin/llc' +File 'xpacks/.bin/lld' linked to '../@xpack-dev-tools/clang/.content/bin/lld' +File 'xpacks/.bin/lld-link' linked to '../@xpack-dev-tools/clang/.content/bin/lld-link' +File 'xpacks/.bin/lldb' linked to '../@xpack-dev-tools/clang/.content/bin/lldb' +File 'xpacks/.bin/lldb-argdumper' linked to '../@xpack-dev-tools/clang/.content/bin/lldb-argdumper' +File 'xpacks/.bin/lldb-instr' linked to '../@xpack-dev-tools/clang/.content/bin/lldb-instr' +File 'xpacks/.bin/lldb-server' linked to '../@xpack-dev-tools/clang/.content/bin/lldb-server' +File 'xpacks/.bin/lli' linked to '../@xpack-dev-tools/clang/.content/bin/lli' +File 'xpacks/.bin/llvm-addr2line' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-addr2line' +File 'xpacks/.bin/llvm-ar' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-ar' +File 'xpacks/.bin/llvm-as' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-as' +File 'xpacks/.bin/llvm-bitcode-strip' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-bitcode-strip' +File 'xpacks/.bin/llvm-config' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-config' +File 'xpacks/.bin/llvm-cov' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-cov' +File 'xpacks/.bin/llvm-cxxdump' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-cxxdump' +File 'xpacks/.bin/llvm-cxxfilt' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-cxxfilt' +File 'xpacks/.bin/llvm-cxxmap' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-cxxmap' +File 'xpacks/.bin/llvm-debuginfo-analyzer' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-debuginfo-analyzer' +File 'xpacks/.bin/llvm-debuginfod' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-debuginfod' +File 'xpacks/.bin/llvm-debuginfod-find' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-debuginfod-find' +File 'xpacks/.bin/llvm-diff' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-diff' +File 'xpacks/.bin/llvm-dis' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-dis' +File 'xpacks/.bin/llvm-dlltool' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-dlltool' +File 'xpacks/.bin/llvm-dwarfutil' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-dwarfutil' +File 'xpacks/.bin/llvm-lib' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-lib' +File 'xpacks/.bin/llvm-libtool-darwin' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-libtool-darwin' +File 'xpacks/.bin/llvm-nm' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-nm' +File 'xpacks/.bin/llvm-objcopy' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-objcopy' +File 'xpacks/.bin/llvm-objdump' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-objdump' +File 'xpacks/.bin/llvm-otool' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-otool' +File 'xpacks/.bin/llvm-profdata' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-profdata' +File 'xpacks/.bin/llvm-ranlib' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-ranlib' +File 'xpacks/.bin/llvm-rc' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-rc' +File 'xpacks/.bin/llvm-readelf' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-readelf' +File 'xpacks/.bin/llvm-readobj' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-readobj' +File 'xpacks/.bin/llvm-remarkutil' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-remarkutil' +File 'xpacks/.bin/llvm-sim' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-sim' +File 'xpacks/.bin/llvm-size' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-size' +File 'xpacks/.bin/llvm-strings' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-strings' +File 'xpacks/.bin/llvm-strip' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-strip' +File 'xpacks/.bin/llvm-symbolizer' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-symbolizer' +File 'xpacks/.bin/llvm-tblgen' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-tblgen' +File 'xpacks/.bin/llvm-tli-checker' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-tli-checker' +File 'xpacks/.bin/llvm-windres' linked to '../@xpack-dev-tools/clang/.content/bin/llvm-windres' +File 'xpacks/.bin/run-clang-tidy' linked to '../@xpack-dev-tools/clang/.content/bin/run-clang-tidy' +File 'xpacks/.bin/scan-build-py' linked to '../@xpack-dev-tools/clang/.content/bin/scan-build-py' +File 'xpacks/.bin/set-xcode-analyzer' linked to '../@xpack-dev-tools/clang/.content/bin/set-xcode-analyzer' +File 'xpacks/.bin/split-file' linked to '../@xpack-dev-tools/clang/.content/bin/split-file' +File 'xpacks/.bin/wasm-ld' linked to '../@xpack-dev-tools/clang/.content/bin/wasm-ld' + +'xpm install' completed in 1.931 sec. ``` ### Install packages When invoked with arguments, they must refer to packages. The common -use case is to use names of packages stored on the public npm repository, -but since xpm uses the same library to manage downloads as npm, -all formats are accepted: +use case is to use names of packages stored on the public npm repository. +However, since xpm uses the same library to manage downloads as npm, all +formats are accepted: ```sh xpm install [<@scope>/] @@ -150,7 +187,7 @@ For detail please see [`npm install`](https://docs.npmjs.com/cli/install). Examples: ```console -$ xpm install --global @gnu-mcu-eclipse/arm-none-eabi-gcc --verbose +$ xpm install --global @xpack-dev-tools/arm-none-eabi-gcc --verbose xPack manager - install package(s) Processing @gnu-mcu-eclipse/arm-none-eabi-gcc@8.2.1-1.7.1... @@ -213,9 +250,11 @@ Bug reports: Install package(s) in the global xPacks store (in the user home folder). +{/* ### System install (`-sy|--system`) Install package(s) in the system repository. +*/} ### Force install (`-f|--force`) diff --git a/website/docs/cli/xpm/list/index.mdx b/website/docs/cli/xpm/list/index.mdx index 04a6ff5..cd5d729 100644 --- a/website/docs/cli/xpm/list/index.mdx +++ b/website/docs/cli/xpm/list/index.mdx @@ -73,9 +73,11 @@ Bug reports: List the packages installed in the central xPacks store. +{/* ### List system packages (`-sy|--system`) List the packages installed in the system store. +*/} ### Configuration (`-c|--config`)