Document that guestfs_file output depends on file(1) command.

And therefore practically it cannot be part of the ABI since
the output of file(1) itself changes from time to time.
This commit is contained in:
Richard W.M. Jones
2011-05-17 20:57:56 +01:00
parent b777a5a649
commit ef6f877b9d

View File

@@ -2268,15 +2268,12 @@ The exact command which runs is C<file -zb path>. Note in
particular that the filename is not prepended to the output
(the I<-b> option).
This command can also be used on C</dev/> devices
(and partitions, LV names). You can for example use this
to determine if a device contains a filesystem, although
it's usually better to use C<guestfs_vfs_type>.
The output depends on the output of the underlying L<file(1)>
command and it can change in future in ways beyond our control.
In other words, the output is not guaranteed by the ABI.
If the C<path> does not begin with C</dev/> then
this command only works for the content of regular files.
For other file types (directory, symbolic link etc) it
will just return the string C<directory> etc.");
See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
C<guestfs_is_file>, C<guestfs_is_blockdev> (etc).");
("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
[InitScratchFS, Always, TestOutput (