Skip to content

Commit 6a42ee4

Browse files
authored
Merge pull request #11068 from mendix/qt-mxbuild
Review MxBuild docs
2 parents f3ea47a + 6e9d67b commit 6a42ee4

10 files changed

Lines changed: 150 additions & 155 deletions

File tree

content/en/docs/refguide/general/mx-command-line-tool/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ These are the available [app commands](/refguide/mx-command-line-tool/app/):
2828
| [check](/refguide/mx-command-line-tool/app/#check) | Checks the app for issues. |
2929
| [convert](/refguide/mx-command-line-tool/app/#convert) | Converts the Mendix app. |
3030
| [create-project](/refguide/mx-command-line-tool/app/#create-project) | Creates a new Mendix app. |
31-
| [show-version](/refguide/mx-command-line-tool/app/#show-version) | Shows the Studio Pro version that was last used to edit the app. |
31+
| [show-version](/refguide/mx-command-line-tool/app/#show-version) | Shows the Studio Pro version used to last edit the app. |
3232
| [show-java-version](/refguide/mx-command-line-tool/app/#show-java-version) | Shows the configured Java version of the app. |
3333
| [sync-java-dependencies](/refguide/mx-command-line-tool/app/#java-dependencies) | Synchronizes the managed Java dependencies that are configured in the modules of the app. |
3434
| [translate](/refguide/mx-command-line-tool/app/#translate) | Exports and imports all translatable texts included in your application. |
@@ -51,7 +51,7 @@ These are the available [module commands](/refguide/mx-command-line-tool/module/
5151
|---|---|
5252
| [show-module-version](/refguide/mx-command-line-tool/module/#show-module-version) | Shows the version of a module. |
5353
| [set-module-version](/refguide/mx-command-line-tool/module/#set-module-version) | Sets the version of a module. |
54-
| [module-import](/refguide/mx-command-line-tool/module/#module-import) | Import a module from an mpk package into an app. |
54+
| [module-import](/refguide/mx-command-line-tool/module/#module-import) | Imports a module from an mpk package into an app. |
5555

5656
### Export Package Commands
5757

@@ -71,7 +71,7 @@ These are the available [merging and diffing commands](/refguide/mx-command-line
7171
| --- | --- |
7272
| [merge](/refguide/mx-command-line-tool/merge/#merge) | Merges the *.mpr* files. |
7373
| [diff](/refguide/mx-command-line-tool/merge/#diff) | Shows the diff of the *.mpr* files. |
74-
| [dump-mpr](/refguide/mx-command-line-tool/dump-mpr/) | Create a JSON description of the model of a Mendix app. |
74+
| [dump-mpr](/refguide/mx-command-line-tool/dump-mpr/) | Creates a JSON description of the model of a Mendix app. |
7575

7676
### Private Values Commands
7777

@@ -84,7 +84,7 @@ These are the available [private values commands](/refguide/mx-command-line-tool
8484

8585
### Security Overview Command
8686

87-
The available `export-security-overview` exports the [Security Overview](/refguide/security-overview/). For more information, see [Security Overview Command](/refguide/mx-command-line-tool/security/#export-security-overview).
87+
The `export-security-overview` command exports the [Security Overview](/refguide/security-overview/). For more information, see [Security Overview Command](/refguide/mx-command-line-tool/security/#export-security-overview).
8888

8989
## Undocumented Options
9090

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
---
22
title: "Adaptable Solution Commands"
3-
url: /refguide/mx-command-line-tool/adaptable
3+
url: /refguide/mx-command-line-tool/adaptable/
44
weight: 20
5-
description: "Describes the adaptable solution-related commands for the mx command-line tool."
5+
description: "Describes commands for managing adaptable solution versions in the mx command-line tool."
66
---
77

88
## Introduction
99

1010
The commands in this group are related to [adaptable solutions](/appstore/creating-content/sol-adapt/).
1111

12-
These commands use common format exit codes.
12+
These commands use a common exit code format.
1313

14-
The commands return `0` in case of success.
14+
The commands return `0` on success.
1515

16-
In case of errors, the exit code consists of three digits `XYZ`:
16+
On error, the exit code consists of three digits `XYZ`:
1717

18-
* `X` determines the error type:
18+
* `X` – Error type:
1919
* `1` – parameter validation error
2020
* `2` – output-related error
21-
* `3`errors related to the execution of the operation
22-
* `Y` is the number of the parameter the error is related to (if applicable). If the error is not related to the parameters, this is zero.
23-
* `Z` determines error details:
24-
* `1` – file is not found
21+
* `3`operation execution error
22+
* `Y` – Parameter number the error relates to (if applicable). This is zero if the error is not parameter-related.
23+
* `Z` – Error detail:
24+
* `1` – file not found
2525
* `2` – app is too old
2626
* `3` – distribution is not enabled
27-
* `4` – version is not in the SemVer format
27+
* `4` – version is not in SemVer format
2828
* `5` – app was not initialized from a solution package
2929

3030
For exit code examples, refer to the specific commands below.
3131

3232
## mx show-app-version Command {#show-app-version}
3333

34-
The `mx show-app-version` command enables seeing the [publisher-side](/appstore/creating-content/sol-solutions-guide/) version of your solution (the version of the solution that you develop) and the [consumer-side](/appstore/creating-content/sol-solutions-impl/) version of the solution package that your app is based on (the version of the solution package when you consumed the solution).
34+
The `mx show-app-version` command shows the [publisher-side](/appstore/creating-content/sol-solutions-guide/) version of your solution (the version you develop) and the [consumer-side](/appstore/creating-content/sol-solutions-impl/) version of the solution package your app is based on (the version when you consumed the solution).
3535

3636
### Usage
3737

@@ -41,14 +41,14 @@ Use the following command pattern for `mx show-app-version`:
4141

4242
These are the `OPTIONS`:
4343

44-
| Option | Shortcut | Result |
44+
| Option | Shortcut | Description |
4545
| --- | --- | --- |
4646
| `--based-on` | `-b` | Shows the `Based on` version. |
4747
| `--help` | | Shows help for the `mx show-app-version` command and exits. |
4848

4949
For `MPR-FILE`, enter an *.mpr* file.
5050

51-
The `--based-on` version is a version of a solution package (*.mxsolution*) that the current app is based on.
51+
The `--based-on` version is the version of the solution package (*.mxsolution*) that the current app is based on.
5252

5353
### Examples
5454

@@ -59,19 +59,19 @@ Here are two examples:
5959

6060
### Return Codes
6161

62-
This command uses the common format exit codes described above for all app-version related commands.
62+
This command uses the common exit code format described above for all app-version related commands.
6363

64-
This table shows the return codes and their description:
64+
This table shows the return codes and their descriptions:
6565

6666
| Return Code | Description |
6767
| --- | --- |
6868
| `0` | No errors. |
69-
| `315` | If `-b` was specified, but the app is not based on a solution. |
70-
| `313` | If `-b` was not specified, but distribution as a solution is not enabled for the app. |
69+
| `315` | The `-b` flag was specified, but the app is not based on a solution. |
70+
| `313` | The `-b` flag was not specified, but distribution as a solution is not enabled for the app. |
7171

7272
## mx set-app-version Command {#set-app-version}
7373

74-
The `mx set-app-version` command enables setting the version of your [solution](/appstore/creating-content/sol-solutions-guide/) when building it.
74+
The `mx set-app-version` command sets the version of your [solution](/appstore/creating-content/sol-solutions-guide/) when building it.
7575

7676
### Usage
7777

@@ -81,7 +81,7 @@ Use the following command pattern for `mx set-app-version`:
8181

8282
These are the `OPTIONS`:
8383

84-
| Option | Result |
84+
| Option | Description |
8585
| --- | --- |
8686
| `--help` | Shows help for the `mx set-app-version` command and exits. |
8787

@@ -97,12 +97,12 @@ Here is an example:
9797

9898
### Return Codes
9999

100-
This command uses the common format exit codes described above for all app-version related commands.
100+
This command uses the common exit code format described above all app-version related commands.
101101

102-
This table shows the return codes and their description:
102+
This table shows the return codes and their descriptions:
103103

104104
| Return Code | Description |
105105
| --- | --- |
106106
| `0` | No errors. |
107-
| `124` | The version is not in the SemVer format. |
107+
| `124` | The version is not in SemVer format. |
108108
| `313` | Distribution as a solution is not enabled for the app. |

content/en/docs/refguide/general/mx-command-line-tool/analyze-mpr.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,45 @@
22
title: "MPR Analyze Command"
33
url: /refguide/mx-command-line-tool/analyze-mpr/
44
weight: 60
5-
description: "Describes MPR analyze command, which shows the contents of the MPR file and their contribution to file size."
5+
description: "Describes the MPR analyze command, which shows the contents of the MPR file and their contribution to file size."
66
---
77

88
## Introduction
99

10-
The `mx analyze-mpr` command enables you to show information about the MPR file in the form of plaintext.
10+
The `mx analyze-mpr` command shows information about the MPR file in plaintext format.
1111

1212
{{% alert color="warning" %}}
13-
We do not recommend building custom tooling on top of this outpur, as the output and the format may change over time.
13+
Mendix does not recommend building custom tooling on top of this output, as the output and format may change over time.
1414
{{% /alert %}}
1515

1616
## Usage
1717

1818
Use the following command pattern: `mx analyze-mpr TARGET-FILE [OPTIONS]`
1919

20-
The `TARGET-FILE` points to the location of the project file (this file has the extension *.mpr*).
20+
The `TARGET-FILE` points to the location of the project file with the *.mpr* extension.
2121

2222
The `OPTIONS` are described in the table below:
2323

2424
| Option | Result |
2525
| --- | --- |
26-
| `--big-string-threshold` | (Default: 1000) The number of bytes from which to consider a String value 'big' (for `Content categories` section) |
27-
| `--big-blob-threshold` | (Default: 1000) The number of bytes from which to consider a BLOB value 'big' (for `Content categories` section) |
28-
| `--help` | Displays the help screen. |
26+
| `--big-string-threshold` | The number of bytes from which to consider a String value `big` (for the `Content categories` section). Default: *1000* |
27+
| `--big-blob-threshold` | The number of bytes from which to consider a BLOB value `big` (for the `Content categories` section). Default: *1000* |
28+
| `--help` | Displays the help screen |
2929

3030
### Analysis
3131

32-
To identify which types of documents (pages, microflows, etc.) have the largest contribution to the MPR file size, you can focus on the **Size by unit type** section, where the number of occurrences and file size contribution are displayed in percentage.
32+
To identify which types of documents (pages, microflows, etc.) contribute most to the MPR file size, focus on the **Size by unit type** section. This section displays the number of occurrences and file size contribution as a percentage.
3333

34-
You can use the MPR Tool to get more details. You can find it at *C:\Program Files\Mendix\<version>\modeler\MprTool.exe* (where <version> should be replaced with your installed Mendix version). After opening the *.mpr* file for your app, use **Search** > **Find unit by ID** to find the name and module for a particular unit.
34+
To get more details, use the MPR Tool located at *C:\Program Files\Mendix\<version>\modeler\MprTool.exe* (replace <version> with your installed Mendix version). After opening the *.mpr* file for your app, use **Search** > **Find unit by ID** to find the name and module for a unit.
3535

3636
### Examples
3737

38-
Valid examples are given below:
38+
The following examples show valid usage:
3939

4040
* `mx analyze-mpr temp.mpr`
41-
* `mx analyze-mpr temp.mpr > analysis.txt`, to output to a text file
41+
* `mx analyze-mpr temp.mpr > analysis.txt` to output to a text file
4242

43-
An example of the output is presented below:
43+
The following example shows the command output:
4444
<details>
4545

4646
<summary>Expand for code sample</summary>

0 commit comments

Comments
 (0)