[ovs-dev] [patch_v1] doc: Support building ovs with Trusty.

[Darrell Ball]

On 3/7/17, 3:03 PM, "ovs-dev-bounces at openvswitch.org on behalf of Ben Pfaff" <ovs-dev-bounces at openvswitch.org on behalf of blp at ovn.org> wrote:

    On Thu, Mar 02, 2017 at 08:01:42PM -0800, Darrell Ball wrote:
    > Some code-block directives are not understood using
    > Trusty (I was using 14.04.1 when the issue was found)
    > default package versions, which blocks the build.
    > 
    > An error example:
    > writing output... [100%] topics/language-bindings
    > Warning, treated as error:
    > /home/dball/ovs/Documentation/topics/language-bindings.rst:39:
    > WARNING: Pygments lexer name u'shell' is not known
    > 
    > 14.04.1 has Sphinx 1.2.2 and Pygments 1.6.
    > 
    > I expect Trusty to still be widely used, so we
    > should be able to build ovs with it.
    > 
    > requirements.rst indicates only:
    > sphinx>=1.2,<2.0
    > ovs_sphinx_theme>=1.0,<1.1
    > 
    > Fixes: f150a8bafbf2 ("doc: Document various language bindings")
    > Suggested-by: Daniele Di Proietto <diproiettod at vmware.com>
    > Signed-off-by: Darrell Ball <dlu998 at gmail.com>
    > CC: Stephen Finucane <stephen at that.guru>
    
    I was pointed to apply this but it adds an error for me:
    
        /home/blp/nicira/ovs/Documentation/intro/install/windows.rst:585: WARNING: Could not lex literal_block as "ps1". Highlighting skipped.
    
    I'm using Sphinx 1.4.9.

yikes
That is coming from Pygments, afaik.
That seems to imply new versions of Pygments are not backward compatible;
ps1 lexer worked with sphinx 1.3.6 and 1.2.2.

Maybe we can use a safe legacy lexer specification like “bat” in these cases. The
highlighting is very similar with “bat” and one would hope “bat” should
remain backward compatible for an extended timeframe.
It is more important that the build always works, rather than trying to achieve
slight differences in highlighting for different code/script types.

Does that seem reasonable ?
Does “bat” work in your environment ?


    _______________________________________________
    dev mailing list
    dev at openvswitch.org
    https://urldefense.proofpoint.com/v2/url?u=https-3A__mail.openvswitch.org_mailman_listinfo_ovs-2Ddev&d=DwICAg&c=uilaK90D4TOVoH58JNXRgQ&r=BVhFA09CGX7JQ5Ih-uZnsw&m=ivjgO8tI5Ru_nAC0gnDJYjgmSGcJlgrOvps6ra4rEDw&s=mTP9O7IELdpPzUvrKhBrBFrjv96XVW76WVkHGtMYFNU&e=