Skip to content

Update Liblouis to 3.30.0#16652

Merged
seanbudd merged 7 commits intonvaccess:masterfrom
codeofdusk:liblouis-3.30
Jun 17, 2024
Merged

Update Liblouis to 3.30.0#16652
seanbudd merged 7 commits intonvaccess:masterfrom
codeofdusk:liblouis-3.30

Conversation

@codeofdusk
Copy link
Copy Markdown
Contributor

@codeofdusk codeofdusk commented Jun 4, 2024

Link to issue number:

None

Summary of the issue:

Liblouis 3.30.0 has been released, adding many new Braille tables.

Description of how this pull request fixes the issue:

Update Liblouis and add new tables.

Testing strategy:

Alpha testing

Known issues with pull request:

None known

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

Summary by CodeRabbit

  • New Features

    • Added new braille tables for various languages including Akkadian, Cuneiform, Hebrew, Serbian Cyrillic, Syriac, Ugaritic, and Yiddish.
  • Documentation

    • Updated the development environment setup guide to reflect the new version of liblouis (3.30.0).
    • Updated user documentation to highlight Unicode Normalization support and new braille tables in the 2024.3 release.
  • Chores

    • Updated subproject commit hashes for liblouis and miscDeps to their latest versions.

@codeofdusk codeofdusk requested a review from a team as a code owner June 4, 2024 21:57
@codeofdusk codeofdusk requested a review from michaelDCurran June 4, 2024 21:57
@AppVeyorBot
Copy link
Copy Markdown

See test results for failed build of commit fa51eedf4c

@codeofdusk
Copy link
Copy Markdown
Contributor Author

It appears that the Dutch table (nl-NL-g0.utb) is now supplied as an m4 .in file. Will we need to include m4 as part of the build dependencies or should we generate the output table ourselves?

@LeonarddeR
Copy link
Copy Markdown
Collaborator

@egli Could you chime in here? It looks like the Dutch table will need some special handling by NVDA"s build system. I hope we can handle this.

Copy link
Copy Markdown
Collaborator

@LeonarddeR LeonarddeR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like scons has m4 support, but it will most likely require some extra tool not everyone has installed by default.


This release adds support for Unicode Normalization to speech and braille output.
This can be useful when reading characters that are unknown to a particular speech synthesizer or braille table and which have a compatible alternative, like the bold and italic characters commonly uses on social media.
This can be useful when reading characters that are unknown to a particular speech synthesizer or braille table and which have a compatible alternative, like the bold and italic characters commonly used on social media.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is strictly spoken unrelated. I think this is more suitable for a general documentation follow up pr. That said, I'm sorry for the typos.

@egli
Copy link
Copy Markdown

egli commented Jun 5, 2024

@egli Could you chime in here? It looks like the Dutch table will need some special handling by NVDA"s build system. I hope we can handle this.

How do you build liblouis? The dutch tables should be generated when you run make

@LeonarddeR
Copy link
Copy Markdown
Collaborator

LeonarddeR commented Jun 5, 2024

We use the SCons build system that simply compiles all the c code with the Clang bundled with vc++, similar to how the nmake file does it.
Perhaps my counter question should be, how should we compile the tables with macros on Windows😉? I don't think this was covered with nmake either?

@AppVeyorBot
Copy link
Copy Markdown

See test results for failed build of commit f98bc9dafb

@seanbudd seanbudd marked this pull request as draft June 6, 2024 01:06
@LeonarddeR
Copy link
Copy Markdown
Collaborator

codeofdusk#3 should get us going

@LeonarddeR
Copy link
Copy Markdown
Collaborator

@egli For your reference, we will add a Windows binary build of m4 to our repo with misc dependencies, and then will manually throw all *.in files from the tables dir into m4.
See also nvaccess/nvda-misc-deps#33

@egli
Copy link
Copy Markdown

egli commented Jun 6, 2024

One thing that we (liblouis) could consider is to try to ship pre-converted tables in the distribution tar ball. In other words: Convert the *.in files at make dist time and ship the normal tables as well. Hm, wait, I just checked the release and the "normal" Dutch tables are included as well as the *.in files. Aren't you using the distribution tar ball?

@LeonarddeR
Copy link
Copy Markdown
Collaborator

@egli No, We're including liblouis' git repository as a submodule in the NVDA repo. I think that's fine, it was, at least up until now, a pretty trivial action to update it.

@AppVeyorBot
Copy link
Copy Markdown

See test results for failed build of commit 3d97a71c9a

@LeonarddeR LeonarddeR added blocked component/liblouis Issues related to liblouis, such as liblouis updates and braille table additions/changes labels Jun 7, 2024
@LeonarddeR
Copy link
Copy Markdown
Collaborator

This is currently blocked by nvaccess/nvda-misc-deps#33

@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Jun 11, 2024
seanbudd pushed a commit to nvaccess/nvda-misc-deps that referenced this pull request Jun 11, 2024
Bundle m4 with miscdeps to compile liblouis tables containing macros. See also nvaccess/nvda#16652
@LeonarddeR
Copy link
Copy Markdown
Collaborator

@codeofdusk Now nvaccess/nvda-misc-deps#33 is closed, could you update miscDeps?

@codeofdusk codeofdusk marked this pull request as ready for review June 11, 2024 23:19
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jun 11, 2024

Walkthrough

The updates primarily involve upgrading subproject commit hashes and the liblouis version from 3.29.0 to 3.30.0. Additionally, new braille tables for various languages have been added to enhance language support. Documentation has been updated to reflect these changes, including the introduction of Unicode Normalization in speech and braille output, and various bug fixes and improvements.

Changes

File Path Change Summary
include/liblouis Updated subproject commit hash.
miscDeps Updated subproject commit hash from 52ecd2d9e8b51e1728a6930e83d1ede4cd7b02f2 to ce8ed214b56860b44f28a0c16d2e1827f3f97dd4.
projectDocs/dev/createDevEnvironment.md Updated liblouis version from 3.29.0 to 3.30.0 in runtime dependencies.
source/brailleTables.py Added new braille tables for Akkadian, Cuneiform, Hebrew, Serbian Cyrillic, Syriac, Ugaritic, and Yiddish.
user_docs/en/changes.md Documented 2024.3 release updates, including Unicode Normalization support, new braille tables, and bug fixes.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

@AppVeyorBot
Copy link
Copy Markdown

See test results for failed build of commit b44896973b

@seanbudd
Copy link
Copy Markdown
Member

Unit tests are still failing here

@seanbudd seanbudd marked this pull request as draft June 12, 2024 01:17
@AppVeyorBot
Copy link
Copy Markdown

See test results for failed build of commit 5f5d537344

@LeonarddeR
Copy link
Copy Markdown
Collaborator

LeonarddeR commented Jun 15, 2024

It looks like the changes to sconstruct wheren't merged in correctly.
I filed codeofdusk#4

@codeofdusk codeofdusk marked this pull request as ready for review June 16, 2024 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/liblouis Issues related to liblouis, such as liblouis updates and braille table additions/changes conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants