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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <87bmvoihyk.fsf@intel.com>
Date:   Tue, 03 Jan 2017 11:57:39 +0200
From:   Jani Nikula <jani.nikula@...ux.intel.com>
To:     Paolo Bonzini <pbonzini@...hat.com>, linux-kernel@...r.kernel.org,
        linux-doc@...r.kernel.org
Cc:     corbet@....net
Subject: Re: [PATCH 0/5] kernel-doc tweaks and cleanup of rST vs. non-rST backends

On Mon, 02 Jan 2017, Paolo Bonzini <pbonzini@...hat.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@...el.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