doc: note in docs about missing interfaces

Update the documentation for `os.networkInterfaces` to note that any
interface that has not been assigned an address will not be displayed in
the results

Fixes: https://github.com/iojs/io.js/issues/498
PR-URL: https://github.com/iojs/io.js/pull/543
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>

diff --git a/doc/api/os.markdown b/doc/api/os.markdown
index 58a80d074d004236393ab2aa2c179e3826ea9f3a..8fea2c61708b588375020fe46330f4c1fe8cb666 100644 (file)
--- a/doc/api/os.markdown
+++ b/doc/api/os.markdown
@@ -159,6 +159,9 @@ Get a list of network interfaces:
            mac: '01:02:03:0a:0b:0c',
            internal: false } ] }
 
+Note that due to the underlying implementation this will only return network
+interfaces that have been assigned an address.
+
 ## os.EOL
 
 A constant defining the appropriate End-of-line marker for the operating system.