Skip to content

Commit 4bc5892

Browse files
committed
Review dump and export
1 parent b3ec1b9 commit 4bc5892

2 files changed

Lines changed: 19 additions & 25 deletions

File tree

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "MPR Dump"
3-
url: /refguide/mx-command-line-tool/dump-mpr
3+
url: /refguide/mx-command-line-tool/dump-mpr/
44
weight: 60
5-
description: "Describes the command used to create a JSON description of the model of a Mendix App."
5+
description: "Describes the command used to create a JSON description of the model of a Mendix app."
66
---
77

88
## Introduction
@@ -19,7 +19,7 @@ These are the `OPTIONS`:
1919

2020
| Option | Value | Result |
2121
| --- | --- | --- |
22-
| `--unit-type` | A single unit type, or a comma-separated list of unit types. To find a specific unit type, refer to the [Model SDK API documentation](https://apidocs.rnd.mendix.com/modelsdk/latest/index.html). Each unit includes a `structureTypeName` property that identifies its type. For example, the unit type for a [Page document](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.Page.html#structureTypeName-1) is `Pages$Page`, as indicated in the documentation. Additionally, the unit type is included in the output JSON in the `$Type` field. You can use the command without this argument to list the unit types in your project. | Filters the results on the supplied unit types and limits the JSON export. |
22+
| `--unit-type` | A single unit type, or a comma-separated list of unit types. To find a specific unit type, refer to the [Model SDK API documentation](https://apidocs.rnd.mendix.com/modelsdk/latest/index.html). Each unit includes a `structureTypeName` property that identifies its type. For example, the unit type for a [Page document](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.Page.html#structureTypeName-1) is `Pages$Page`, as indicated in the documentation. Additionally, the unit type is included in the output JSON in the `$Type` field. You can use the command without this argument to list the unit types in your project. | Filters the results on the supplied unit types and limits the JSON export. |
2323
| `--exclude-system-module` | | Exclude the system module from the JSON export. |
2424
| `--exclude-protected-modules` | | Exclude protected modules from the JSON export. |
2525
| `--module-names` | A single module name, or a comma-separated list of module names. | Filters the results on the supplied modules and limits the JSON export. |

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

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: "Export Package Commands"
3-
url: /refguide/mx-command-line-tool/export
3+
url: /refguide/mx-command-line-tool/export/
44
weight: 40
5-
description: "Describes the commands related to package export for the mx command-line tool."
5+
description: "Describes commands that export different package types from your app using the mx command-line tool."
66
---
77

88
## Introduction
99

10-
The commands in this group enable exporting different kinds of packages from your app.
10+
The commands in this group export different package types from your app.
1111

1212
## mx create-project-package Command {#create-project-package}
1313

@@ -21,24 +21,22 @@ Use the following command pattern:
2121

2222
These are the `OPTIONS`:
2323

24-
| Option | Result |
24+
| Option | Description |
2525
| --- | --- |
2626
| `-s, --include-snapshot` | Includes a snapshot in the app package. |
2727
| `-d, --package-dir` | Exports the package to the directory. |
28-
| `-k, --skip-managed-dependency-sync` | Do not synchronize managed dependencies; use existing files in `vendorlib` instead. |
28+
| `-k, --skip-managed-dependency-sync` | Does not synchronize managed dependencies; uses existing files in `vendorlib` instead. |
2929
| `--help` | Displays the help screen. |
3030

3131
For `TARGET-FILE`, specify the *.mpr* app you want to export.
3232

33-
### Examples
34-
35-
Here is an example:
33+
### Example
3634

3735
`mx create-project-package c:\MyApps\MyApp.mpr`
3836

3937
### Return Codes
4038

41-
This table shows the return codes and their description:
39+
This table shows the return codes and their descriptions:
4240

4341
| Return Code | Description |
4442
| --- | --- |
@@ -61,25 +59,23 @@ These are the `OPTIONS`:
6159

6260
| Option | Description |
6361
| --- | --- |
64-
| `-l, --filter-required-libs` | Includes all the files except the userlibs that do not have an accompanying `[ModuleName].RequiredLib` file. |
65-
| `-e, --exclude-files` | Excludes all the files that match the given regular expression. |
62+
| `-l, --filter-required-libs` | Includes all files except the userlibs that do not have an accompanying `[ModuleName].RequiredLib` file. |
63+
| `-e, --exclude-files` | Excludes all files that match the given regular expression. |
6664
| `-d, --package-dir` | Exports the module package to the directory. |
67-
| `-m, --exclude-managed-dependencies` | Excludes managed dependencies from synchronization and the exported module package. Note that this will prevent the module from being used if Gradle synchronization is disabled in Studio Pro. |
65+
| `-m, --exclude-managed-dependencies` | Excludes managed dependencies from synchronization and the exported module package. This prevents the module from being used if Gradle synchronization is disabled in Studio Pro. |
6866
| `--help` | Displays the help screen. |
6967

7068
For `TARGET-FILE`, specify the *.mpr* app you want to export.
7169

7270
For `MODULE-NAME`, specify the name of the module you want to export.
7371

74-
### Examples
75-
76-
Here is an example:
72+
### Example
7773

7874
`mx create-module-package c:\MyApps\MyApp.mpr Module1`
7975

8076
### Return Codes
8177

82-
This table shows the return codes and their description:
78+
This table shows the return codes and their descriptions:
8379

8480
| Return Code | Description |
8581
| --- | --- |
@@ -101,24 +97,22 @@ Use the following command pattern:
10197

10298
These are the `OPTIONS`:
10399

104-
| Option | Result |
100+
| Option | Description |
105101
| --- | --- |
106102
| `-s, --include-snapshot` | Includes a snapshot in the app package. |
107103
| `-d, --package-dir` | Exports the package to the directory. |
108-
| `-k, --skip-managed-dependency-sync` | Do not synchronize managed dependencies; use existing files in `vendorlib` instead. |
104+
| `-k, --skip-managed-dependency-sync` | Does not synchronize managed dependencies; uses existing files in `vendorlib` instead. |
109105
| `--help` | Displays the help screen. |
110106

111107
For `TARGET-FILE`, specify the *.mpr* app you want to export.
112108

113-
### Examples
114-
115-
Here is an example:
109+
### Example
116110

117111
`mx create-solution-package c:\MyApps\MyApp.mpr`
118112

119113
### Return Codes
120114

121-
This table shows the return codes and their description:
115+
This table shows the return codes and their descriptions:
122116

123117
| Return Code | Description |
124118
| --- | --- |

0 commit comments

Comments
 (0)