mirror of
https://github.com/xen-project/xen.git
synced 2026-10-28 10:11:27 +01:00
Anthony PERARD
84323dfb9d
Currently, all links to other man pages are sent to http://man.he.net/man$mansection/$manpage, but that site doesn't have Xen man pages, so all links to other Xen man pages are broken. In order to fix that, this is going to be a bit complex. First, we need to teach pod2html on where other .pod files can be found, otherwise it isn't going make any links to our pages. This is done with --podpath. Second, pod2html doesn't actually understand our format "$manpage.$mansection.pod". But instead of teaching it (which is probably impossible) we are going to modify our .pod files in order to tell pod2html which file to look for. This is done with the sed command by transforming for example: "L<xl.conf(5)>" to "L<xl.conf(5)|xl.conf.5>". Last but not least, in order to have relative links to the other generated man page, we are going against the rules, we are going to use "--htmlroot=." so that pod2html doesn't prepand "/" to all "relative" links. We are also going to `cd` into the "man" dir and set podpath to "." so that pod2html is going to generate relative links to other pod file in the form "./$man" insteadof "man/$man" or "../$man" with other compination of options. The result of --podpath + --podroot can be check in pod2html's cache file "pod2html.tmp". All of this is going to generate links in the form "./$html_manpage". But all of this doesn't work for xen-vbd-interface(7), because it's not a pod file... maybe we could generate pod2html's cache (pod2html.tmp) file to add en entry. Signed-off-by: Anthony PERARD <anthony.perard@citrix.com> Acked-by: Ian Jackson <ian.jackson@eu.citrix.com> Release-acked-by: Juergen Gross <jgross@suse.com>
xen-bugtool =========== The xen-bugtool command line application will collate the Xen dmesg output, details of the hardware configuration of your machine, information about the build of Xen that you are using, plus, if you allow it, various logs. The information collated can either be posted to a Xen Bugzilla bug (this bug must already exist in the system, and you must be a registered user there), or it can be saved as a .tar.bz2 for sending or archiving. The collated logs may contain private information, and if you are at all worried about that, you should not use this tool, or you should explicitly exclude those logs from the archive. xen-bugtool is wholly interactive, so simply run it, and answer the questions.