Re: [PATCH v2] scripts/kernel-doc: Adding cross-reference links to html documentation.

From: Danilo Cesar Lemes de Paula
Date: Mon Jul 13 2015 - 16:19:56 EST


On 07/09/2015 08:56 PM, Jonathan Corbet wrote:
> On Fri, 26 Jun 2015 12:08:57 -0300
> Danilo Cesar Lemes de Paula <danilo.cesar@xxxxxxxxxxxxxxx> wrote:
>
>> To ease the navigation in the documentation we should use <links> inside
>> those tags so readers can easily jump between methods directly.
>>
>> This was discussed in 2014[1] and is implemented by getting a list
>> of <refentries> from the DocBook XML to generate a database. Then it looks
>> for <function>,<structnames> and <paramdef> tags that matches the ones in
>> the database. As it only links existent references, no broken links are
>> added.
>
> So I put a lot more time into this today than I really had available. I

Thanks, I really appreciate that.

> think it's cool stuff, and we definitely want it. But can I ask for one
> more pass? In particular:
>
> - It makes the docs build a lot more noisy, that would be nice to fix.

Fair enough. It was showing all the commands. I did change that to a
fancy "XMLREF Documentation/DocBook/FooBar.xml" message.

>
> - A bit more documentation in the script would be nice. It also is happy
> to run with silly arguments; a detail since nobody will run it
> directly, but still...

I did improve the documentation and also fixed the silly argument thing.

>
> - Most importantly, it breaks "make htmldocs"; in particular, vast
> amounts of error spew results when it gets around to media_api.html. I
> spent a while trying to figure out what was going on but didn't come up
> with anything conclusive; my suspicion is that it has to do with the
> separate makefile in Documentation/DocBook/media/.

I'm not sure about this.
media-api is spitting lots of warnings with or without the documentation
patch.
I compared the number of files and they're the same (excepting those
auxiliary db files). For me, both builds actually spits 2825 lines on
STDERR...

I also did a smoke check in the media-api html documentation and it
looks fine.

Would you mind to check again if it happens with the v3 of my patch I'm
sending next?

Danilo
>
> Thanks,
>
> jon
>
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/