From 6c31c0c7a8de2b89149a227c1dd05d284bc9abd0 Mon Sep 17 00:00:00 2001 From: smith Date: Mon, 6 Jul 2009 02:38:47 -0500 Subject: [PATCH] Doc updates --- README.md | 2 +- doc/narwhal.md | 16 ++++++++-------- doc/platforms.md | 4 ++-- doc/quick-start.md | 2 +- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 97e38974..6ded27d6 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Narwhal is a server-side JavaScript standard library conforming to the [ServerJS Documentation ------------- -**The following links are relative and may not resolve properly depending on where and how they are viewed. Please visit the [canonical repository](http://github.com/tlrobinson/narwhal/tree/master/) or this repository's [mater](master/) branch if they do not work.** +**The following links are relative and may not resolve properly depending on where and how they are viewed. Please visit the [canonical repository](http://github.com/tlrobinson/narwhal/tree/master/) or this repository's [master](master/) branch if they do not work.** * [Quick Start](doc/quick-start.md) * [Packages](doc/packages.md) diff --git a/doc/narwhal.md b/doc/narwhal.md index a0a1a0b8..d2a3f055 100644 --- a/doc/narwhal.md +++ b/doc/narwhal.md @@ -124,7 +124,7 @@ Environment Variables sandboxes as the `require.loader.paths` variable, and may be editable in place with methods like `shift`, `unshift`, and `splice`. Replacing - `require.loader.paths` with a new array may not + `require.loader.paths` with a new Array may not have any effect. In secure sandboxes, `paths` are not available. @@ -249,7 +249,7 @@ Narwhal launches in stages. On UNIX-like systems, Narwhal starts with a `bash` `system` `Object`, to be replaced later by loading the `system` module proper. `bootstrap.js` provides a `system` object with `global`, `evalGlobal`, `platform`, - a `platforms` `Array`, `print`, `fs.read`, `fs.isFile`, + a `platforms` Array, `print`, `fs.read`, `fs.isFile`, `prefix`, `packagePrefixes`, and optionally `evaluate`, `debug`, or `verbose`. @@ -277,7 +277,7 @@ Narwhal launches in stages. On UNIX-like systems, Narwhal starts with a `bash` environment variable, the path leading to the `narwhal` package containing `bin/narwhal`. - * `packagePrefixes` is a prioritized `Array` of all of + * `packagePrefixes` is a prioritized Array of all of the package directories to search for packages when that time comes. The first package prefix should be the `SEA` environment variable, if it @@ -288,10 +288,10 @@ Narwhal launches in stages. On UNIX-like systems, Narwhal starts with a `bash` prefix appears first so that virtual environments can load their own package versions. - * `platforms` is an `Array` of platform names, used + * `platforms` is an Array of platform names, used to extend the module search path at various stages to include platform specific libraries. There will - usually be more than one platform in this `Array`. + usually be more than one platform in this Array. For Rhino, it is `['rhino', 'default']`. The `default` platform contains many "catch-all" modules that, while being platform-specific, are also @@ -314,7 +314,7 @@ Narwhal launches in stages. On UNIX-like systems, Narwhal starts with a `bash` has a suitable default, but some platforms provide their own. For example, the "secure" platform injects a safe, hermetic evaluator. `evaluate` - accepts a module as a `String`, and optionally + accepts a module as a String, and optionally a file name and line number for debugging purposes. `evaluate` returns a module factory `Function` that accepts `require`, `exports`, `module`, `system`, @@ -432,7 +432,7 @@ The packages module analyzes and installs packages, such that their libraries ar * find and read package.json for every accessible package, collating them into a catalog. This involves a breadth first topological search of the `packages/` directory of each - `package` in the `system.packagePrefixes` `array`. This + `package` in the `system.packagePrefixes` Array. This guarantees that the packages installed in the Sea (virtual environment) can override the versions installed with the system. @@ -457,7 +457,7 @@ The packages module analyzes and installs packages, such that their libraries ar Much of the weight of code in the `packages` module concerns using both the conventional locations for libraries and whatnot, but also handling overriden configuration values, gracefully -accepting both single `Strings` and `Arrays` of multiple options +accepting both single Strings and Arrays of multiple options for all directories. For example, `packages` assumes that each package has a `lib` directory. However, the package may provide a `package.json` that states that `lib` has been put diff --git a/doc/platforms.md b/doc/platforms.md index 2c1cfbfb..18d3b89c 100644 --- a/doc/platforms.md +++ b/doc/platforms.md @@ -8,10 +8,10 @@ Narwhal is a standard library and tools for multiple JavaScript engines; each en * `k7`: is a `v8` based engine, in development by Sébastien Pierre. * `helma`: is based on Rhino with extensions, being developed by Hannes Wallnöefer. * `xulrunner`: is in development for Firefox extensions and XULRunner applications on the Spidermonkey platform by Irakli Gozalishvili, Christoph Dorn, and Zach Carter. -* `jaxer`: is an engine based on Rhino, for deploying web pages with both server and client side scripts, being developed by Nathan Smith. +* `jaxer`: is an engine based on Mozilla SpiderMonkey, for deploying web pages with both server and client side scripts, being developed by Nathan L Smith. * `v8cgi`: is based on the work of Ondrej Zara, and has not been updated in a long while. * `default`: is a catchall platform that implements modules that can be shared among platforms. -* `browser`: will eventually be available for client side loading of modules, with various techniques. +* `browser`: will eventually be available for client side loading of modules with various techniques. * `secure`: will eventually be available for dependency injection sandboxed module systems within some other platforms. diff --git a/doc/quick-start.md b/doc/quick-start.md index 73911c12..3522a11e 100644 --- a/doc/quick-start.md +++ b/doc/quick-start.md @@ -52,4 +52,4 @@ Run it! jackup -Next, take a look at the introduction to [modules](/modules.html), for a primer on using and making modules in Narwhal. +Next, take a look at the introduction to [modules](modules.html), for a primer on using and making modules in Narwhal.