-
Notifications
You must be signed in to change notification settings - Fork 141
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Request: in identifier search, mark where the kernel-doc is #78
Comments
Hi. |
Michael, thanks! In case I get some time to work on this, could you give me any initial thoughts as to which files might need to change, or where I might start? |
Hi Chris, The way Elixir is architectured doesn't make things very easy... Here's a rough description of how it could be implemented
So, that's not trivial, but of course doable. Don't hesitate to propose a simpler idea :) |
I have a rough cut working! Not yet tested, and definitely not yet cleaned up for a PR :) . https://github.com/cxw42/elixir/tree/local-server |
Hi Chris, |
Hi Chris (@cxw42) FYI, https://elixir.bootlin.com now is running with a freshly generated database with documentation information. Switching to a web front-end exposing such information will just take minutes ;-) Michael |
I was thinking just yesterday that I had better get my PR in for the front end now that Maxime is on the job :) . |
I have a branch going with an initial test framework for web.py. I'm doing TDD on this one :) . |
I have added tests of the doc-comment front end and cxw42@29ce0f0 passes the tests! @MaximeChretien would you please give it a try and let me know how it goes? I will squash before submitting the PR. Thanks! |
Hi @cxw42 I merged it on top of #130 , everything seems to work fine for me, both tests and web interface work without problems. But I noticed some things :
Maybe it would be great to add that ? What do you think @michaelopdenacker ?
I'll continue to do some tests and I'll tell you if I find something else ;) |
Much appreciated! I'll try out those cases. My original thought was to detect all kernel-doc, not just functions, but maybe I missed something. |
After commenting above, I looked at #130 and I see that it switches from exuberant to universal ctags. It may be that the ctags-output parser in find-file-doc-comments.pl needs some updates to be able to accept universal's output. I will investigate. |
- Generate "Documented in" HTML - resolve path to __file__: web.py finds its template directory with respect to __file__. If __file__ is a symlink, resolve it. This lets web.py work in a t/interact.pl session.
Nope --- it's just that find-file-doc-comments.pl only extracts function docs! Would you like to do the current release with just functions, then add the rest later? |
Hi, |
- Generate "Documented in" HTML - resolve path to __file__: web.py finds its template directory with respect to __file__. If __file__ is a symlink, resolve it. This lets web.py work in a t/interact.pl session.
Per <bootlin#78 (comment)>. Copied from Linux 5.6, at <https://elixir.bootlin.com/linux/v5.6/source/include/linux/memblock.h>. This file is GPL-2.0-or-later.
Thank you for this tool, which is incredibly useful!! I have a request. An example of the situation:
bus_find_device
are in the implementation file, drivers/base/bus.c.v4l2_ctrl_query_fill
are in the header file, include/media/v4l2-common.h.From the search results for an identifier, I am not able to tell which result has the kernel-doc comments. Therefore, I have to find the comments by trial and error between the header and implementation file(s).
Would it be possible for elixir to mark the location of the kernel-doc comments in the
ident/foo
search results? E.g., what if the results looked like this?---(with the "(doc)" link pointing to the first line of the doc comments)
Thank you for considering this request!
The text was updated successfully, but these errors were encountered: