Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update docs for move and rename
  • Loading branch information
kriskowal committed Jun 22, 2013
1 parent 7410cdd commit 54b5116
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,5 +1,5 @@

Copyright 2009-2011 Kristopher Michael Kowal. All rights reserved.
Copyright 2009-2013 Kristopher Michael Kowal. All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
Expand Down
20 changes: 10 additions & 10 deletions README.md
Expand Up @@ -152,17 +152,17 @@ given path or if no file exists at the path.
Removes a file or directory at a given path, recursively removing any
contained files and directories, without following symbolic links.

### move(source, target)
### rename(source, target)

Moves a file or directory from one path to another using the underlying
`rename(2)` implementation, thus it cannot move a file across devices.

Moves a file or directory from one path to another. Cannot move over a
target directory, even if it is empty. Otherwise, does nothing if the
source and target are the same entry in the file system.
### move(source, target)

Node's `rename` implementation, at least on Mac OS X, does not enforce
the rule that writing over an empty directory should fail. Since Q-IO
enforces this rule in software, it is not atomic and there is a chance
that an empty directory will be created over the target path between
when `move` checks for it and when it overwrites it.
Moves a file or directory from one path to another. If the source and
target are on different devices, falls back to copying and removing,
using `copyTree(source, target)` and, if completely successful,
`removeTree(source)`.

### link(source, taget)

Expand Down Expand Up @@ -918,6 +918,6 @@ Use `npm run cover` to generate and view a coverage report of Q-IO.

---

Copyright 2009–2012 Kristopher Michael Kowal
Copyright 2009–2013 Kristopher Michael Kowal
MIT License (enclosed)

0 comments on commit 54b5116

Please sign in to comment.