[ovs-dev] [PATCH] ovs-actions: Convert man page from xml to rST.

[Ilya Maximets]

On 8/9/21 9:07 AM, Roi Dayan wrote:
> 
> 
> On 2021-08-07 2:54 AM, Ilya Maximets wrote:
>> This way it's easier to show it on a website as it will be updated
>> automatically along with the rest of the documentation.
>>
>> Sphinx doesn't render everything perfectly, but it looks good enough
>> in both man and html versions.  rST is a bit easier to read and it
>> takes less space.
>>
>> Conversion performed manually since I didn't found any good tool
>> that can actually make the process any faster.
>>
>> Along the way I replaced versions like x.y.90 with x.y+1, because
>> it doesn't seem correct to me to refer non-released versions of OVS
>> in the docs.  Fixed a couple of small mistakes like duplicated
>> paragraph and reference to a different section by incorrect name.
>> Also removed bits of xml->nroff conversion code that is not needed
>> anymore.
>>
>> Signed-off-by: Ilya Maximets <i.maximets at ovn.org>
>> ---
>>
>> Checkpatch emits a warning about new doc not being added to
>> Documentation/automake.mk, but that's a false-positive.
>>
>>   Documentation/automake.mk           |    1 +
>>   Documentation/conf.py               |    4 +-
>>   Documentation/ref/index.rst         |    5 +-
>>   Documentation/ref/ovs-actions.7.rst | 2332 +++++++++++++++++++
>>   build-aux/extract-ofp-actions       |  136 +-
>>   lib/automake.mk                     |    9 -
>>   lib/ovs-actions.xml                 | 3277 ---------------------------
>>   7 files changed, 2338 insertions(+), 3426 deletions(-)
>>   create mode 100644 Documentation/ref/ovs-actions.7.rst
>>   delete mode 100644 lib/ovs-actions.xml
>>
> 
> I tested the patch and generated man and html pages.
> as for the warning from the bot about ovs-actions.7 not in
> automake.mk, looks like an issue in checkpatch.py.
> 
> Acked-by: Roi Dayan <roid at nvidia.com>

Thanks!  Applied.

Best regards, Ilya Maximets.