Makesdna: more verbose Align struct error #110291

Sybren A. Stüvel · 2023-07-20T12:06:57+02:00

Sybren A. Stüvel commented

2023-07-20 12:06:57 +02:00

I had some struggles with DNA alignment. The only way I could solve things for myself was to expand the error message from the alignment check in makesdna. This PR changes the error message from:

Align struct error: Bone color

to:

Align struct error: Bone::color (starts at 180 on the native platform;  180 % 8 = 4 bytes)

This has a few advantages:

The colon notation (Bone::color) makes it easier to recognise that this is about a specific struct field.
It makes it clear that this is about the start/offset of the inner struct.
It includes the math the check is actually doing, providing concrete information on how to change the code to fix the issue.

I had some struggles with DNA alignment. The only way I could solve things for myself was to expand the error message from the alignment check in `makesdna`. This PR changes the error message from: ``` Align struct error: Bone color ``` to: ``` Align struct error: Bone::color (starts at 180 on the native platform; 180 % 8 = 4 bytes) ``` This has a few advantages: - The colon notation (`Bone::color`) makes it easier to recognise that this is about a specific struct field. - It makes it clear that this is about the start/offset of the inner struct. - It includes the math the check is actually doing, providing concrete information on how to change the code to fix the issue.

Sybren A. Stüvel added 1 commit 2023-07-20 12:07:05 +02:00

Makesdna: more verbose Align struct error fe9f11c1d6

Change the error message from:

```
Align struct error: Bone color
```

to:

```
Align struct error: Bone::color (starts at 180 on the native platform;
 180 % 8 = 4 bytes)
```

The colon notation (`Bone::color`) makes it easier to recognise that this
is about a specific struct field. The rest of the explanation makes it
clear that this is about the start of the struct. It includes the math
the check is actually doing, providing concrete information on how to
change the code to fix the issue.

Sybren A. Stüvel added the

Module

Core

label 2023-07-20 12:07:24 +02:00

Sybren A. Stüvel requested review from Campbell Barton 2023-07-20 12:07:31 +02:00

Campbell Barton approved these changes 2023-07-21 11:31:35 +02:00

Sybren A. Stüvel merged commit 4833dd931b into main

2023-07-21 12:24:42 +02:00

Sybren A. Stüvel deleted branch pr/makesdna-align-error

2023-07-21 12:24:43 +02:00

Sybren A. Stüvel referenced this issue from a commit

2023-07-21 12:24:43 +02:00