Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1413696 > unrolled thread

[PATCH v2 00/38] Documentation/sphinx

Started byJani Nikula <jani.nikula@intel.com>
First post2016-06-04 13:40 +0200
Last post2016-06-10 22:50 +0200
Articles 3 on this page of 43 — 5 participants

Back to article view | Back to linux.kernel

Contents

  [PATCH v2 00/38] Documentation/sphinx Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:40 +0200
    [PATCH v2 10/38] Documentation/sphinx: nicer referencing of struct in docbook->rst conversion Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:40 +0200
    [PATCH v2 01/38] kernel-doc/rst: fix use of uninitialized value Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:40 +0200
    [PATCH v2 13/38] kernel-doc/rst: do not output DOC: section titles for requested ones Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:40 +0200
    [PATCH v2 14/38] kernel-doc/rst: reference functions according to C domain spec Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:40 +0200
    [PATCH v2 08/38] sphinx: cheesy script to convert .tmpl files Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:40 +0200
    [PATCH v2 02/38] kernel-doc: support printing exported and non-exported symbols Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:40 +0200
    [PATCH v2 12/38] kernel-doc: add names for output selection Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:40 +0200
    [PATCH v2 15/38] kernel-doc/rst: &foo references are more universal than structs Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:40 +0200
    [PATCH v2 05/38] Documentation/sphinx: add Sphinx kernel-doc directive extension Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:40 +0200
    [PATCH v2 03/38] Documentation/sphinx: add basic working Sphinx configuration and build Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:40 +0200
    [PATCH v2 28/38] kernel-doc/rst: remove fixme comment Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 24/38] kernel-doc/rst: change the output layout Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 22/38] kernel-doc/rst: blank lines in output are not needed Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 37/38] scripts/kernel-doc: Add option to inject line numbers Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 07/38] Documentation/sphinx: set version and release properly Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 32/38] Documentation/sphinx: fix kernel-doc extension on python3 Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 06/38] Documentation/sphinx: configure the kernel-doc extension Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 20/38] kernel-doc: do not regard $, %, or & prefixes as special in section names Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 19/38] kernel-doc/rst: highlight function/struct/enum purpose lines too Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 23/38] kernel-doc: strip leading blank lines from inline doc comments Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 26/38] kernel-doc: strip leading whitespace from continued param descs Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 38/38] doc/sphinx: Track line-number of starting blocks Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 17/38] kernel-doc/rst: add support for struct/union/enum member references Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 31/38] kernel-doc: reset contents and section harder Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 30/38] kernel-doc: concatenate contents of colliding sections Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 29/38] kernel-doc: limit the "section header:" detection to a select few Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
      Re: [PATCH v2 29/38] kernel-doc: limit the "section header:"  detection to a select few Jonathan Corbet <corbet@lwn.net> - 2016-06-09 17:10 +0200
        Re: [PATCH v2 29/38] kernel-doc: limit the "section header:" detection to a select few Jani Nikula <jani.nikula@intel.com> - 2016-06-09 18:50 +0200
    [PATCH v2 36/38] scripts/kernel-doc: Also give functions symbolic names Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 21/38] kernel-doc: fix wrong code indentation Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 34/38] scripts/kernel-doc: Remove duplicated DOC: start handling Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 18/38] kernel-doc/rst: drop redundant unescape in highlighting Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 33/38] doc/sphinx: Pass right filename as source Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 16/38] kernel-doc/rst: add support for &union foo and &typedef foo references Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 25/38] kernel-doc: improve handling of whitespace on the first line param description Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 35/38] doc/sphinx: Stop touching state_machine internals Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 27/38] kernel-doc/rst: use *undescribed* instead of _undescribed_ Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    [PATCH v2 09/38] sphinx: update docbook->rst conversion script match C domain spec Jani Nikula <jani.nikula@intel.com> - 2016-06-04 13:50 +0200
    Re: [PATCH v2 00/38] Documentation/sphinx Daniel Vetter <daniel@ffwll.ch> - 2016-06-04 14:20 +0200
    Re: [PATCH v2 00/38] Documentation/sphinx Jonathan Corbet <corbet@lwn.net> - 2016-06-09 22:00 +0200
      Re: [PATCH v2 00/38] Documentation/sphinx Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-06-10 20:20 +0200
        Re: [PATCH v2 00/38] Documentation/sphinx Dave Airlie <airlied@gmail.com> - 2016-06-10 22:50 +0200

Page 3 of 3 — ← Prev page 1 2 [3]

#1418612

FromJonathan Corbet <corbet@lwn.net>
Date2016-06-09 22:00 +0200
Message-ID<rIehs-2sV-15@gated-at.bofh.it>
In reply to#1413696
On Sat,  4 Jun 2016 14:37:01 +0300
Jani Nikula <jani.nikula@intel.com> wrote:

> When this lands in docs-next and we can backmerge to drm, we'll plunge
> ahead and convert gpu.tmpl to rst, and have that ready for v4.8.

That is now done — thanks for running with this!  I'm looking forward to
seeing where we can take it from here.

One little thing: there's a bunch of new warnings in the htmldocs build:

.//include/net/mac80211.h:671: warning: duplicate section name 'Description'
.//include/net/mac80211.h:3174: warning: duplicate section name 'Description'

Some quick messing around suggests that it happens when a kerneldoc entry
has free text both above and below the parameter list; there aren't many
such places.  I can send in a patch for mac80211.h to silence most of it,
but it might be nice if it worked as before without whining.

Thanks,

jon

[toc] | [prev] | [next] | [standalone]

#1419650

FromDaniel Vetter <daniel.vetter@ffwll.ch>
Date2016-06-10 20:20 +0200
Message-ID<rIzce-86w-9@gated-at.bofh.it>
In reply to#1418612
On Thu, Jun 9, 2016 at 9:55 PM, Jonathan Corbet <corbet@lwn.net> wrote:
> On Sat,  4 Jun 2016 14:37:01 +0300
> Jani Nikula <jani.nikula@intel.com> wrote:
>
>> When this lands in docs-next and we can backmerge to drm, we'll plunge
>> ahead and convert gpu.tmpl to rst, and have that ready for v4.8.
>
> That is now done — thanks for running with this!  I'm looking forward to
> seeing where we can take it from here.
>
> One little thing: there's a bunch of new warnings in the htmldocs build:
>
> .//include/net/mac80211.h:671: warning: duplicate section name 'Description'
> .//include/net/mac80211.h:3174: warning: duplicate section name 'Description'
>
> Some quick messing around suggests that it happens when a kerneldoc entry
> has free text both above and below the parameter list; there aren't many
> such places.  I can send in a patch for mac80211.h to silence most of it,
> but it might be nice if it worked as before without whining.

Awesome, Jani's patches landed in drm-next. As discussed I'd like to
merge this into drm-misc, to be able to synchronize the gpu.tmpl->rst
conversion with ongoing drm work. Can I just pull your branch, or do
you want me to pull a special tag? With that I can start wreaking
havoc ;-)

Also we need to coordinate the merge window order. I think as long as
I only pull from your tree for the 4.8 cycle (there shouldn't be any
conflicts in the conversion itself, as long as we only touch gpu.rst
in drm-misc) that would work if drm-next lands after doc-next.

Dave, would that be ok with you too?

Thanks, Daniel
-- 
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch

[toc] | [prev] | [next] | [standalone]

#1419717

FromDave Airlie <airlied@gmail.com>
Date2016-06-10 22:50 +0200
Message-ID<rIBxo-1rC-27@gated-at.bofh.it>
In reply to#1419650
On 11 June 2016 at 04:17, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> On Thu, Jun 9, 2016 at 9:55 PM, Jonathan Corbet <corbet@lwn.net> wrote:
>> On Sat,  4 Jun 2016 14:37:01 +0300
>> Jani Nikula <jani.nikula@intel.com> wrote:
>>
>>> When this lands in docs-next and we can backmerge to drm, we'll plunge
>>> ahead and convert gpu.tmpl to rst, and have that ready for v4.8.
>>
>> That is now done — thanks for running with this!  I'm looking forward to
>> seeing where we can take it from here.
>>
>> One little thing: there's a bunch of new warnings in the htmldocs build:
>>
>> .//include/net/mac80211.h:671: warning: duplicate section name 'Description'
>> .//include/net/mac80211.h:3174: warning: duplicate section name 'Description'
>>
>> Some quick messing around suggests that it happens when a kerneldoc entry
>> has free text both above and below the parameter list; there aren't many
>> such places.  I can send in a patch for mac80211.h to silence most of it,
>> but it might be nice if it worked as before without whining.
>
> Awesome, Jani's patches landed in drm-next. As discussed I'd like to
> merge this into drm-misc, to be able to synchronize the gpu.tmpl->rst
> conversion with ongoing drm work. Can I just pull your branch, or do
> you want me to pull a special tag? With that I can start wreaking
> havoc ;-)
>
> Also we need to coordinate the merge window order. I think as long as
> I only pull from your tree for the 4.8 cycle (there shouldn't be any
> conflicts in the conversion itself, as long as we only touch gpu.rst
> in drm-misc) that would work if drm-next lands after doc-next.
>
> Dave, would that be ok with you too?

It would be best if Jon can give us a known tag that won't get rebased,
and will end up in docs-next and drm-next, then we can arranage for docs-next
to get merged early and drm-next should be less trouble.

I'm happy to merge that stable branch via drm-misc.

Dave.

[toc] | [prev] | [standalone]

Page 3 of 3 — ← Prev page 1 2 [3]

Back to top | Article view | linux.kernel

csiph-web