dolfin team mailing list archive

[Anders Logg <logg@xxxxxxxxx>]

On Wed, Nov 16, 2011 at 02:16:12PM +0000, Garth N. Wells wrote:
> On 16 November 2011 13:13, Anders Logg <logg@xxxxxxxxx> wrote:
> > On Wed, Nov 16, 2011 at 01:06:41PM +0000, Garth N. Wells wrote:
> >> On 16 November 2011 12:12, Anders Logg <logg@xxxxxxxxx> wrote:
> >> > On Wed, Nov 16, 2011 at 01:04:54PM +0100, Anders Logg wrote:
> >> >> On Wed, Nov 16, 2011 at 10:10:38AM +0000, Garth N. Wells wrote:
> >> >> > I get
> >> >> >
> >> >> > [100%] Built target dolfin
> >> >> > [100%] Swig source
> >> >> > /home/garth/code/fenics/dolfin.d/1.0.d/working/dolfin/swig/docstrings.i:3081:
> >> >> > Error: Syntax error in input(1).
> >> >> > make[2]: *** [dolfin/swig/dolfinPYTHON_wrap.cxx] Error 1
> >> >> > make[1]: *** [dolfin/swig/CMakeFiles/_cpp.dir/all] Error 2
> >> >> >
> >> >> > How was this not picked up by a local build?
> >> >>
> >> >> Strange, my branch builds fine here and so does my buildbot:
> >> >>
> >> >> http://fenicsproject.org:8082/
> >> >>
> >> >> Could it be a merge problem from when Johan merged his changes?
> >> >
> >> > The problem was that Johan ran generate.py to regenerate the
> >> > docstrings and I didn't so the problem never showed up for me or on my
> >> > buildbot which does not have that changeset.
> >> >
> >> > When should we run generate.py?
> >>
> >> It should be run when a header file is added or a doc string changes.
> >> Adding functions or changing function signatures doesn't require
> >> generate.py to be run.
> >
> > Why not? The function signature will be part of the online
> > documentation and if a new function is added, then the corresponding
> > docstring must be generated.
> >
>
> I quote from my email:
>
>  "or a doc string changes."
>
> The addition of a doc string is a change.

I quote from your email:

  "changing function signatures doesn't require generate.py to be run"

Yes it does since it calls the .rst doc generator which uses the
signature.

So basically every time we touch a .h file we need to run generate.py.

--
Anders