Skip to contentSkip to conversation

docs: ABI: correct QEMU fw_cfg spec path

PATCH Superseded Jason A. Donenfeld 2 participants 5 messages Jul 20, 2022 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: ABI: correct QEMU fw_cfg spec path

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 <[email protected]>
Cc Gabriel Somlo <[email protected]>
Cc Jonathan Corbet <[email protected]>
---
 Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg +1 -1
index ee0d6dbc810e..7cbce4af6346 100644
@@ -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**
Signature · 1 line
2.35.1
maintainer
#1 lore raw
Quoted 17 lines · 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 <[email protected]>
Cc Gabriel Somlo <[email protected]>
Cc Jonathan Corbet <[email protected]>
---
 Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg +0 -0
index ee0d6dbc810e..7cbce4af6346 100644

Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg Description: · line 16

Quoted 6 lines
Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg +1 -1
@@ -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

#2 lore raw

Hi Jon,

Quoted 22 lines · Jonathan Corbet
Quoted 19 lines · 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 <[email protected]>
Cc Gabriel Somlo <[email protected]>
Cc Jonathan Corbet <[email protected]>
---
 Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg +0 -0
index ee0d6dbc810e..7cbce4af6346 100644
@@ -12,7 +12,7 @@ Description:
              configuration data to the guest userspace.
 
Quoted 8 lines

Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg Description: · line 16

Quoted 4 lines
Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg +1 -1
              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

#3 lore raw

PATCH v2 1/1 docs: ABI: correct QEMU fw_cfg spec path

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 <[email protected]>
Cc Gabriel Somlo <[email protected]>
Cc Jonathan Corbet <[email protected]>
---
 Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg +3 -2
index ee0d6dbc810e..54d1bfd0db12 100644
@@ -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**
 
Signature · 1 line
2.35.1
maintainer Applied
#4 lore raw
Quoted 18 lines · 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 <[email protected]>
Cc Gabriel Somlo <[email protected]>
Cc Jonathan Corbet <[email protected]>
---
 Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg +0 -0
index ee0d6dbc810e..54d1bfd0db12 100644

Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg Description: · line 18

Quoted 9 lines
Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg +3 -2
@@ -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