|
2 | 2 | title: "MPR Analyze Command" |
3 | 3 | url: /refguide/mx-command-line-tool/analyze-mpr/ |
4 | 4 | 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." |
6 | 6 | --- |
7 | 7 |
|
8 | 8 | ## Introduction |
9 | 9 |
|
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. |
11 | 11 |
|
12 | 12 | {{% 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. |
14 | 14 | {{% /alert %}} |
15 | 15 |
|
16 | 16 | ## Usage |
17 | 17 |
|
18 | 18 | Use the following command pattern: `mx analyze-mpr TARGET-FILE [OPTIONS]` |
19 | 19 |
|
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. |
21 | 21 |
|
22 | 22 | The `OPTIONS` are described in the table below: |
23 | 23 |
|
24 | 24 | | Option | Result | |
25 | 25 | | --- | --- | |
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 | |
29 | 29 |
|
30 | 30 | ### Analysis |
31 | 31 |
|
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. |
33 | 33 |
|
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. |
35 | 35 |
|
36 | 36 | ### Examples |
37 | 37 |
|
38 | | -Valid examples are given below: |
| 38 | +The following examples show valid usage: |
39 | 39 |
|
40 | 40 | * `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 |
42 | 42 |
|
43 | | -An example of the output is presented below: |
| 43 | +The following example shows the command output: |
44 | 44 | <details> |
45 | 45 |
|
46 | 46 | <summary>Expand for code sample</summary> |
|
0 commit comments