* [PATCH] docs: accel: Fix debugfs path
@ 2023-01-19 16:26 ` Jeffrey Hugo
0 siblings, 0 replies; 7+ messages in thread
From: Jeffrey Hugo @ 2023-01-19 16:26 UTC (permalink / raw)
To: ogabbay, corbet; +Cc: Jeffrey Hugo, linux-kernel, dri-devel, linux-doc
The device specific directory in debugfs does not have "accel". For
example, the documentation says device 0 should have a debugfs entry as
/sys/kernel/debug/accel/accel0/ but in reality the entry is
/sys/kernel/debug/accel/0/
Fix the documentation to match the implementation.
Fixes: 8c5577a5ccc6 ("doc: add documentation for accel subsystem")
Signed-off-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
---
Documentation/accel/introduction.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/accel/introduction.rst b/Documentation/accel/introduction.rst
index 6f31af1..11cade5 100644
--- a/Documentation/accel/introduction.rst
+++ b/Documentation/accel/introduction.rst
@@ -69,7 +69,7 @@ The accelerator devices will be exposed to the user space with the dedicated
- device char files - /dev/accel/accel*
- sysfs - /sys/class/accel/accel*/
-- debugfs - /sys/kernel/debug/accel/accel*/
+- debugfs - /sys/kernel/debug/accel/*/
Getting Started
===============
--
2.7.4
^ permalink raw reply related [flat|nested] 7+ messages in thread* Re: [PATCH] docs: accel: Fix debugfs path
2023-01-19 16:26 ` Jeffrey Hugo
@ 2023-01-19 16:28 ` Oded Gabbay
-1 siblings, 0 replies; 7+ messages in thread
From: Oded Gabbay @ 2023-01-19 16:28 UTC (permalink / raw)
To: Jeffrey Hugo; +Cc: corbet, dri-devel, linux-doc, linux-kernel
On Thu, Jan 19, 2023 at 6:26 PM Jeffrey Hugo <quic_jhugo@quicinc.com> wrote:
>
> The device specific directory in debugfs does not have "accel". For
> example, the documentation says device 0 should have a debugfs entry as
> /sys/kernel/debug/accel/accel0/ but in reality the entry is
> /sys/kernel/debug/accel/0/
>
> Fix the documentation to match the implementation.
>
> Fixes: 8c5577a5ccc6 ("doc: add documentation for accel subsystem")
> Signed-off-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
> ---
> Documentation/accel/introduction.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/accel/introduction.rst b/Documentation/accel/introduction.rst
> index 6f31af1..11cade5 100644
> --- a/Documentation/accel/introduction.rst
> +++ b/Documentation/accel/introduction.rst
> @@ -69,7 +69,7 @@ The accelerator devices will be exposed to the user space with the dedicated
>
> - device char files - /dev/accel/accel*
> - sysfs - /sys/class/accel/accel*/
> -- debugfs - /sys/kernel/debug/accel/accel*/
> +- debugfs - /sys/kernel/debug/accel/*/
>
> Getting Started
> ===============
> --
> 2.7.4
>
Reviewed-by: Oded Gabbay <ogabbay@kernel.org>
Thanks,
Oded
^ permalink raw reply [flat|nested] 7+ messages in thread* Re: [PATCH] docs: accel: Fix debugfs path
@ 2023-01-19 16:28 ` Oded Gabbay
0 siblings, 0 replies; 7+ messages in thread
From: Oded Gabbay @ 2023-01-19 16:28 UTC (permalink / raw)
To: Jeffrey Hugo; +Cc: linux-doc, linux-kernel, dri-devel, corbet
On Thu, Jan 19, 2023 at 6:26 PM Jeffrey Hugo <quic_jhugo@quicinc.com> wrote:
>
> The device specific directory in debugfs does not have "accel". For
> example, the documentation says device 0 should have a debugfs entry as
> /sys/kernel/debug/accel/accel0/ but in reality the entry is
> /sys/kernel/debug/accel/0/
>
> Fix the documentation to match the implementation.
>
> Fixes: 8c5577a5ccc6 ("doc: add documentation for accel subsystem")
> Signed-off-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
> ---
> Documentation/accel/introduction.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/accel/introduction.rst b/Documentation/accel/introduction.rst
> index 6f31af1..11cade5 100644
> --- a/Documentation/accel/introduction.rst
> +++ b/Documentation/accel/introduction.rst
> @@ -69,7 +69,7 @@ The accelerator devices will be exposed to the user space with the dedicated
>
> - device char files - /dev/accel/accel*
> - sysfs - /sys/class/accel/accel*/
> -- debugfs - /sys/kernel/debug/accel/accel*/
> +- debugfs - /sys/kernel/debug/accel/*/
>
> Getting Started
> ===============
> --
> 2.7.4
>
Reviewed-by: Oded Gabbay <ogabbay@kernel.org>
Thanks,
Oded
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH] docs: accel: Fix debugfs path
2023-01-19 16:26 ` Jeffrey Hugo
(?)
(?)
@ 2023-01-20 5:41 ` kernel test robot
-1 siblings, 0 replies; 7+ messages in thread
From: kernel test robot @ 2023-01-20 5:41 UTC (permalink / raw)
To: Jeffrey Hugo; +Cc: oe-kbuild-all
Hi Jeffrey,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on lwn/docs-next]
[also build test WARNING on linus/master v6.2-rc4]
[cannot apply to next-20230120]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Jeffrey-Hugo/docs-accel-Fix-debugfs-path/20230120-002706
base: git://git.lwn.net/linux.git docs-next
patch link: https://lore.kernel.org/r/1674145568-31513-1-git-send-email-quic_jhugo%40quicinc.com
patch subject: [PATCH] docs: accel: Fix debugfs path
reproduce:
# https://github.com/intel-lab-lkp/linux/commit/00ab1f89d5d2402717f79d2c6b7101f035aa1cf2
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Jeffrey-Hugo/docs-accel-Fix-debugfs-path/20230120-002706
git checkout 00ab1f89d5d2402717f79d2c6b7101f035aa1cf2
make menuconfig
# enable CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS
make htmldocs
If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <lkp@intel.com>
All warnings (new ones prefixed by >>):
>> Documentation/accel/introduction.rst:72: WARNING: Inline emphasis start-string without end-string.
vim +72 Documentation/accel/introduction.rst
69
70 - device char files - /dev/accel/accel*
71 - sysfs - /sys/class/accel/accel*/
> 72 - debugfs - /sys/kernel/debug/accel/*/
73
--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests
^ permalink raw reply [flat|nested] 7+ messages in thread* Re: [PATCH] docs: accel: Fix debugfs path
2023-01-19 16:26 ` Jeffrey Hugo
@ 2023-01-24 22:20 ` Jonathan Corbet
-1 siblings, 0 replies; 7+ messages in thread
From: Jonathan Corbet @ 2023-01-24 22:20 UTC (permalink / raw)
To: Jeffrey Hugo, ogabbay; +Cc: dri-devel, linux-doc, linux-kernel, Jeffrey Hugo
Jeffrey Hugo <quic_jhugo@quicinc.com> writes:
> The device specific directory in debugfs does not have "accel". For
> example, the documentation says device 0 should have a debugfs entry as
> /sys/kernel/debug/accel/accel0/ but in reality the entry is
> /sys/kernel/debug/accel/0/
>
> Fix the documentation to match the implementation.
>
> Fixes: 8c5577a5ccc6 ("doc: add documentation for accel subsystem")
> Signed-off-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
> ---
> Documentation/accel/introduction.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/accel/introduction.rst b/Documentation/accel/introduction.rst
> index 6f31af1..11cade5 100644
> --- a/Documentation/accel/introduction.rst
> +++ b/Documentation/accel/introduction.rst
> @@ -69,7 +69,7 @@ The accelerator devices will be exposed to the user space with the dedicated
>
> - device char files - /dev/accel/accel*
> - sysfs - /sys/class/accel/accel*/
> -- debugfs - /sys/kernel/debug/accel/accel*/
> +- debugfs - /sys/kernel/debug/accel/*/
>
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 7+ messages in thread* Re: [PATCH] docs: accel: Fix debugfs path
@ 2023-01-24 22:20 ` Jonathan Corbet
0 siblings, 0 replies; 7+ messages in thread
From: Jonathan Corbet @ 2023-01-24 22:20 UTC (permalink / raw)
To: Jeffrey Hugo, ogabbay; +Cc: Jeffrey Hugo, linux-kernel, dri-devel, linux-doc
Jeffrey Hugo <quic_jhugo@quicinc.com> writes:
> The device specific directory in debugfs does not have "accel". For
> example, the documentation says device 0 should have a debugfs entry as
> /sys/kernel/debug/accel/accel0/ but in reality the entry is
> /sys/kernel/debug/accel/0/
>
> Fix the documentation to match the implementation.
>
> Fixes: 8c5577a5ccc6 ("doc: add documentation for accel subsystem")
> Signed-off-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
> ---
> Documentation/accel/introduction.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/accel/introduction.rst b/Documentation/accel/introduction.rst
> index 6f31af1..11cade5 100644
> --- a/Documentation/accel/introduction.rst
> +++ b/Documentation/accel/introduction.rst
> @@ -69,7 +69,7 @@ The accelerator devices will be exposed to the user space with the dedicated
>
> - device char files - /dev/accel/accel*
> - sysfs - /sys/class/accel/accel*/
> -- debugfs - /sys/kernel/debug/accel/accel*/
> +- debugfs - /sys/kernel/debug/accel/*/
>
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 7+ messages in thread