platform/upstream/nodejs.git
12 years agodoc: typo in child_process documentation
isaacs [Fri, 20 Apr 2012 14:46:36 +0000 (07:46 -0700)]
doc: typo in child_process documentation

12 years agodocs: Remove duplicate socket.write() description
Brian White [Fri, 20 Apr 2012 06:57:14 +0000 (02:57 -0400)]
docs: Remove duplicate socket.write() description

12 years agotypo in node_http_parser
isaacs [Wed, 18 Apr 2012 02:24:28 +0000 (19:24 -0700)]
typo in node_http_parser

12 years agodeps: fix v8 build error
Dane Springmeyer [Wed, 18 Apr 2012 17:32:02 +0000 (10:32 -0700)]
deps: fix v8 build error

Pull in build error fix from http://code.google.com/p/v8/source/detail?r=9505
Missed in 5d69bbfbd.

12 years agoFix bug in x64 RegExp detecting start of string.
lrn@chromium.org [Mon, 3 Oct 2011 10:31:01 +0000 (10:31 +0000)]
Fix bug in x64 RegExp detecting start of string.

Also add missing MIPS case in regexp tracer.

Fixes issues v8:1748 and v8:1746

BUG=v8:1748, v8:1746
TEST=mjsunit/regress/regress-1748.js

Review URL: http://codereview.chromium.org/8116001

git-svn-id: https://v8.googlecode.com/svn/branches/bleeding_edge@9504 ce2b1a6d-e550-0410-aec6-3dcde31c8c00

12 years agodisable omit-frame-pointer on solaris systems
Dave Pacheco [Wed, 8 Feb 2012 00:50:05 +0000 (16:50 -0800)]
disable omit-frame-pointer on solaris systems

12 years agoPatches floating on v8
isaacs [Thu, 2 Feb 2012 23:37:59 +0000 (15:37 -0800)]
Patches floating on v8

12 years agoUpgrade V8 to 3.6.6.25
Bert Belder [Mon, 16 Apr 2012 15:27:16 +0000 (17:27 +0200)]
Upgrade V8 to 3.6.6.25

12 years agonode: don't check return value of unsetenv()
Ben Noordhuis [Sat, 31 Mar 2012 21:23:46 +0000 (23:23 +0200)]
node: don't check return value of unsetenv()

It returns void on some platforms, notably FreeBSD.

12 years agodeps: upgrade http_parser to joyent/http-parser@da91852
Ben Noordhuis [Sat, 14 Apr 2012 21:12:36 +0000 (23:12 +0200)]
deps: upgrade http_parser to joyent/http-parser@da91852

12 years agoFix #3089 Build changelog.html for website
isaacs [Wed, 11 Apr 2012 01:29:25 +0000 (18:29 -0700)]
Fix #3089 Build changelog.html for website

12 years agoMakefile: minor nit
isaacs [Wed, 11 Apr 2012 01:22:42 +0000 (18:22 -0700)]
Makefile: minor nit

12 years agoNow working on v0.6.16
isaacs [Mon, 9 Apr 2012 17:34:54 +0000 (10:34 -0700)]
Now working on v0.6.16

12 years agoMerge branch 'v0.6.15-release' into v0.6
isaacs [Mon, 9 Apr 2012 17:34:32 +0000 (10:34 -0700)]
Merge branch 'v0.6.15-release' into v0.6

12 years ago2012.04.09 Version 0.6.15 (stable) v0.6.15
isaacs [Sat, 7 Apr 2012 23:59:54 +0000 (16:59 -0700)]
2012.04.09 Version 0.6.15 (stable)

* Update npm to 1.1.16

* Show licenses in binary installers.

* unix: add uv_fs_read64, uv_fs_write64 and uv_fs_ftruncate64 (Ben Noordhuis)

* add 64bit offset fs functions (Igor Zinkovsky)

* windows: don't report ENOTSOCK when attempting to bind an udp handle twice (Bert Belder)

* windows: backport pipe-connect-to-file fixes from master (Bert Belder)

* windows: never call fs event callbacks after closing the watcher (Bert Belder)

* fs.readFile: don't make the callback before the fd is closed (Bert Belder)

* windows: use 64bit offsets for uv_fs apis (Igor Zinkovsky)

* Fix #2061: segmentation fault on OS X due to stat size mismatch (Ben Noordhuis)

12 years agofs.WriteStream: Handle modifications to fs.open
isaacs [Mon, 9 Apr 2012 15:39:13 +0000 (08:39 -0700)]
fs.WriteStream: Handle modifications to fs.open

If the fs.open method is modified via AOP-style extension, in between
the creation of an fs.WriteStream and the processing of its action
queue, then the test of whether or not the method === fs.open will fail,
because fs.open has been replaced.

The solution is to save a reference to fs.open on the stream itself when
the action is placed in the queue.

This fixes isaacs/node-graceful-fs#6.

12 years agofs.readFile: Emit 'close' if we don't expect a close later
isaacs [Sat, 7 Apr 2012 23:53:18 +0000 (16:53 -0700)]
fs.readFile: Emit 'close' if we don't expect a close later

This fixes a regression introduced by 40b7302

12 years agoMake rules for release blog post and email message
isaacs [Thu, 29 Mar 2012 23:01:27 +0000 (16:01 -0700)]
Make rules for release blog post and email message

12 years agowebsite: Add October Sky JS and Node.js Hispano
isaacs [Sat, 7 Apr 2012 23:29:37 +0000 (16:29 -0700)]
website: Add October Sky JS and Node.js Hispano

12 years agoRemove stray comment from LICENSE file
isaacs [Sat, 7 Apr 2012 23:20:42 +0000 (16:20 -0700)]
Remove stray comment from LICENSE file

12 years agoWindows: installer shows license agreement dialog
Bert Belder [Wed, 4 Apr 2012 16:06:33 +0000 (18:06 +0200)]
Windows: installer shows license agreement dialog

12 years agoWindows: add build step that generates license.rtf from LICENSE
Bert Belder [Wed, 4 Apr 2012 16:06:00 +0000 (18:06 +0200)]
Windows: add build step that generates license.rtf from LICENSE

12 years agoMac installer shows license
Ryan Dahl [Mon, 2 Apr 2012 22:14:52 +0000 (15:14 -0700)]
Mac installer shows license

ref #3056

12 years agoInclude text of licenses in LICENSE file
Ryan Dahl [Mon, 2 Apr 2012 22:12:23 +0000 (15:12 -0700)]
Include text of licenses in LICENSE file

For easy inclusion in binary distributions. ref #3056

12 years agoFix links to libev and libeio licenses
Ryan Dahl [Mon, 2 Apr 2012 21:36:23 +0000 (14:36 -0700)]
Fix links to libev and libeio licenses

12 years agoUpdate npm to 1.1.16
isaacs [Fri, 6 Apr 2012 21:42:19 +0000 (14:42 -0700)]
Update npm to 1.1.16

12 years agoenable test-fs-largefile.js test
Igor Zinkovsky [Fri, 6 Apr 2012 01:15:10 +0000 (18:15 -0700)]
enable test-fs-largefile.js test

12 years agoPlease the compiler
Bert Belder [Fri, 6 Apr 2012 01:02:23 +0000 (03:02 +0200)]
Please the compiler

12 years agofs.readFile: don't make the callback before the fd is closed
Bert Belder [Fri, 6 Apr 2012 00:54:33 +0000 (02:54 +0200)]
fs.readFile: don't make the callback before the fd is closed

On Windows it is not possible to unlink() the read file in the callback.
This fixes #3051. A test is included.

12 years agoupgrade libuv to d68b3d960b6d95bfc16027cecca2f3fa48bcc36f
Igor Zinkovsky [Fri, 6 Apr 2012 00:10:39 +0000 (17:10 -0700)]
upgrade libuv to d68b3d960b6d95bfc16027cecca2f3fa48bcc36f

12 years agowindows: use 64bit offsets for uv_fs apis
Igor Zinkovsky [Thu, 5 Apr 2012 23:03:11 +0000 (16:03 -0700)]
windows: use 64bit offsets for uv_fs apis

12 years agobuild: define _DARWIN_USE_64_BIT_INODE=1 on OS X
Ben Noordhuis [Mon, 2 Apr 2012 21:44:36 +0000 (23:44 +0200)]
build: define _DARWIN_USE_64_BIT_INODE=1 on OS X

Fixes a segmentation fault on some OS X systems due to sizeof(struct stat)
mismatches.

Fixes #2061.

12 years agojs2c: fix to support files other than ones ending with 2 char extensions
Nathan Rajlich [Wed, 14 Mar 2012 01:31:04 +0000 (18:31 -0700)]
js2c: fix to support files other than ones ending with 2 char extensions

Previously this was basically hard-coded for *.js files, but now we
need to include the 'config.gypi' file in there as well.

12 years agowebsite: Consistency in the industry logos
isaacs [Sat, 31 Mar 2012 01:21:50 +0000 (18:21 -0700)]
website: Consistency in the industry logos

12 years agoFix #3001 website update 'latest' links on publish
isaacs [Sat, 24 Mar 2012 08:39:39 +0000 (01:39 -0700)]
Fix #3001 website update 'latest' links on publish

12 years agoNow working on v0.6.15
isaacs [Fri, 23 Mar 2012 18:17:08 +0000 (11:17 -0700)]
Now working on v0.6.15

12 years agoMerge branch 'v0.6.14-release' into v0.6
isaacs [Fri, 23 Mar 2012 18:16:31 +0000 (11:16 -0700)]
Merge branch 'v0.6.14-release' into v0.6

12 years ago2012.03.22 Version 0.6.14 (stable) v0.6.14
isaacs [Fri, 23 Mar 2012 00:32:11 +0000 (17:32 -0700)]
2012.03.22 Version 0.6.14 (stable)

* net: don't crash when queued write fails (Igor Zinkovsky)

* sunos: fix EMFILE on process.memoryUsage() (Bryan Cantrill)

* crypto: fix compile-time error with openssl 0.9.7e (Ben Noordhuis)

* unix: ignore ECONNABORTED errors from accept() (Ben Noordhuis)

* Add UV_ENOSPC and mappings to it (Bert Belder)

* http-parser: Fix response body is not read (koichik)

* Upgrade npm to 1.1.12
  - upgrade node-gyp to 0.3.7
  - work around AV-locked directories on Windows
  - Fix isaacs/npm#2293 Don't try to 'uninstall' /
  - Exclude symbolic links from packages.
  - Fix isaacs/npm#2275 Spurious 'unresolvable cycle' error.
  - Exclude/include dot files as if they were normal files

12 years agodoc: Remove extraneous index.html's from hyperlinks
isaacs [Fri, 16 Mar 2012 15:19:18 +0000 (08:19 -0700)]
doc: Remove extraneous index.html's from hyperlinks

12 years agoRemove hard-coded version number from docs
isaacs [Fri, 16 Mar 2012 15:13:41 +0000 (08:13 -0700)]
Remove hard-coded version number from docs

12 years agodon't crash when queued write fails
Igor Zinkovsky [Tue, 20 Mar 2012 07:21:38 +0000 (00:21 -0700)]
don't crash when queued write fails

12 years agoUpgrade libuv to 8409a67
isaacs [Thu, 22 Mar 2012 23:44:04 +0000 (16:44 -0700)]
Upgrade libuv to 8409a67

12 years agoRemove unused fast-list module from npm
isaacs [Thu, 22 Mar 2012 23:43:28 +0000 (16:43 -0700)]
Remove unused fast-list module from npm

12 years agoUpgrade npm to 1.1.12
isaacs [Thu, 22 Mar 2012 23:38:58 +0000 (16:38 -0700)]
Upgrade npm to 1.1.12

12 years agosunos: fix EMFILE on process.memoryUsage()
Bryan Cantrill [Thu, 22 Mar 2012 23:06:35 +0000 (23:06 +0000)]
sunos: fix EMFILE on process.memoryUsage()

12 years agocrypto: fix compile-time error with openssl <= 0.9.7e
Ben Noordhuis [Thu, 22 Mar 2012 14:52:12 +0000 (15:52 +0100)]
crypto: fix compile-time error with openssl <= 0.9.7e

12 years agoFix include logic was replacing https include with http
isaacs [Sat, 17 Mar 2012 18:07:28 +0000 (11:07 -0700)]
Fix include logic was replacing https include with http

12 years agoIgnore 'making a build' artifacts
isaacs [Sat, 17 Mar 2012 18:00:05 +0000 (11:00 -0700)]
Ignore 'making a build' artifacts

12 years agotest: HTTP responses with no content-length
koichik [Sat, 17 Mar 2012 15:50:47 +0000 (00:50 +0900)]
test: HTTP responses with no content-length

Refs: #2952.

12 years agodeps: upgrade http_parser to joyent/http-parser@b47c44d
Ben Noordhuis [Sat, 17 Mar 2012 14:50:43 +0000 (15:50 +0100)]
deps: upgrade http_parser to joyent/http-parser@b47c44d

12 years agodoc: fix # links from (and within) api/fs
Rod Vagg [Fri, 16 Mar 2012 02:43:00 +0000 (13:43 +1100)]
doc: fix # links from (and within) api/fs

12 years agoNow working on v0.6.14
isaacs [Thu, 15 Mar 2012 17:33:33 +0000 (10:33 -0700)]
Now working on v0.6.14

12 years agoMerge branch 'v0.6.13-release' into v0.6
isaacs [Thu, 15 Mar 2012 17:32:58 +0000 (10:32 -0700)]
Merge branch 'v0.6.13-release' into v0.6

12 years ago2012.03.15 Version 0.6.13 (stable) v0.6.13
isaacs [Thu, 15 Mar 2012 00:07:24 +0000 (17:07 -0700)]
2012.03.15 Version 0.6.13 (stable)

* Windows: Many libuv test fixes (Bert Belder)

* Windows: avoid uv_guess_handle crash in when fd < 0 (Bert Belder)

* Map EBUSY and ENOTEMPTY errors (Bert Belder)

* Windows: include syscall in fs errors (Bert Belder)

* Fix fs.watch ENOSYS on Linux kernel version mismatch (Ben Noordhuis)

* Update npm to 1.1.9
  - upgrade node-gyp to 0.3.5 (Nathan Rajlich)
  - Fix isaacs/npm#2249 Add cache-max and cache-min configs
  - Properly redirect across https/http registry requests
  - log config usage if undefined key in set function (Kris Windham)
  - Add support for os/cpu fields in package.json (Adam Blackburn)
  - Automatically node-gyp packages containing a binding.gyp
  - Fix failures unpacking in UNC shares
  - Never create un-listable directories
  - Handle cases where an optionalDependency fails to build

12 years agomakefile: Fix 'make doc'
isaacs [Thu, 15 Mar 2012 15:22:31 +0000 (08:22 -0700)]
makefile: Fix 'make doc'

12 years agoUpgrade libuv to 66a959c4052
isaacs [Thu, 15 Mar 2012 15:14:22 +0000 (08:14 -0700)]
Upgrade libuv to 66a959c4052

12 years agoUpdate npm to 1.1.9
isaacs [Wed, 14 Mar 2012 23:39:15 +0000 (16:39 -0700)]
Update npm to 1.1.9

12 years agoUpdate uv to 5d21056
isaacs [Wed, 14 Mar 2012 23:30:35 +0000 (16:30 -0700)]
Update uv to 5d21056

12 years agoDoc highlight fix
Artur Adib [Fri, 9 Mar 2012 14:35:39 +0000 (09:35 -0500)]
Doc highlight fix

12 years agopath.exists*() as 2nd level head not 3rd
Rod Vagg [Wed, 14 Mar 2012 03:53:27 +0000 (14:53 +1100)]
path.exists*() as 2nd level head not 3rd

12 years agoWindows: include syscall in fs errors
Bert Belder [Wed, 7 Mar 2012 23:13:44 +0000 (00:13 +0100)]
Windows: include syscall in fs errors

12 years agouv: upgrade to 1ac71a31
Bert Belder [Thu, 8 Mar 2012 01:57:37 +0000 (02:57 +0100)]
uv: upgrade to 1ac71a31

12 years agoMention marked, and add license to doc generator
isaacs [Mon, 5 Mar 2012 18:59:14 +0000 (10:59 -0800)]
Mention marked, and add license to doc generator

12 years agodoc: 'filename' arg not guaranteed ever.
isaacs [Mon, 5 Mar 2012 18:28:47 +0000 (10:28 -0800)]
doc: 'filename' arg not guaranteed ever.

12 years agodoc: css consistency on anchor links
isaacs [Sun, 4 Mar 2012 06:58:47 +0000 (22:58 -0800)]
doc: css consistency on anchor links

12 years agodoc: Don't prune Stability indicators
isaacs [Sun, 4 Mar 2012 06:58:29 +0000 (22:58 -0800)]
doc: Don't prune Stability indicators

12 years agodoc: Typo'd some stability indicators.
isaacs [Sun, 4 Mar 2012 06:12:35 +0000 (22:12 -0800)]
doc: Typo'd some stability indicators.

12 years agodoc: Change 'file_system' module to 'fs' as it should be
isaacs [Sun, 4 Mar 2012 01:14:06 +0000 (17:14 -0800)]
doc: Change 'file_system' module to 'fs' as it should be

12 years agoUse shorter url for /docs/latest/api
isaacs [Sun, 4 Mar 2012 01:08:46 +0000 (17:08 -0800)]
Use shorter url for /docs/latest/api

12 years agodoc: Stability and Caveats for fs.watch/watchFile
isaacs [Sun, 4 Mar 2012 00:23:31 +0000 (16:23 -0800)]
doc: Stability and Caveats for fs.watch/watchFile

12 years agodoc: indentation and structure in fs.markdown
isaacs [Sun, 4 Mar 2012 00:23:15 +0000 (16:23 -0800)]
doc: indentation and structure in fs.markdown

12 years agodoc: Document JSON docs
isaacs [Sat, 3 Mar 2012 23:51:14 +0000 (15:51 -0800)]
doc: Document JSON docs

12 years agodoc: Add link to JSON version of doc
isaacs [Sat, 3 Mar 2012 23:50:33 +0000 (15:50 -0800)]
doc: Add link to JSON version of doc

12 years agodoc: Add stability indicators to documentation
isaacs [Fri, 2 Mar 2012 23:14:03 +0000 (15:14 -0800)]
doc: Add stability indicators to documentation

12 years agoNow working on v0.6.13
isaacs [Fri, 2 Mar 2012 21:08:28 +0000 (13:08 -0800)]
Now working on v0.6.13

12 years agoMerge branch 'v0.6.12-release' into v0.6
isaacs [Fri, 2 Mar 2012 21:09:00 +0000 (13:09 -0800)]
Merge branch 'v0.6.12-release' into v0.6

12 years ago2012.03.02 Version 0.6.12 (stable) v0.6.12
isaacs [Fri, 2 Mar 2012 18:29:03 +0000 (10:29 -0800)]
2012.03.02 Version 0.6.12 (stable)

* Upgrade V8 to 3.6.6.24

* dtrace ustack helper improvements (Dave Pacheco)

* API Documentation refactor (isaacs)

* #2827 net: fix race write() before and after connect() (koichik)

* #2554 #2567 throw if fs args for 'start' or 'end' are strings (AJ ONeal)

* punycode: Update to v1.0.0 (Mathias Bynens)

* Make a fat binary for the OS X pkg (isaacs)

* Fix hang on accessing process.stdin (isaacs)

* repl: make tab completion work on non-objects (Nathan Rajlich)

* Fix fs.watch on OS X (Ben Noordhuis)

* Fix #2515 nested setTimeouts cause premature process exit (Ben Noordhuis)

* windows: fix time conversion in stat (Igor Zinkovsky)

* windows: fs: handle EOF in read (Brandon Philips)

* windows: avoid IOCP short-circuit on non-ifs lsps (Igor Zinkovsky)

* Upgrade npm to 1.1.4 (isaacs)
  - windows fixes
  - Bundle nested bundleDependencies properly
  - install: support --save with url install targets
  - shrinkwrap: behave properly with url-installed modules
  - support installing uncompressed tars or single file modules from urls etc.
  - don't run make clean on rebuild
  - support HTTPS-over-HTTP proxy tunneling

12 years agocss: Fix fonts on api index page navigation
isaacs [Fri, 2 Mar 2012 20:35:58 +0000 (12:35 -0800)]
css: Fix fonts on api index page navigation

12 years agodisable omit-frame-pointer on solaris systems
Dave Pacheco [Wed, 8 Feb 2012 00:50:05 +0000 (16:50 -0800)]
disable omit-frame-pointer on solaris systems

12 years agoPatches floating on v8
isaacs [Thu, 2 Feb 2012 23:37:59 +0000 (15:37 -0800)]
Patches floating on v8

12 years agoUpgrade V8 to 3.6.6.24
isaacs [Fri, 2 Mar 2012 19:23:12 +0000 (11:23 -0800)]
Upgrade V8 to 3.6.6.24

12 years agoUpgrade npm to 1.1.4 (minor bugfix)
isaacs [Fri, 2 Mar 2012 17:48:25 +0000 (09:48 -0800)]
Upgrade npm to 1.1.4 (minor bugfix)

12 years agoUpgrade npm to 1.1.3
isaacs [Fri, 2 Mar 2012 17:31:24 +0000 (09:31 -0800)]
Upgrade npm to 1.1.3

* Update request to support HTTPS-over-HTTP proxy tunneling
* Throw on undefined envs in config settings
* Update which to 1.0.5
* Fix windows UNC busyloop in findPrefix
* Bundle nested bundleDependencies properly
* Alias adduser to add-user
* Doc updates  (Christian Howe, Henrik Hodne, Andrew Lunny)
* ignore logfd/outfd streams in makeEnv() (Rod Vagg)
* shrinkwrap: Behave properly with url-installed deps
* install: Support --save with url install targets
* Support installing naked tars or single-file modules from urls etc.
* init: Don't add engines section
* Don't run make clean on rebuild
* Added missing unicode replacement (atomizer)

12 years agodtrace ustack helper improvements
Dave Pacheco [Thu, 1 Mar 2012 17:19:51 +0000 (09:19 -0800)]
dtrace ustack helper improvements

Fixes #2852

12 years agoChange test fixture from symlink to regular file
isaacs [Thu, 23 Feb 2012 04:19:12 +0000 (20:19 -0800)]
Change test fixture from symlink to regular file

The only test using this is test/simple/test-fs-chmod.js, and it was
treating a.js and a1.js as two separate files, resulting in a race
condition.  (Interestingly enough, it was *not* using the symlink file to
test lchmod, which uses a different temp file.)

12 years agouv: upgrade to b3fe183
Ben Noordhuis [Thu, 1 Mar 2012 16:00:33 +0000 (17:00 +0100)]
uv: upgrade to b3fe183

12 years agoMerge branch 'json-api-v0.6' into v0.6
isaacs [Thu, 1 Mar 2012 00:05:18 +0000 (16:05 -0800)]
Merge branch 'json-api-v0.6' into v0.6

12 years agoHandle miscs better
isaacs [Mon, 27 Feb 2012 19:44:36 +0000 (11:44 -0800)]
Handle miscs better

12 years agoDebugger should be a misc, not 'concept'
isaacs [Mon, 27 Feb 2012 19:44:30 +0000 (11:44 -0800)]
Debugger should be a misc, not 'concept'

12 years ago'Events' is a module, not an event named 's'
isaacs [Mon, 27 Feb 2012 19:37:26 +0000 (11:37 -0800)]
'Events' is a module, not an event named 's'

12 years agos/streams/stream/
isaacs [Mon, 27 Feb 2012 19:18:10 +0000 (11:18 -0800)]
s/streams/stream/

12 years agos/buffers/buffer/
isaacs [Mon, 27 Feb 2012 19:12:35 +0000 (11:12 -0800)]
s/buffers/buffer/

12 years agodoc refactor: zlib
isaacs [Mon, 27 Feb 2012 19:09:35 +0000 (11:09 -0800)]
doc refactor: zlib

12 years agodoc refactor: vm
isaacs [Mon, 27 Feb 2012 19:09:35 +0000 (11:09 -0800)]
doc refactor: vm

12 years agodoc refactor: util
isaacs [Mon, 27 Feb 2012 19:09:35 +0000 (11:09 -0800)]
doc refactor: util

12 years agodoc refactor: url
isaacs [Mon, 27 Feb 2012 19:09:35 +0000 (11:09 -0800)]
doc refactor: url

12 years agodoc refactor: tty
isaacs [Mon, 27 Feb 2012 19:09:35 +0000 (11:09 -0800)]
doc refactor: tty

12 years agodoc refactor: tls
isaacs [Mon, 27 Feb 2012 19:09:35 +0000 (11:09 -0800)]
doc refactor: tls

12 years agodoc refactor: timers
isaacs [Mon, 27 Feb 2012 19:09:34 +0000 (11:09 -0800)]
doc refactor: timers

12 years agodoc refactor: synopsis
isaacs [Mon, 27 Feb 2012 19:09:34 +0000 (11:09 -0800)]
doc refactor: synopsis