From 18f7c0a3f6f39af5cd2db484dbf0817fbfb526d5 Mon Sep 17 00:00:00 2001 From: Rob Pike Date: Wed, 21 Dec 2011 11:46:42 -0800 Subject: [PATCH] path/filepath.Rel: document that the returned path is always relative Fixes #2593. R=rsc, alex.brainman, n13m3y3r CC=golang-dev https://golang.org/cl/5500052 --- src/pkg/path/filepath/path.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/pkg/path/filepath/path.go b/src/pkg/path/filepath/path.go index e3d6c342ca..68cbae6644 100644 --- a/src/pkg/path/filepath/path.go +++ b/src/pkg/path/filepath/path.go @@ -262,6 +262,8 @@ func Abs(path string) (string, error) { // Rel returns a relative path that is lexically equivalent to targpath when // joined to basepath with an intervening separator. That is, // Join(basepath, Rel(basepath, targpath)) is equivalent to targpath itself. +// On success, the returned path will always be relative to basepath, +// even if basepath and targpath share no elements. // An error is returned if targpath can't be made relative to basepath or if // knowing the current working directory would be necessary to compute it. func Rel(basepath, targpath string) (string, error) { -- 2.48.1