Re: [net-next 07/16] net/mlx5: DR, Add support for dumping steering info

Re: [net-next 07/16] net/mlx5: DR, Add support for dumping steering info

[Jakub Kicinski]

On Fri, 31 Dec 2021 01:49:54 +0000 Yevgeny Kliteynik wrote:
> Actually, this was written based on debugfs functions documentation, where
> it states that "if an error occurs, NULL will be returned"
> 
> https://www.kernel.org/doc/htmldocs/filesystems/API-debugfs-create-dir.html
> 
> Looking at the code, I see that it's no longer the case.

Oh, I see. That looks like some old, out of date version of the docs.
The text was already correct in 5.15, it seems:

https://elixir.bootlin.com/linux/v5.15/source/fs/debugfs/inode.c#L549

Also this render of the docs is correct:

https://www.kernel.org/doc/html/latest/filesystems/api-summary.html#c.debugfs_create_dir

I don't really know who's responsible for the kernel.org docs... 
Let's CC Jon.

Jon, is the www.kernel.org/doc/htmldocs/ copy intentionally what it is?
Anyone we should talk to?

RE: [net-next 07/16] net/mlx5: DR, Add support for dumping steering info

[Yevgeny Kliteynik]

> From: Jakub Kicinski <kuba@kernel.org>
> Sent: Friday, December 31, 2021 04:10
>
> On Fri, 31 Dec 2021 01:49:54 +0000 Yevgeny Kliteynik wrote:
> > Actually, this was written based on debugfs functions documentation, 
> > where it states that "if an error occurs, NULL will be returned"
> >
> > https://www.kernel.org/doc/htmldocs/filesystems/API-debugfs-create-dir.html
> >
> > Looking at the code, I see that it's no longer the case.
> 
> Oh, I see. That looks like some old, out of date version of the docs.
> The text was already correct in 5.15, it seems:
> 
> https://elixir.bootlin.com/linux/v5.15/source/fs/debugfs/inode.c#L549
> 
> Also this render of the docs is correct:
> 
> https://www.kernel.org/doc/html/latest/filesystems/api-summary.html#c.debugfs_create_dir
 
The thing is, www.kernel.org/doc/htmldocs/ is the first and the only
doc link that I see when googling some debugfs functions.
Bing shows this as the first link, and the updated documentation
as the second link.

www.kernel.org/doc/htmldocs/index.html shows that this was generated
for kernel 4.12.0. So yes, it is very dated, but for some reason search
engines rank it highest. It's possible that debugfs is not the only case
with this problem.

-- YK

> I don't really know who's responsible for the kernel.org docs...
> Let's CC Jon.
> 
> Jon, is the www.kernel.org/doc/htmldocs/ copy intentionally what it is?
> Anyone we should talk to?