[Qemu-devel] [Bug 1338563] [NEW] README refers to a non-extant file

[Qemu-devel] [Bug 1338563] [NEW] README refers to a non-extant file

[Daniel U. Thibault]

Public bug reported:

The current stable QEMU release (1.4.2-89400a8) README consists of a
single line telling the new user to "read the documentation in qemu-
doc.html or on http://wiki.qemu.org".  The distribution includes no
qemu-doc.html, just a qemu-doc.texi.

** Affects: qemu
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of qemu-
devel-ml, which is subscribed to QEMU.
https://bugs.launchpad.net/bugs/1338563

Title:
  README refers to a non-extant file

Status in QEMU:
  New

Bug description:
  The current stable QEMU release (1.4.2-89400a8) README consists of a
  single line telling the new user to "read the documentation in qemu-
  doc.html or on http://wiki.qemu.org".  The distribution includes no
  qemu-doc.html, just a qemu-doc.texi.

To manage notifications about this bug go to:
https://bugs.launchpad.net/qemu/+bug/1338563/+subscriptions

[Qemu-devel] [Bug 1338563] Re: README refers to a non-extant file

[Paolo Bonzini]

qemu-doc.html appears when you build QEMU.

-- 
You received this bug notification because you are a member of qemu-
devel-ml, which is subscribed to QEMU.
https://bugs.launchpad.net/bugs/1338563

Title:
  README refers to a non-extant file

Status in QEMU:
  New

Bug description:
  The current stable QEMU release (1.4.2-89400a8) README consists of a
  single line telling the new user to "read the documentation in qemu-
  doc.html or on http://wiki.qemu.org".  The distribution includes no
  qemu-doc.html, just a qemu-doc.texi.

To manage notifications about this bug go to:
https://bugs.launchpad.net/qemu/+bug/1338563/+subscriptions

[Qemu-devel] [Bug 1338563] Re: README refers to a non-extant file

[Daniel U. Thibault]

Having qemu-doc.html appear once QEMU is built and installed (in the
source folder and in /usr/local/share/doc/qemu) defeats the purpose of
the README, which is the very first place a new user looks for building
and installation instructions.

The README needs to instruct the user to first run './configure', then
'make', then 'sudo make install'. The fourth bullet would then be
something like "for further details, see qemu-doc.html or
http://wiki.qemu.org"

-- 
You received this bug notification because you are a member of qemu-
devel-ml, which is subscribed to QEMU.
https://bugs.launchpad.net/bugs/1338563

Title:
  README refers to a non-extant file

Status in QEMU:
  New

Bug description:
  The current stable QEMU release (1.4.2-89400a8) README consists of a
  single line telling the new user to "read the documentation in qemu-
  doc.html or on http://wiki.qemu.org".  The distribution includes no
  qemu-doc.html, just a qemu-doc.texi.

To manage notifications about this bug go to:
https://bugs.launchpad.net/qemu/+bug/1338563/+subscriptions

[Qemu-devel] [Bug 1338563] Re: README refers to a non-extant file

[Stefan Weil]

The QEMU wiki which is mentioned in the README includes documention, and
there is a link to qemu-doc.html on http://wiki.qemu-project.org/Manual.


** Changed in: qemu
       Status: New => Invalid

-- 
You received this bug notification because you are a member of qemu-
devel-ml, which is subscribed to QEMU.
https://bugs.launchpad.net/bugs/1338563

Title:
  README refers to a non-extant file

Status in QEMU:
  Invalid

Bug description:
  The current stable QEMU release (1.4.2-89400a8) README consists of a
  single line telling the new user to "read the documentation in qemu-
  doc.html or on http://wiki.qemu.org".  The distribution includes no
  qemu-doc.html, just a qemu-doc.texi.

To manage notifications about this bug go to:
https://bugs.launchpad.net/qemu/+bug/1338563/+subscriptions

Re: [Qemu-devel] [Bug 1338563] Re: README refers to a non-extant file

[Peter Maydell]

On 7 July 2014 18:57, Stefan Weil <1338563@bugs.launchpad.net> wrote:
> The QEMU wiki which is mentioned in the README includes documention, and
> there is a link to qemu-doc.html on http://wiki.qemu-project.org/Manual.

This is true, but I think it would be helpful if we specifically pointed the
user there for the how-to-compile-from-source instructions, since it's
otherwise not very obvious.

In fact, the "compilation from source" section of qemu-doc.texi is
pretty badly out of date in several ways. It would probably be better
to extract it into a separate COMPILING plain text file, since it's
also not very friendly to require somebody compiling QEMU to have
either network access or to read raw .texi sources (and conversely
if you've got a pre-compiled QEMU then you don't have any interest
in reading stuff about configure and make).

thanks
-- PMM

[Qemu-devel] [Bug 1338563] Re: README refers to a non-extant file

[Daniel U. Thibault]

** Changed in: qemu
       Status: Invalid => Opinion

-- 
You received this bug notification because you are a member of qemu-
devel-ml, which is subscribed to QEMU.
https://bugs.launchpad.net/bugs/1338563

Title:
  README refers to a non-extant file

Status in QEMU:
  Opinion

Bug description:
  The current stable QEMU release (1.4.2-89400a8) README consists of a
  single line telling the new user to "read the documentation in qemu-
  doc.html or on http://wiki.qemu.org".  The distribution includes no
  qemu-doc.html, just a qemu-doc.texi.

To manage notifications about this bug go to:
https://bugs.launchpad.net/qemu/+bug/1338563/+subscriptions

[Bug 1338563] Re: README refers to a non-extant file

[John Snow]

In 2020, the qemu documentation is now hosted online and doesn't require
a build: https://www.qemu.org/documentation/

We are also very deep into a tree-wide overhaul to move our
documentation onto Sphinx and begin providing versioned manuals.

I'm closing this as fixed.

** Changed in: qemu
       Status: Opinion => Fix Released

-- 
You received this bug notification because you are a member of qemu-
devel-ml, which is subscribed to QEMU.
https://bugs.launchpad.net/bugs/1338563

Title:
  README refers to a non-extant file

Status in QEMU:
  Fix Released

Bug description:
  The current stable QEMU release (1.4.2-89400a8) README consists of a
  single line telling the new user to "read the documentation in qemu-
  doc.html or on http://wiki.qemu.org".  The distribution includes no
  qemu-doc.html, just a qemu-doc.texi.

To manage notifications about this bug go to:
https://bugs.launchpad.net/qemu/+bug/1338563/+subscriptions

[Bug 1338563] Re: README refers to a non-extant file

[Thomas Huth]

This has actually been fixed by this commit here in 2015:
https://gitlab.com/qemu-project/qemu/-/commit/0a3c190098e1cb3da

-- 
You received this bug notification because you are a member of qemu-
devel-ml, which is subscribed to QEMU.
https://bugs.launchpad.net/bugs/1338563

Title:
  README refers to a non-extant file

Status in QEMU:
  Fix Released

Bug description:
  The current stable QEMU release (1.4.2-89400a8) README consists of a
  single line telling the new user to "read the documentation in qemu-
  doc.html or on http://wiki.qemu.org".  The distribution includes no
  qemu-doc.html, just a qemu-doc.texi.

To manage notifications about this bug go to:
https://bugs.launchpad.net/qemu/+bug/1338563/+subscriptions