[PATCH] docs: ABI: correct QEMU fw_cfg spec path

[PATCH] docs: ABI: correct QEMU fw_cfg spec path

[Jason A. Donenfeld]

A few weeks ago, QEMU switched docs/specs/fw_cfg.txt to be
docs/specs/fw_cfg.rst, so update the reference in the kernel docs to
reflect this.

Cc: Simon Sapin <simon.sapin@exyr.org>
Cc: Gabriel Somlo <somlo@cmu.edu>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
---
 Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg b/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
index ee0d6dbc810e..7cbce4af6346 100644
--- a/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
+++ b/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
@@ -12,7 +12,7 @@ Description:
 		configuration data to the guest userspace.
 
 		The authoritative guest-side hardware interface documentation
-		to the fw_cfg device can be found in "docs/specs/fw_cfg.txt"
+		to the fw_cfg device can be found in "docs/specs/fw_cfg.rst"
 		in the QEMU source tree.
 
 		**SysFS fw_cfg Interface**
-- 
2.35.1

Re: [PATCH] docs: ABI: correct QEMU fw_cfg spec path

[Jonathan Corbet]

"Jason A. Donenfeld" <Jason@zx2c4.com> writes:

> A few weeks ago, QEMU switched docs/specs/fw_cfg.txt to be
> docs/specs/fw_cfg.rst, so update the reference in the kernel docs to
> reflect this.
>
> Cc: Simon Sapin <simon.sapin@exyr.org>
> Cc: Gabriel Somlo <somlo@cmu.edu>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
> ---
>  Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg b/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
> index ee0d6dbc810e..7cbce4af6346 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
> +++ b/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
> @@ -12,7 +12,7 @@ Description:
>  		configuration data to the guest userspace.
>  
>  		The authoritative guest-side hardware interface documentation
> -		to the fw_cfg device can be found in "docs/specs/fw_cfg.txt"
> +		to the fw_cfg device can be found in "docs/specs/fw_cfg.rst"
>  		in the QEMU source tree.

This is a worthy change, but is there any chance we could provide a URL
instead so that people don't have to go finding the QEMU source to get
the information they need?

Thanks,

jon

Re: [PATCH] docs: ABI: correct QEMU fw_cfg spec path

[Jason A. Donenfeld]

Hi Jon,

On Wed, Jul 20, 2022 at 2:27 PM Jonathan Corbet <corbet@lwn.net> wrote:
>
> "Jason A. Donenfeld" <Jason@zx2c4.com> writes:
>
> > A few weeks ago, QEMU switched docs/specs/fw_cfg.txt to be
> > docs/specs/fw_cfg.rst, so update the reference in the kernel docs to
> > reflect this.
> >
> > Cc: Simon Sapin <simon.sapin@exyr.org>
> > Cc: Gabriel Somlo <somlo@cmu.edu>
> > Cc: Jonathan Corbet <corbet@lwn.net>
> > Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
> > ---
> >  Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg b/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
> > index ee0d6dbc810e..7cbce4af6346 100644
> > --- a/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
> > +++ b/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
> > @@ -12,7 +12,7 @@ Description:
> >               configuration data to the guest userspace.
> >
> >               The authoritative guest-side hardware interface documentation
> > -             to the fw_cfg device can be found in "docs/specs/fw_cfg.txt"
> > +             to the fw_cfg device can be found in "docs/specs/fw_cfg.rst"
> >               in the QEMU source tree.
>
> This is a worthy change, but is there any chance we could provide a URL
> instead so that people don't have to go finding the QEMU source to get
> the information they need?

Sure. Will send a v2.
(I just stumbled upon this when actually following the breadcrumbs
from one to another manually.)

Jason

[PATCH v2] docs: ABI: correct QEMU fw_cfg spec path

[Jason A. Donenfeld]

A few weeks ago, QEMU switched docs/specs/fw_cfg.txt to be
docs/specs/fw_cfg.rst, so update the reference in the kernel docs to
reflect this. Also add a link to the online documentation to make it
easier to find.

Cc: Simon Sapin <simon.sapin@exyr.org>
Cc: Gabriel Somlo <somlo@cmu.edu>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
---
 Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg b/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
index ee0d6dbc810e..54d1bfd0db12 100644
--- a/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
+++ b/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
@@ -12,8 +12,9 @@ Description:
 		configuration data to the guest userspace.
 
 		The authoritative guest-side hardware interface documentation
-		to the fw_cfg device can be found in "docs/specs/fw_cfg.txt"
-		in the QEMU source tree.
+		to the fw_cfg device can be found in "docs/specs/fw_cfg.rst"
+		in the QEMU source tree, or online at:
+		https://qemu-project.gitlab.io/qemu/specs/fw_cfg.html
 
 		**SysFS fw_cfg Interface**
 
-- 
2.35.1

Re: [PATCH v2] docs: ABI: correct QEMU fw_cfg spec path

[Jonathan Corbet]

"Jason A. Donenfeld" <Jason@zx2c4.com> writes:

> A few weeks ago, QEMU switched docs/specs/fw_cfg.txt to be
> docs/specs/fw_cfg.rst, so update the reference in the kernel docs to
> reflect this. Also add a link to the online documentation to make it
> easier to find.
>
> Cc: Simon Sapin <simon.sapin@exyr.org>
> Cc: Gabriel Somlo <somlo@cmu.edu>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
> ---
>  Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg b/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
> index ee0d6dbc810e..54d1bfd0db12 100644
> --- a/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
> +++ b/Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg
> @@ -12,8 +12,9 @@ Description:
>  		configuration data to the guest userspace.
>  
>  		The authoritative guest-side hardware interface documentation
> -		to the fw_cfg device can be found in "docs/specs/fw_cfg.txt"
> -		in the QEMU source tree.
> +		to the fw_cfg device can be found in "docs/specs/fw_cfg.rst"
> +		in the QEMU source tree, or online at:
> +		https://qemu-project.gitlab.io/qemu/specs/fw_cfg.html
>  

Applied, thanks.

jon