summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPhilip Chimento <philip.chimento@gmail.com>2021-01-25 22:00:09 +0000
committerPhilip Chimento <philip.chimento@gmail.com>2021-01-25 22:00:09 +0000
commit721792953e760029cf508309938c7068a609e27c (patch)
tree426e92f84350442abcb4baafe60a46b0656d7e40 /doc
parentfbb0db7a09334239f0a0a80a026793e761d5a24b (diff)
parent2f67bcd5ffa5e5d5a37827af44f345a70db484fc (diff)
downloadgjs-721792953e760029cf508309938c7068a609e27c.tar.gz
Merge branch 'editorconfig' into 'master'
add .editorconfig file See merge request GNOME/gjs!553
Diffstat (limited to 'doc')
-rw-r--r--doc/Environment.md26
-rw-r--r--doc/Modules.md2
2 files changed, 14 insertions, 14 deletions
diff --git a/doc/Environment.md b/doc/Environment.md
index 68ac0fd1..c584498c 100644
--- a/doc/Environment.md
+++ b/doc/Environment.md
@@ -5,34 +5,34 @@ GJS allows runtime configuration with a number of environment variables.
### General
* `GJS_PATH`
-
+
Set this variable to a list of colon-separated (`:`) paths (just like `PATH`),
to add them to the search path for the importer. Use of the `--include-path`
command-line option is preferred over this variable.
* `GJS_ABORT_ON_OOM`
-
+
> NOTE: This feature is not well tested.
-
+
Setting this variable to any value causes GJS to exit when an out-of-memory
condition is encountered, instead of just printing a warning.
-
+
### JavaScript Engine
* `JS_GC_ZEAL`
-
+
Enable GC zeal, a testing and debugging feature that helps find GC-related
bugs in JSAPI applications. See the [Hacking][hacking-gczeal] and the
[JSAPI Documentation][mdn-gczeal] for more information about this variable.
* `GJS_DISABLE_JIT`
-
+
Setting this variable to any value will disable JIT compiling in the
JavaScript engine.
### Debugging
-
+
* `GJS_DEBUG_HEAP_OUTPUT`
In addition to `System.dumpHeap()`, you can dump a heap from a running program
@@ -40,14 +40,14 @@ GJS allows runtime configuration with a number of environment variables.
`SIGUSR1` signal.
* `GJS_DEBUG_OUTPUT`
-
+
Set this to "stderr" to log to `stderr` or a file path to save to.
* `GJS_DEBUG_TOPICS`
-
+
Set this to a semi-colon delimited (`;`) list of prefixes to allow to be
logged. Prefixes include:
-
+
* "JS GI USE"
* "JS MEMORY"
* "JS CTX"
@@ -78,19 +78,19 @@ GJS allows runtime configuration with a number of environment variables.
### Testing
* `GJS_COVERAGE_OUTPUT`
-
+
Set this variable to define an output path for code coverage information. Use
of the `--coverage-output` command-line option is preferred over this
variable.
* `GJS_COVERAGE_PREFIXES`
-
+
Set this variable to define a colon-separated (`:`) list of prefixes to output
code coverage information for. Use of the `--coverage-prefix` command-line
option is preferred over this variable.
* `GJS_ENABLE_PROFILER`
-
+
Set this variable to `1` to enable or `0` to disable the profiler. Use of the
`--profile` command-line option is preferred over this variable.
diff --git a/doc/Modules.md b/doc/Modules.md
index e03605ba..c3b9baf4 100644
--- a/doc/Modules.md
+++ b/doc/Modules.md
@@ -314,7 +314,7 @@ Introspection lib as module, there are 4 special properties of **imports**:
Any other properties of **imports** is treated as a module, if you access these
properties, an import is attempted. Gjs try to look up a js file or directory by property name
from each location in `imports.searchPath`. For `imports.foo`, if a file named
-`foo.js` is found, this file is executed and then imported as a module object; else if
+`foo.js` is found, this file is executed and then imported as a module object; else if
a directory `foo` is found, a new importer object is returned and its `searchPath` property
is replaced by the path of `foo`.