From 891a6f24a0a6df5a23b4ca417cb701d6c6718b00 Mon Sep 17 00:00:00 2001
From: Tony Huang <cnwzhjs@gmail.com>
Date: Thu, 4 Aug 2011 11:39:19 +0800
Subject: [PATCH] add the document of the new api routine: path.relative

---
 doc/api/path.markdown | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/doc/api/path.markdown b/doc/api/path.markdown
index a074ed59b2..2c34eaac4a 100644
--- a/doc/api/path.markdown
+++ b/doc/api/path.markdown
@@ -71,6 +71,25 @@ Examples:
     // if currently in /home/myself/node, it returns
     '/home/myself/node/wwwroot/static_files/gif/image.gif'
 
+### path.relative(from, to)
+
+Solve the relative path from `from` to `to`.
+
+Sometimes we've got two absolute pathes, and we need to calculate the relative path from one to another.
+It's accually the reverse transform of path.resolve, which means we assume:
+
+    path.resolve(from, path.relative(from, to)) == path.resolve(to)
+
+Examples:
+
+    path.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb')
+    // returns
+    '..\\..\\impl\\bbb'
+
+    path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb')
+    // returns
+    '../../impl/bbb'
+
 ### path.dirname(p)
 
 Return the directory name of a path.  Similar to the Unix `dirname` command.