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

Groups > linux.kernel > #1549252 > unrolled thread

[PATCH 0/5] kernel-doc tweaks and cleanup of rST vs. non-rST backends

Back to article view | Back to linux.kernel

Contents

  [PATCH 0/5] kernel-doc tweaks and cleanup of rST vs. non-rST backends Paolo Bonzini <pbonzini@redhat.com> - 2017-01-02 16:30 +0100
    Re: [PATCH 0/5] kernel-doc tweaks and cleanup of rST vs. non-rST backends Jani Nikula <jani.nikula@linux.intel.com> - 2017-01-03 11:00 +0100

#1549252 — [PATCH 0/5] kernel-doc tweaks and cleanup of rST vs. non-rST backends

Hi,

these patches are the result of my experiments with using kernel-doc
for QEMU's documentation.  Patches 1 and 2 should be relatively
straightforward, as they are simple bugfixes.  Patches 3 to 5, instead,
are making the docbook backend (and the others too) more consistent with
the input and output of the rST backend.

I am not sure what is the state of the kernel-doc non-rST backends;
but there are still several books using the docbook workflow, so I'm
trying my luck and sending the patches anyway. :)

Paolo

Paolo Bonzini (5):
  kernel-doc: cleanup parameter type in function-typed arguments
  kernel-doc: strip attributes even if they have an argument
  kernel-doc: include parameter type in docbook output
  kernel-doc: make member highlighting available in all backends
  kernel-doc: make highlights more homogenous for the various backends

 scripts/kernel-doc | 99 ++++++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 74 insertions(+), 25 deletions(-)

-- 
2.9.3

[toc] | [next] | [standalone]

#1549658

On Mon, 02 Jan 2017, Paolo Bonzini <pbonzini@redhat.com> wrote:
> Hi,
>
> these patches are the result of my experiments with using kernel-doc
> for QEMU's documentation.  Patches 1 and 2 should be relatively
> straightforward, as they are simple bugfixes.  Patches 3 to 5, instead,
> are making the docbook backend (and the others too) more consistent with
> the input and output of the rST backend.

I did not test the patches, and for sure I will not attempt reviewing
perl, but at a high level the changes seem sensible.

Acked-by: Jani Nikula <jani.nikula@intel.com>

> I am not sure what is the state of the kernel-doc non-rST backends;
> but there are still several books using the docbook workflow, so I'm
> trying my luck and sending the patches anyway. :)

Obviously reStructuredText is the main output now and has to work, and
DocBook is still used as you say, but hopefully you sneaked in
regressions for the other formats so we can gauge if anyone cares! ;)

BR,
Jani.


>
> Paolo
>
> Paolo Bonzini (5):
>   kernel-doc: cleanup parameter type in function-typed arguments
>   kernel-doc: strip attributes even if they have an argument
>   kernel-doc: include parameter type in docbook output
>   kernel-doc: make member highlighting available in all backends
>   kernel-doc: make highlights more homogenous for the various backends
>
>  scripts/kernel-doc | 99 ++++++++++++++++++++++++++++++++++++++++--------------
>  1 file changed, 74 insertions(+), 25 deletions(-)

-- 
Jani Nikula, Intel Open Source Technology Center

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web