code review 36930044: os: clarify docs for Rename.

os: clarify docs for Rename.

Three changes:
1. mention "move" to clarify things up.
2. use {old,new}path instead of {old,new}name, which makes it clear what
   relative path would do here.
3. mention "OS-specific restrictions might apply".

Fixes issue 6887.

[minux1, 2013-12-04 03:32:37]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://code.google.com/p/go

[brainman, 2013-12-04 03:34:45]

LGTM, but please wait for others.

Thank you.

Alex

[minux1, 2013-12-04 03:37:49]

I'm open to suggestion on the 3rd point.

There is some complex restrictions on what os.Rename could do, I certainly don't
want to
enumerate them all. However, mention that some unknown os-specific restrictions
will
affect you doesn't give user much information. So It's also fine for me to drop
that clause.

On 2013/12/04 03:34:45, brainman wrote:
> but please wait for others.
i will. the tree isn't open anyway. :)

[brainman, 2013-12-04 03:47:27]

I think it is fine as is. It is os specific - we should warn users.
Unfortunetly, we cannot be more specific - too many platforms with too many
rules. We probably won't be able to even discover some of them.

Alex

[minux1, 2013-12-04 03:50:55]

On 2013/12/04 03:47:27, brainman wrote:
> I think it is fine as is. It is os specific - we should warn users.
> Unfortunetly, we cannot be more specific - too many platforms with too many
> rules. We probably won't be able to even discover some of them.
I have a new idea.
How about we say "it might fail for OS-specific reasons" instead?
which makes clear that:
1. you're free to pass any path you want (esp. if you don't need portability
to other OSes)
2. if it can't handle the arguments, it will return an error, and that's
OS-specific.

[brainman, 2013-12-04 03:55:55]

On 2013/12/04 03:50:55, minux wrote:
> ...
> How about we say "it might fail for OS-specific reasons" instead?
> which makes clear that:
> 1. you're free to pass any path you want (esp. if you don't need portability
> to other OSes)
> 2. if it can't handle the arguments, it will return an error, and that's
> OS-specific.

I like your original version better. It is broader, it is not just about
"failures". As I understand it, original issue was not the failure, but
unexpected behavior.

Alex

[iant, 2013-12-04 05:05:27]

LGTM

[r, 2013-12-04 05:09:44]

LGTM but please don't submit yet

[minux1, 2013-12-10 04:25:16]

*** Submitted as https://code.google.com/p/go/source/detail?r=51b22afec887 ***

os: clarify docs for Rename.

Three changes:
1. mention "move" to clarify things up.
2. use {old,new}path instead of {old,new}name, which makes it clear what
   relative path would do here.
3. mention "OS-specific restrictions might apply".

Fixes issue 6887.

R=golang-dev, alex.brainman, iant, r
CC=golang-dev
https://codereview.appspot.com/36930044

[minux1, 2013-12-10 04:29:58]

On 2013/12/10 04:25:16, minux wrote:
> *** Submitted as https://code.google.com/p/go/source/detail?r=51b22afec887 ***
CL 36800043 is accidentally submitted in this revision together with this CL.