diff --git a/pages/common/sfdk-apply.md b/pages/common/sfdk-apply.md new file mode 100644 index 0000000000..8df1282b45 --- /dev/null +++ b/pages/common/sfdk-apply.md @@ -0,0 +1,12 @@ +# sfdk apply + +> Applies patches from RPM SPEC file. +> More information: . + +- Apply all patches: + +`sfdk apply` + +- Reverse apply all patches: + +`sfdk apply -R` diff --git a/pages/common/sfdk-build-init.md b/pages/common/sfdk-build-init.md new file mode 100644 index 0000000000..2e1d4e7204 --- /dev/null +++ b/pages/common/sfdk-build-init.md @@ -0,0 +1,12 @@ +# sfdk build-init + +> Initializes build directory. +> More information: . + +- Initialize the current directory as the build directory: + +`sfdk build-init` + +- Initialize the specified directory as the build directory: + +`sfdk build-init {{directory}}` diff --git a/pages/common/sfdk-build-requires.md b/pages/common/sfdk-build-requires.md new file mode 100644 index 0000000000..89f35323d4 --- /dev/null +++ b/pages/common/sfdk-build-requires.md @@ -0,0 +1,24 @@ +# sfdk build-requires + +> Updates build time dependencies. +> More information: . + +- Run a subcommand refreshing the cache: + +`sfdk build-requires --refresh {{subcommand}}` + +- Run a subcommand without refreshing the cache: + +`sfdk build-requires --no-refresh {{subcommand}}` + +- Install or update the build-time dependencies: + +`sfdk build-requires pull` + +- Install or update the build-time dependencies, omitting all extra ones: + +`sfdk build-requires reset` + +- Show the difference between current and clean build environments: + +`sfdk build-requires diff` diff --git a/pages/common/sfdk-build-shell.md b/pages/common/sfdk-build-shell.md new file mode 100644 index 0000000000..701efb2573 --- /dev/null +++ b/pages/common/sfdk-build-shell.md @@ -0,0 +1,17 @@ +# sfdk build-shell + +> Executes custom steps in build engine. +> See also: `sfdk config` for configuring the build target and `sfdk build-init` for initializing build tree. +> More information: . + +- Launch interactive shell in the build engine: + +`sfdk build-shell` + +- Run a specified command in the build shell: + +`sfdk build-shell {{command}}` + +- Launch interactive shell in the build engine in maintenance mode, when inspecting or modifying the build environment: + +`sfdk build-shell --maintain` diff --git a/pages/common/sfdk-check.md b/pages/common/sfdk-check.md new file mode 100644 index 0000000000..9f0a2b9a19 --- /dev/null +++ b/pages/common/sfdk-check.md @@ -0,0 +1,28 @@ +# sfdk check + +> Performs quality checks. +> More information: . + +- Display test suites: + +`sfdk check --list-suites` + +- Run all or essential test suites: + +`sfdk check` + +- Add testing level to the check: + +`sfdk check -l +{{level}}` + +- Remove testing level from the check: + +`sfdk check -l -{{level}}` + +- Add testing suite to the check: + +`sfdk check -s +{{suite}}` + +- Remove testing suite from the check: + +`sfdk check -s -{{suite}}` diff --git a/pages/common/sfdk-cmake.md b/pages/common/sfdk-cmake.md new file mode 100644 index 0000000000..6f530d6dad --- /dev/null +++ b/pages/common/sfdk-cmake.md @@ -0,0 +1,28 @@ +# sfdk cmake + +> Executes cmake build step. +> More information: . + +- Run cmake: + +`sfdk cmake` + +- Run cmake in specified project directory: + +`sfdk cmake {{project}}` + +- Run cmake with extra arguments: + +`sfdk cmake -- {{arguments}}` + +- Run cmake build in current directory: + +`sfdk cmake --build .` + +- Run cmake build in current directory with extra cmake arguments: + +`sfdk cmake --build . {{cmake-arguments}}` + +- Run cmake build in current directory with extra build tool arguments: + +`sfdk cmake --build . -- {{build-tool-arguments}}` diff --git a/pages/common/sfdk-compiledb.md b/pages/common/sfdk-compiledb.md new file mode 100644 index 0000000000..6afdd1188a --- /dev/null +++ b/pages/common/sfdk-compiledb.md @@ -0,0 +1,12 @@ +# sfdk compiledb + +> Generates compilation database. +> More information: . + +- Generate compilation database: + +`sfdk compiledb` + +- Generate compilation database with extra `make` arguments: + +`sfdk compiledb {{arguments}}` diff --git a/pages/common/sfdk-config.md b/pages/common/sfdk-config.md new file mode 100644 index 0000000000..e02ef264c4 --- /dev/null +++ b/pages/common/sfdk-config.md @@ -0,0 +1,28 @@ +# sfdk config + +> Configures sfdk. +> More information: . + +- Show configuration in all scopes: + +`sfdk config --show` + +- Set a configuration value: + +`sfdk config {{name}}={{value}}` + +- Mask an option as empty: + +`sfdk config {{name}}=` + +- Mask an option as empty without pushing it at the inner scope: + +`sfdk config {{name}}` + +- Clear option value: + +`sfdk --drop {{name}}` + +- Run subcommand in specified scope (`global`, `session` or `command`): + +`sfdk config --{{scope}} {{subcommand}}` diff --git a/pages/common/sfdk-deploy.md b/pages/common/sfdk-deploy.md new file mode 100644 index 0000000000..01d1786707 --- /dev/null +++ b/pages/common/sfdk-deploy.md @@ -0,0 +1,24 @@ +# sfdk deploy + +> Deploys build results to a device. +> More information: . + +- Deploy using a specified method (`pkcon`, `rsync`, `sdk`, `zypper`, `zypper-dup` or `manual`): + +`sfdk deploy --{{method}}` + +- Preview deploy without applying the changes: + +`sfdk deploy --{{method}} --dry-run` + +- Deploy files in glob pattern `package*`: + +`sfdk deploy --{{method}} "+package*"` + +- Deploy all files excluding `ignore*`: + +`sfdk deploy --{{method}} "-ignore*"` + +- Undeploy using a specified method (`pkcon`, `rpm`, `rsync`, `sdk` or `zypper`): + +`sfdk undeploy --{{method}}` diff --git a/pages/common/sfdk-device.md b/pages/common/sfdk-device.md new file mode 100644 index 0000000000..032f71705c --- /dev/null +++ b/pages/common/sfdk-device.md @@ -0,0 +1,16 @@ +# sfdk device + +> Maintains and controls registered devices. +> More information: . + +- Display the registered devices: + +`sfdk device list` + +- Execute a command on a device by name or index: + +`sfdk device exec {{device-name-or-idx}} {{command}}` + +- Run an interactive shell on a device by name or index: + +`sfdk device exec {{device-name-or-idx}}` diff --git a/pages/common/sfdk-emulator-device-model-list.md b/pages/common/sfdk-emulator-device-model-list.md new file mode 100644 index 0000000000..6a7b90b4c9 --- /dev/null +++ b/pages/common/sfdk-emulator-device-model-list.md @@ -0,0 +1,7 @@ +# sfdk emulator device-model-list + +> This command has been moved to `sfdk emulator device-model-show`. + +- View documentation for `sfdk emulator device-model-show`: + +`tldr sfdk emulator device-model-show` diff --git a/pages/common/sfdk-emulator-device-model-show.md b/pages/common/sfdk-emulator-device-model-show.md new file mode 100644 index 0000000000..5ab7a5f8be --- /dev/null +++ b/pages/common/sfdk-emulator-device-model-show.md @@ -0,0 +1,11 @@ +# sfdk emulator device-model-show + +> Show emulated device model's properties. + +- Show a model properties: + +`sfdk emulator device-model-show {{model}}` + +- Display available device models: + +`sfdk emulator device-model-list` diff --git a/pages/common/sfdk-emulator-exec.md b/pages/common/sfdk-emulator-exec.md new file mode 100644 index 0000000000..918a847322 --- /dev/null +++ b/pages/common/sfdk-emulator-exec.md @@ -0,0 +1,12 @@ +# sfdk emulator exec + +> Execute a command on an emulator. +> More information: . + +- Execute a command on an emulator: + +`sfdk emulator exec {{emulator}} {{command}}` + +- Run an interactive shell on an emulator: + +`sfdk emulator exec {{emulator}}` diff --git a/pages/common/sfdk-emulator-install.md b/pages/common/sfdk-emulator-install.md new file mode 100644 index 0000000000..42c2405665 --- /dev/null +++ b/pages/common/sfdk-emulator-install.md @@ -0,0 +1,20 @@ +# sfdk emulator install + +> Installs emulators. +> More information: . + +- Install an emulator: + +`sfdk emulator install {{name}}` + +- Remove an emulator: + +`sfdk emulator remove {{name}}` + +- Display the available emulators: + +`sfdk emulator list -a` + +- Display the installed emulators: + +`sfdk emulator list` diff --git a/pages/common/sfdk-emulator-list.md b/pages/common/sfdk-emulator-list.md new file mode 100644 index 0000000000..d0e3751077 --- /dev/null +++ b/pages/common/sfdk-emulator-list.md @@ -0,0 +1,7 @@ +# sfdk emulator list + +> This command has been moved to `sfdk emulator install`. + +- View documentation for `sfdk emulator install`: + +`tldr sfdk emulator install` diff --git a/pages/common/sfdk-emulator-remove.md b/pages/common/sfdk-emulator-remove.md new file mode 100644 index 0000000000..996e2245ff --- /dev/null +++ b/pages/common/sfdk-emulator-remove.md @@ -0,0 +1,7 @@ +# sfdk emulator remove + +> This command has been moved to `sfdk emulator install`. + +- View documentation for `sfdk emulator install`: + +`tldr sfdk emulator install` diff --git a/pages/common/sfdk-emulator-set.md b/pages/common/sfdk-emulator-set.md new file mode 100644 index 0000000000..c289bc99ff --- /dev/null +++ b/pages/common/sfdk-emulator-set.md @@ -0,0 +1,12 @@ +# sfdk emulator set + +> Sets emulator properties. +> More information: . + +- Set a property: + +`sfdk emulator set {{name}} {{property}}={{value}}` + +- Show emulator properties: + +`sfdk emulator show {{name}}` diff --git a/pages/common/sfdk-emulator-show.md b/pages/common/sfdk-emulator-show.md new file mode 100644 index 0000000000..deafdebf66 --- /dev/null +++ b/pages/common/sfdk-emulator-show.md @@ -0,0 +1,7 @@ +# sfdk emulator show + +> This command has been moved to `sfdk emulator set`. + +- View documentation for `sfdk emulator set`: + +`tldr sfdk emulator set` diff --git a/pages/common/sfdk-emulator-start.md b/pages/common/sfdk-emulator-start.md new file mode 100644 index 0000000000..de30a8e2a3 --- /dev/null +++ b/pages/common/sfdk-emulator-start.md @@ -0,0 +1,19 @@ +# sfdk emulator start + +> Starts an emulator. + +- Start an emulator: + +`sfdk emulator start {{name}}` + +- Stop an emulator: + +`sfdk emulator stop {{name}}` + +- Display emulator status: + +`sfdk emulator status {{name}}` + +- Display the installed emulators: + +`sfdk emulator list` diff --git a/pages/common/sfdk-emulator-status.md b/pages/common/sfdk-emulator-status.md new file mode 100644 index 0000000000..3e15ee2bac --- /dev/null +++ b/pages/common/sfdk-emulator-status.md @@ -0,0 +1,7 @@ +# sfdk emulator status + +> This command has been moved to `sfdk emulator start`. + +- View documentation for `sfdk emulator start`: + +`tldr sfdk emulator start` diff --git a/pages/common/sfdk-emulator-stop.md b/pages/common/sfdk-emulator-stop.md new file mode 100644 index 0000000000..2594ae7151 --- /dev/null +++ b/pages/common/sfdk-emulator-stop.md @@ -0,0 +1,7 @@ +# sfdk emulator stop + +> This command has been moved to `sfdk emulator start`. + +- View documentation for `sfdk emulator start`: + +`tldr sfdk emulator start` diff --git a/pages/common/sfdk-emulator.md b/pages/common/sfdk-emulator.md new file mode 100644 index 0000000000..353576d6b5 --- /dev/null +++ b/pages/common/sfdk-emulator.md @@ -0,0 +1,24 @@ +# sfdk emulator + +> Maintains and controls emulators. +> More information: . + +- Display the installed emulators: + +`sfdk emulator list` + +- Start an emulator: + +`sfdk emulator start {{name}}` + +- Stop an emulator: + +`sfdk emulator stop {{name}}` + +- Display emulator status: + +`sfdk emulator status {{name}}` + +- Run an interactive shell on an emulator: + +`sfdk emulator exec {{emulator}}` diff --git a/pages/common/sfdk-engine.md b/pages/common/sfdk-engine.md new file mode 100644 index 0000000000..184cab3401 --- /dev/null +++ b/pages/common/sfdk-engine.md @@ -0,0 +1,32 @@ +# sfdk engine + +> Maintains and controls the build engine. +> More information: . + +- Start the build engine: + +`sfdk engine start` + +- Stop the build engine: + +`sfdk engine stop` + +- Show the build engine status: + +`sfdk engine status` + +- Set an engine property: + +`sfdk engine set {{property}}={{value}}` + +- Show the engine properties: + +`sfdk engine show` + +- Execute a command on the build engine: + +`sfdk engine exec {{command}}` + +- Start an interactive shell on the build engine: + +`sfdk engine exec` diff --git a/pages/common/sfdk-init.md b/pages/common/sfdk-init.md new file mode 100644 index 0000000000..43ea8596fd --- /dev/null +++ b/pages/common/sfdk-init.md @@ -0,0 +1,20 @@ +# sfdk init + +> Initializes a new project. +> More information: . + +- Initialize a new project of the given type: + +`sfdk init -t {{type}}` + +- Initialize a new project with a specified builder: + +`sfdk init -t {{type}} -b {{builder}}` + +- Initialize a new project ignoring non-empty directory: + +`sfdk init -t {{type}} --force` + +- List available project types: + +`sfdk init -l` diff --git a/pages/common/sfdk-maintain.md b/pages/common/sfdk-maintain.md new file mode 100644 index 0000000000..6db707cd23 --- /dev/null +++ b/pages/common/sfdk-maintain.md @@ -0,0 +1,7 @@ +# sfdk maintain + +> Launches the interactive SDK Maintenance tool. + +- Launch SDK Maintenance tool: + +`sfdk maintain` diff --git a/pages/common/sfdk-make-install.md b/pages/common/sfdk-make-install.md new file mode 100644 index 0000000000..ac133b2c4b --- /dev/null +++ b/pages/common/sfdk-make-install.md @@ -0,0 +1,8 @@ +# sfdk make-install + +> Executes make-install build step. +> More information: . + +- Run make-install section of RPM SPEC file: + +`sfdk make-install` diff --git a/pages/common/sfdk-make.md b/pages/common/sfdk-make.md new file mode 100644 index 0000000000..3f61700f4c --- /dev/null +++ b/pages/common/sfdk-make.md @@ -0,0 +1,12 @@ +# sfdk make + +> Executes make build step. +> More information: . + +- Run make build: + +`sfdk make` + +- Run make with extra arguments: + +`sfdk make {{arguments}}` diff --git a/pages/common/sfdk-package.md b/pages/common/sfdk-package.md new file mode 100644 index 0000000000..05257574ab --- /dev/null +++ b/pages/common/sfdk-package.md @@ -0,0 +1,16 @@ +# sfdk package + +> Executes package creation build step. +> More information: . + +- Create a package: + +`sfdk package` + +- Create a package without executing the check section in RPM SPEC file: + +`sfdk package --no-check` + +- Create and sign a package: + +`sfdk package --sign` diff --git a/pages/common/sfdk-prepare.md b/pages/common/sfdk-prepare.md new file mode 100644 index 0000000000..76d4170807 --- /dev/null +++ b/pages/common/sfdk-prepare.md @@ -0,0 +1,8 @@ +# sfdk prepare + +> Executes preparation build step. +> More information: . + +- Prepare sources using the recipe from RPM SPEC file: + +`sfdk prepare` diff --git a/pages/common/sfdk-qmake.md b/pages/common/sfdk-qmake.md new file mode 100644 index 0000000000..71dfbb57d7 --- /dev/null +++ b/pages/common/sfdk-qmake.md @@ -0,0 +1,20 @@ +# sfdk qmake + +> Executes qmake build step. +> More information: . + +- Run qmake build: + +`sfdk qmake` + +- Run shadow qmake build in a specified project: + +`sfdk qmake {{project}}` + +- Run build with extra qmake arguments: + +`sfdk qmake -- {{arguments}}` + +- Run shadow qmake build with extra qmake arguments: + +`sfdk qmake {{project}} {{arguments}}` diff --git a/pages/common/sfdk-qmltypes.md b/pages/common/sfdk-qmltypes.md new file mode 100644 index 0000000000..e9f932bb55 --- /dev/null +++ b/pages/common/sfdk-qmltypes.md @@ -0,0 +1,23 @@ +# sfdk qmltypes + +> Generates qmltypes files. + +- Generate qmltypes files: + +`sfdk qmltypes` + +- Generate qmltypes files without deploying them (usually to emulator): + +`sfdk qmltypes --no-deploy` + +- Generate qmltypes files without restoring the emulator after deployment: + +`sfdk qmltypes --no-restore-emulator` + +- Generate qmltypes files and restore the emulator after deployment even on failure: + +`sfdk qmltypes --restore-emulator` + +- Generate qmltypes files without reverting changes which only include removal of statements with `sdk-make-qmltypes:keep` in comments: + +`sfdk qmltypes --no-keep` diff --git a/pages/common/sfdk-scrape.md b/pages/common/sfdk-scrape.md new file mode 100644 index 0000000000..6ffb55fca2 --- /dev/null +++ b/pages/common/sfdk-scrape.md @@ -0,0 +1,23 @@ +# sfdk scrape + +> Converts source code modifications to patches. + +- Save source modifications as patches: + +`sfdk scrape` + +- Preview the list of commits to be scrapped: + +`sfdk scrape --dry-run` + +- Scrape while preserving the original patches file names: + +`sfdk scrape --stable` + +- Scrape while saving patches to a specified [o]utput directory: + +`sfdk scrape -o {{directory}}` + +- Scrape without removing commits from submodules after creating patches: + +`sfdk scrape --keep` diff --git a/pages/common/sfdk-undeploy.md b/pages/common/sfdk-undeploy.md new file mode 100644 index 0000000000..978dd0bb95 --- /dev/null +++ b/pages/common/sfdk-undeploy.md @@ -0,0 +1,20 @@ +# sfdk undeploy + +> Undeploys build results from a device. +> More information: . + +- Undeploy using a specified method (`pkcon`, `rpm`, `rsync`, `sdk` or `zypper`): + +`sfdk undeploy --{{method}}` + +- Preview undeploy without applying the changes: + +`sfdk undeploy --{{method}} --dry-run` + +- Undeploy files in glob pattern `package*`: + +`sfdk undeploy --{{method}} "+package*"` + +- Undeploy all files excluding `ignore*`: + +`sfdk undeploy --{{method}} "-ignore*"` diff --git a/pages/common/sfdk.md b/pages/common/sfdk.md new file mode 100644 index 0000000000..71eda94f8e --- /dev/null +++ b/pages/common/sfdk.md @@ -0,0 +1,28 @@ +# sfdk + +> The command line frontend of the Sailfish SDK. +> More information: . + +- Execute a subcommand: + +`sfdk {{subcommand}}` + +- Execute a subcommand on a custom working directory: + +`git -C {{path/to/directory}} {{subcommand}}` + +- Execute a subcommand with a given configuration set: + +`git -c '{{name}}={{value}}' {{subcommand}}` + +- Display help: + +`sfdk --help` + +- Display help for specific topic (`building`, `testing`, `maintaining`, `ide`, `all`): + +`sfdk --help-{{topic}}` + +- Display version: + +`sfdk --version`