[Config] Make mount options format per-platform

RobDolinMS · RobDolinMS · commit 50532d044014 · 2016-05-18T11:51:03.000-07:00
The fstab format (https://wiki.archlinux.org/index.php/Fstab) may be appropriate for Linux, but may not be appropriate for other OS platforms. This edit clarifies that mount options for Linux (and Solaris per @JLB13) MUST be in fstab format but leaves the format of options as open for other operating systems to clarify. This replaces PR #432 Signed-off-by: Rob Dolin <RobDolin@microsoft.com>
diff --git a/config.md b/config.md
@@ -46,7 +46,9 @@ The parameters are similar to the ones in [the Linux mount system call](http://m
 * **`destination`** (string, required) Destination of mount point: path inside container.
 * **`type`** (string, required) Linux, *filesystemtype* argument supported by the kernel are listed in */proc/filesystems* (e.g., "minix", "ext2", "ext3", "jfs", "xfs", "reiserfs", "msdos", "proc", "nfs", "iso9660"). Windows: ntfs
 * **`source`** (string, required) a device name, but can also be a directory name or a dummy. Windows, the volume name that is the target of the mount point. \\?\Volume\{GUID}\ (on Windows source is called target)
-* **`options`** (list of strings, optional) in the fstab format [https://wiki.archlinux.org/index.php/Fstab](https://wiki.archlinux.org/index.php/Fstab).
+* **`options`** (list of strings, optional) in a platform-appropriate format for each operating system.
+  * For the Linux OS, if the options object is present, it MUST be in the fstab format [https://wiki.archlinux.org/index.php/Fstab](https://wiki.archlinux.org/index.php/Fstab).
+  * For the Solaris OS, if the options object is present, it MUST be in the the fstab format [https://wiki.archlinux.org/index.php/Fstab](https://wiki.archlinux.org/index.php/Fstab).
 
 ### Example (Linux)
 
