| Summary: | doxygen_to_devhelp: should produce index format v2 | ||
|---|---|---|---|
| Product: | dbus | Reporter: | Simon McVittie <smcv> |
| Component: | core | Assignee: | Simon McVittie <smcv> |
| Status: | RESOLVED FIXED | QA Contact: | D-Bus Maintainers <dbus> |
| Severity: | minor | ||
| Priority: | medium | Keywords: | patch |
| Version: | git master | ||
| Hardware: | Other | ||
| OS: | All | ||
| Whiteboard: | review+ | ||
| i915 platform: | i915 features: | ||
| Attachments: |
[1/2] doxygen_to_devhelp: Make the API reference the front page
[2/2] doxygen_to_devhelp: Produce Devhelp index format v2 |
||
|
Description
Simon McVittie
2018-04-23 10:34:22 UTC
Created attachment 138995 [details] [review] [1/2] doxygen_to_devhelp: Make the API reference the front page Created attachment 138996 [details] [review] [2/2] doxygen_to_devhelp: Produce Devhelp index format v2 The old version-1 format is deprecated and now produces warnings. Comment on attachment 138995 [details] [review] [1/2] doxygen_to_devhelp: Make the API reference the front page Review of attachment 138995 [details] [review]: ----------------------------------------------------------------- Sure, r+. Do you want to put some rationale in the commit message? Comment on attachment 138996 [details] [review] [2/2] doxygen_to_devhelp: Produce Devhelp index format v2 Review of attachment 138996 [details] [review]: ----------------------------------------------------------------- r+. You might want to add dbus.devhelp2 to doc/.gitignore too, though, since the old file is in there. The XSL changes seem reasonable, but I can’t find a useful reference for either v1 or v2 of the format, so I can’t verify the XSL changes are correct or complete. (In reply to Philip Withnall from comment #3) > Sure, r+. Do you want to put some rationale in the commit message? I added: The tutorial is not necessarily a great entry point for the libdbus documentation: it's infrequently updated, and we should probably have the "If you use this low-level API directly, you're signing up for some pain" message from the API reference show up in devhelp more immediately. (In reply to Philip Withnall from comment #4) > You might want to add dbus.devhelp2 to doc/.gitignore too Done > The XSL changes seem reasonable, but I can’t find a useful reference for > either v1 or v2 of the format, so I can’t verify the XSL changes are correct > or complete. It resembles GStreamer's gtk-doc-generated index and no longer provokes warnings in devhelp - good enough! :-) Fixed in git for 1.12.8 and 1.13.4. |
Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.