Skip to content

Commit 3e9358c

Browse files
committed
Clarify instructions on running ruleset tests.
1 parent cf10ffe commit 3e9358c

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ HTTPS Everywhere consists of a large number of rules for switching sites from HT
8282

8383
If you want to create new rules to submit to us, we expect them to be in the src/chrome/content/rules directory. That directory also contains a useful script, make-trivial-rule, to create a simple rule for a specified domain. There is also a script called trivial-validate.py, to check all the pending rules for several common errors and oversights. For example, if you wanted to make a rule for the example.com domain, you could run
8484

85-
sh ./make-trivial-rule example.com
85+
bash ./make-trivial-rule example.com
8686

8787
inside the rules directory. This would create Example.com.xml, which you could then take a look at and edit based on your knowledge of any specific URLs at example.com that do or don't work in HTTPS. You should then run
8888

@@ -113,9 +113,11 @@ Please help write more unittests and integration tests!
113113

114114
There are also ruleset tests, which aim to find broken rulesets by actually
115115
loading URLs in a browser and watching for Mixed Content Blocking to fire.
116-
You can run ruleset tests by opening [about:config](about:config) and changing
117-
`extensions.https_everywhere.show_ruleset_tests` to true. Now when you open
118-
the HTTPS Everywhere context menu there will be a "Run HTTPS Everywhere Ruleset Tests"
119-
menu item.
116+
The easiest way to run ruleset tests is to load a standalone Firefox instance
117+
with the tests enabled:
120118

121-
When you run the tests, be prepared to let your computer run them for a really long time.
119+
bash test.sh --justrun
120+
121+
Then click the HTTPS Everywhere icon on the toolbar, and click "Run HTTPS
122+
Everywhere Ruleset Tests." When you run the tests, be prepared to let your
123+
computer run them for a really long time.

0 commit comments

Comments
 (0)