Re: [Xen-devel] [PATCH 02/11] docs: use XEN_LOG_DIR in log file location

[Ian Jackson <Ian.Jackson@xxxxxxxxxxxxx>]

Wei Liu writes ("[PATCH 02/11] docs: use XEN_LOG_DIR in log file location"):
> Signed-off-by: Wei Liu <wei.liu2@xxxxxxxxxx>
...
> diff --git a/docs/misc/hvm-emulated-unplug.markdown 
> b/docs/misc/hvm-emulated-unplug.markdown
> index c6d1f9b..89fe14b 100644
> --- a/docs/misc/hvm-emulated-unplug.markdown
> +++ b/docs/misc/hvm-emulated-unplug.markdown
> @@ -45,7 +45,7 @@ drivers):
>  
>  Once the drivers have checked the magic number, they can send log
>  messages to qemu which will be logged to wherever qemu's logs go
> -(`/var/log/xen/qemu-dm.log` on normal Xen, dom0 syslog on XenServer).
> +(`$XEN_LOG_DIR/qemu-dm.log` on normal Xen, dom0 syslog on XenServer).
>  These messages are written to IO port `0x12` a byte at a time, and are
>  terminated by newlines.  There's a fairly aggressive rate limiter on
>  these messages, so they shouldn't be used for anything even vaguely

I'm not a big fan of this kind of abstracted-away documentation.  (I
think writing this in the markdown does not cause substitution.)  IMO
it's better to have a concrete path which is right in almost all
cases, even if it is sometimes wrong.

Ian.

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel