[ovs-dev] [PATCH v2 4/5] make: Ensure flake8, sphinx run when required

Stephen Finucane stephen at that.guru
Wed Jan 4 16:25:40 UTC 2017


On Wed, 2017-01-04 at 08:20 -0800, Ben Pfaff wrote:
> On Mon, Jan 02, 2017 at 11:47:41AM +0000, Stephen Finucane wrote:
> > If someone makes changes to documentation or Python scripts, they
> > should
> > validate these changes using the relevant targets. However, said
> > targets
> > use optional dependencies and are not guaranteed to be enabled.
> > Enforce
> > running of these checks whenever changes are made to select files,
> > ensuring the user has installed the changes.
> > 
> > Signed-off-by: Stephen Finucane <stephen at that.guru>
> 
> This always fails for me, because I don't have a branch named
> "master".
> (I also don't have a remote named "origin".)
> 
> Also, once we branch for 2.7, "master" will not always be the correct
> branch to check.
>
> I like the idea here, but I don't think that this implementation is
> quite right, and it seems like it's hard to get right in general.  I
> don't have a good suggestion about how to make it better.
> 
> For check-docs in particular, it seems reasonable to always just say
> that the docs can't be checked, if sphinx is not installed.

That's fair - this should probably have been an RFC as it is certainly
a little...hacky. Feel free to drop from the series.

As an alternative approach, I wonder could we install Sphinx in Travis
so that it will run 'check-docs' for us?

Stephen 


More information about the dev mailing list