Skip to content

Commit b2d3ba4

Browse files
authored
Merge pull request #351 from macta/patch-1
Update ExportFormats.md for improved update instructions
2 parents 0f9f5ea + b8e27b9 commit b2d3ba4

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

General/ExportFormats.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -93,16 +93,24 @@ Tonel got multiple versions over the years, each tweaking the export format:
9393
- version 2.0: this version ensure that in the metadatas the keys are symbols and the values are strings. This change happened in order to be compatible with Gemstone. Note that this format was never used as a default export format of Pharo
9494
- version 3.0: this version has the changes of the 2.0 but it also adds the properties `package` and `tag` to replace the `category` property for class definitions. This is to remove same ambiguity in the class definitions. The `category` property is kept by default for backward compatibility, but the TonelWriter can be configured to not export this property. This format can also be improved to export more metadata. For example, it is planned to export a property `deprecatedAliases` to manage some class deprecations in the future.
9595

96-
If you want to change you export format and convert all the files of a repository at once to avoid to have multiple PR with format changes you can use this script and commit the resulting files:
96+
If you want to change your export format and convert all the files of a repository at once to avoid to have multiple PR with format changes you can use the following script.
97+
98+
**NOTE: you must ensure all your project packages are loaded in the image (check in the Repository | Packages window, and right click load any that aren't).**
9799

98100
```st
99-
| projectName |
101+
| projectName repository |
100102
projectName := 'ProjectNameInIceberg'.
101103
repository := IceRepository repositories detect: [ :repo | repo name = projectName ].
102104
repository workingCopy packages do: [ :pkg |
103105
IceLibgitTonelWriter forInternalStoreFileOut: pkg latestVersion mcVersion on: repository ]
104106
```
105107

108+
Once you have run this script, use the "Repository, Project | Extra | Open in native file browser" menu option to open an OS terminal and then run:
109+
```
110+
git commit -a -m "Update tonel formal to V3"
111+
git push
112+
```
113+
106114
Since Pharo 12, it is also possible to indicate in a Tonel project which version of Tonel to use to export some code. The file to update is the `.properties` file that is in the source folder and it should look like this:
107115

108116
```

0 commit comments

Comments
 (0)