Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation of editing omni.ja #166

Open
2xB opened this issue Aug 8, 2023 · 0 comments
Open

Better documentation of editing omni.ja #166

2xB opened this issue Aug 8, 2023 · 0 comments

Comments

@2xB
Copy link

2xB commented Aug 8, 2023

Proposal:
Editing the omni.ja file - e.g. just by opening it in 7zip - is a really simple way of trying changes to the Thunderbird JavaScript source without setting up any development environment. That however requires a consecutive launch of Thunderbird using the --purgecaches flag or using the MOZ_PURGE_CACHES environment variable, otherwise cached JS code instead of the custom one is used. This is such a simple way to start with Thunderbird development that I don't really understand why it isn't really documented anywhere official. Therefore I'm proposing that this is documented a bit more prominently.

The same probably goes for Firefox.

The current situation:
There exists https://wiki.mozilla.org/Thunderbird:Start_Hacking which I think should be integrated into and forward to a subpage of https://developer.thunderbird.net/thunderbird-development/getting-started . At one point something similar already existed in MDN, since the wiki page was to a significant extent duplicated by https://web.archive.org/web/20210620190432/https://developer.mozilla.org/en-US/docs/Mozilla/About_omni.ja_(formerly_omni.jar) which has been removed since then.
None of these sources documents the --purgecaches flag or the MOZ_PURGE_CACHES environment variable. The wiki page even mentions removing jsloader and jssubloader directories which I think is an outdated, discontinued alternative to clear the cache.

Context:
This is a follow-up to https://phabricator.services.mozilla.com/D185644#6141303 where this knowledge was quite useful.

@2xB 2xB changed the title Document editing omni.ja better Better documentation of editing omni.ja Aug 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant