From: Ryan Dahl <ry@tinyclouds.org>
Date: Thu, 29 Oct 2009 10:17:26 +0000 (+0100)
Subject: Clean up posix module docs
X-Git-Tag: v0.1.16~22
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=7b2fdc098b518d1f182e3ac1581018a0d22e4606;p=platform%2Fupstream%2Fnodejs.git

Clean up posix module docs
---

diff --git a/doc/api.txt b/doc/api.txt
index b563246..9f0c79d 100644
--- a/doc/api.txt
+++ b/doc/api.txt
@@ -470,13 +470,16 @@ File I/O is provided by simple wrappers around standard POSIX functions.  To
 use this module do +require("/posix.js")+. 
 
 All POSIX wrappers have a similar form.  They return a promise
-(+node.Promise+). Example:
+(+node.Promise+). Example of deleting a file:
 
 ------------------------------------------------------------------------------
-var posix = require("/posix.js");
+var posix = require("/posix.js"),
+      sys = require("/sys.js");
+
 var promise = posix.unlink("/tmp/hello");
+
 promise.addCallback(function () {
-  puts("successfully deleted /tmp/hello");
+  sys.puts("successfully deleted /tmp/hello");
 });
 ------------------------------------------------------------------------------
 
@@ -486,7 +489,7 @@ following is very much prone to error
 ------------------------------------------------------------------------------
 posix.rename("/tmp/hello", "/tmp/world");
 posix.stat("/tmp/world").addCallback(function (stats) {
-  puts("stats: " + JSON.stringify(stats));
+  sys.puts("stats: " + JSON.stringify(stats));
 });
 ------------------------------------------------------------------------------
 
@@ -496,7 +499,7 @@ The correct way to do this is to chain the promises.
 ------------------------------------------------------------------------------
 posix.rename("/tmp/hello", "/tmp/world").addCallback(function () {
   posix.stat("/tmp/world").addCallback(function (stats) {
-    puts("stats: " + JSON.stringify(stats));
+    sys.puts("stats: " + JSON.stringify(stats));
   });
 });
 ------------------------------------------------------------------------------
@@ -505,9 +508,8 @@ Or use the +promise.wait()+ functionality:
 
 ------------------------------------------------------------------------------
 posix.rename("/tmp/hello", "/tmp/world").wait();
-posix.stat("/tmp/world").addCallback(function (stats) {
-  puts("stats: " + JSON.stringify(stats));
-});
+var stats = posix.stat("/tmp/world").wait();
+sys.puts("stats: " + JSON.stringify(stats));
 ------------------------------------------------------------------------------
 
 +posix.rename(path1, path2)+ ::