Skip to content

Commit

Permalink
doc: including command for ./tools/update_package_abis.sh
Browse files Browse the repository at this point in the history
  • Loading branch information
mattkae committed Jul 3, 2024
1 parent c25188c commit 05746c1
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion doc/sphinx/how-to/how-to-update-symbols-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,12 @@ And that's it! Now we are ready to update our symbols automatically.
cmake --build build --target regenerate-miral-debian-symbols
```

If `MIRAL_ABI` needed to be updated, you should also run:

```sh
./tools/update_package_abis.sh
```

## How to update miroil symbols

### Scenario 1: Adding a new symbol
Expand Down Expand Up @@ -158,6 +164,12 @@ And that's it! Now we are ready to update our symbols automatically.
cmake --build build --target regenerate-miroil-debian-symbols
```

If `MIROIL_ABI` needed to be updated, you should also run:

```sh
./tools/update_package_abis.sh
```

## How to update mirserver symbols map
### Scenario 1: Adding a new symbol
1. Make the additive change to the interface (e.g. by adding a new method
Expand All @@ -175,6 +187,12 @@ And that's it! Now we are ready to update our symbols automatically.
git diff src/server/symbols.map
```

If `MIRSERVER_ABI` needed to be updated, you should also run:

```sh
./tools/update_package_abis.sh
```

### Scenario 2: Removing or changing a symbol
1. Make a destructive change to the interface (e.g. remove a parameter from
a method).
Expand All @@ -190,4 +208,10 @@ And that's it! Now we are ready to update our symbols automatically.
5. Check that your symbols are reflected properly in the `symbols.map` file:
```sh
git diff src/server/symbols.map
```
```

If `MIRSERVER_ABI` needed to be updated, you should also run:

```sh
./tools/update_package_abis.sh
```

0 comments on commit 05746c1

Please sign in to comment.