Skip to content

Commit

Permalink
Add note about lint checking tables (and fix an issue found while doi…
Browse files Browse the repository at this point in the history
…ng that)
  • Loading branch information
dharple committed Apr 2, 2024
1 parent b1bdc74 commit 46911bd
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
22 changes: 20 additions & 2 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ Testing:
- strace
- valgrind

Nice to Have:

`draw-title` (from my [bin] repo).

## Rebuild Internals

```bash
Expand All @@ -58,6 +62,16 @@ Check formatting on man pages:
mandoc -T lint man/*.[15]
```

Check formatting on translation tables:

```bash
# if you have draw-title in your path
find table/ -type f -exec draw-title '{}' ';' -exec src/check-table '{}' ';'

# otherwise
find table/ -type f -exec echo ';' -exec src/check-table '{}' ';'
```

Confirm tests reference correct GitHub issue:

```bash
Expand Down Expand Up @@ -157,14 +171,17 @@ puts `-ftest-coverage` on the `DEFS` variable.
2. Run the lint checks from earlier in this document, `astyle` and `mandoc`.
Note that `astyle` sometimes confuses a multiplication operator with a
pointer, and `mandoc` complains about missing references.
3. Run `make internals`. Confirm no changes are recorded.
3. Run the translation table lint checker, using `find` and `check-table`, and
look for any warnings. The `draw-title` script is from my [bin] repo, and
completely optional. I just find it easier to read.
4. Run `make internals`. Confirm no changes are recorded.

```bash
./configure && make clean && make && make internals
git status -s
```

4. Run `make distcheck`.
5. Run `make distcheck`.

```bash
./configure && make clean && make && make distcheck
Expand Down Expand Up @@ -206,3 +223,4 @@ make dist-zip
9. Play [A Void Hope].

[A Void Hope]: https://eldenpixels.com/a-void-hope/
[bin]: https://github/dharple/bin
2 changes: 1 addition & 1 deletion table/legacy/unicode.tbl
Original file line number Diff line number Diff line change
Expand Up @@ -760,7 +760,7 @@ start

0x20B1 $ # PESO SIGN
0x20B2 Gs # GUARANI SIGN
0x20B2 C # CEDI SIGN
0x20B5 C # CEDI SIGN
0x20BB M # NORDIC MARK SIGN
0x20BF _btc_ # BITCOIN SIGN

Expand Down

0 comments on commit 46911bd

Please sign in to comment.