GNOME Bugzilla – Bug 777745
Various distcheck fixes
Last modified: 2017-01-27 16:19:23 UTC
With these fixes `make distcheck` passes successfully. Just in time for you to do a 3.23.1 release (whenever you want)!
Created attachment 344224 [details] [review] build: Drop Makefile.decl in favour of glib-tap.mk We use glib-tap.mk for testing now; Makefile.decl is deprecated and was broken (`make test` did not work). It was also breaking `make distcheck`.
Created attachment 344225 [details] [review] docs: Add missing XML files to the top-level documentation file These were missed out when added to the documentation build earlier.
Created attachment 344227 [details] [review] docs: Change UNRELEASED ‘Since’ tags to 3.23.1 for the next release
Created attachment 344228 [details] [review] docs: Add a section overview for geocode-nominatim gtk-doc’s checks were fretting about it being missing.
Created attachment 344229 [details] [review] docs: Document some GEOCODE_TYPE_* macros Normally these don’t need to be documented, but gtk-doc wants documentation comments for these ones for some reason. This is probably a bug in how gtk-doc detects whether a symbol is interesting (potentially due to use of G_DECLARE_[DERIVABLE|FINAL]_TYPE?). Once it’s fixed in gtk-doc upstream, we can remove these documentation comments.
Created attachment 344230 [details] [review] docs: Ignore geocode-enum-types.h in the documentation It’s a generated file and there’s nothing documented in there, so it results in an empty page in the documentation.
Review of attachment 344224 [details] [review]: Is glib-tap.mk installed by the autogen.sh script? It's not in the patch
Review of attachment 344225 [details] [review]: Sure.
Review of attachment 344227 [details] [review]: ::: geocode-glib/geocode-bounding-box.c @@ +286,3 @@ * * Returns: %TRUE if the instances are equal, %FALSE otherwise + * Since: 3.23.1 Those are supposed to be stable version, so please use "3.24" instead.
Review of attachment 344228 [details] [review]: ::: geocode-glib/geocode-nominatim.c @@ +41,3 @@ + * [OSM Nominatim APIs](http://wiki.openstreetmap.org/wiki/Nominatim) exposed + * by a Nominatim server at a given URI. By default, the GNOME Nominatim server + * is used, but others may be configured. another one may be configured?
Review of attachment 344229 [details] [review]: ::: geocode-glib/geocode-backend.h @@ +48,3 @@ + * See #GeocodeBackend. + * + * Since: 3.23.1 Same thing about the version numbers.
Review of attachment 344230 [details] [review]: Yep.
(In reply to Bastien Nocera from comment #7) > Review of attachment 344224 [details] [review] [review]: > > Is glib-tap.mk installed by the autogen.sh script? It's not in the patch It’s been in git for a while: https://git.gnome.org/browse/geocode-glib/tree/glib-tap.mk (In reply to Bastien Nocera from comment #10) > Review of attachment 344228 [details] [review] [review]: > > ::: geocode-glib/geocode-nominatim.c > @@ +41,3 @@ > + * [OSM Nominatim APIs](http://wiki.openstreetmap.org/wiki/Nominatim) > exposed > + * by a Nominatim server at a given URI. By default, the GNOME Nominatim > server > + * is used, but others may be configured. > > another one may be configured? As many may be configured as you create instances of #GeocodeNominatim, right? (In reply to Bastien Nocera from comment #9) > Review of attachment 344227 [details] [review] [review]: > > ::: geocode-glib/geocode-bounding-box.c > @@ +286,3 @@ > * > * Returns: %TRUE if the instances are equal, %FALSE otherwise > + * Since: 3.23.1 > > Those are supposed to be stable version, so please use "3.24" instead. That’s not what the rest of the ‘Since’ tags I’ve added to geocode-glib recently do. I also think this is a pointless loss of accuracy: having the unstable version number in there is useful for development of reverse-dependent applications through that unstable cycle. 3.24 hasn’t been released yet: if we release 3.23.1 now, and then I go and write MyNewGeocodingApp, I’m going to have to dredge through geocode-glib’s commit history to find which 3.23.x release is actually meant by ‘3.24’.
(In reply to Philip Withnall from comment #13) > (In reply to Bastien Nocera from comment #7) > > Review of attachment 344224 [details] [review] [review] [review]: > > > > Is glib-tap.mk installed by the autogen.sh script? It's not in the patch > > It’s been in git for a while: > https://git.gnome.org/browse/geocode-glib/tree/glib-tap.mk Ok. > (In reply to Bastien Nocera from comment #10) > > Review of attachment 344228 [details] [review] [review] [review]: > > > > ::: geocode-glib/geocode-nominatim.c > > @@ +41,3 @@ > > + * [OSM Nominatim APIs](http://wiki.openstreetmap.org/wiki/Nominatim) > > exposed > > + * by a Nominatim server at a given URI. By default, the GNOME Nominatim > > server > > + * is used, but others may be configured. > > > > another one may be configured? > > As many may be configured as you create instances of #GeocodeNominatim, > right? It just makes me think that I can configure multiple servers for each instance. Maybe that's just me. > (In reply to Bastien Nocera from comment #9) > > Review of attachment 344227 [details] [review] [review] [review]: > > > > ::: geocode-glib/geocode-bounding-box.c > > @@ +286,3 @@ > > * > > * Returns: %TRUE if the instances are equal, %FALSE otherwise > > + * Since: 3.23.1 > > > > Those are supposed to be stable version, so please use "3.24" instead. > > That’s not what the rest of the ‘Since’ tags I’ve added to geocode-glib > recently do. I also think this is a pointless loss of accuracy: having the > unstable version number in there is useful for development of > reverse-dependent applications through that unstable cycle. 3.24 hasn’t been > released yet: if we release 3.23.1 now, and then I go and write > MyNewGeocodingApp, I’m going to have to dredge through geocode-glib’s commit > history to find which 3.23.x release is actually meant by ‘3.24’. Ok, fair enough.
(In reply to Bastien Nocera from comment #14) > > (In reply to Bastien Nocera from comment #10) > > > Review of attachment 344228 [details] [review] [review] [review] [review]: > > > > > > ::: geocode-glib/geocode-nominatim.c > > > @@ +41,3 @@ > > > + * [OSM Nominatim APIs](http://wiki.openstreetmap.org/wiki/Nominatim) > > > exposed > > > + * by a Nominatim server at a given URI. By default, the GNOME Nominatim > > > server > > > + * is used, but others may be configured. > > > > > > another one may be configured? > > > > As many may be configured as you create instances of #GeocodeNominatim, > > right? > > It just makes me think that I can configure multiple servers for each > instance. Maybe that's just me. How about “By default, the GNOME Nominatim server is used, but other server details may be given when constructing a #GeocodeNominatim.”?
Comment on attachment 344224 [details] [review] build: Drop Makefile.decl in favour of glib-tap.mk Accepting as per comment #14.
Comment on attachment 344227 [details] [review] docs: Change UNRELEASED ‘Since’ tags to 3.23.1 for the next release Accepting as per comment #14.
Comment on attachment 344229 [details] [review] docs: Document some GEOCODE_TYPE_* macros Accepting as per comment #14.
(In reply to Philip Withnall from comment #15) > (In reply to Bastien Nocera from comment #14) > > > (In reply to Bastien Nocera from comment #10) > > > > Review of attachment 344228 [details] [review] [review] [review] [review] [review]: > > > > > > > > ::: geocode-glib/geocode-nominatim.c > > > > @@ +41,3 @@ > > > > + * [OSM Nominatim APIs](http://wiki.openstreetmap.org/wiki/Nominatim) > > > > exposed > > > > + * by a Nominatim server at a given URI. By default, the GNOME Nominatim > > > > server > > > > + * is used, but others may be configured. > > > > > > > > another one may be configured? > > > > > > As many may be configured as you create instances of #GeocodeNominatim, > > > right? > > > > It just makes me think that I can configure multiple servers for each > > instance. Maybe that's just me. > > How about “By default, the GNOME Nominatim server is used, but other server > details may be given when constructing a #GeocodeNominatim.”? Sure, a bit better.
Pushed with that fix, thanks. Attachment 344224 [details] pushed as 305e168 - build: Drop Makefile.decl in favour of glib-tap.mk Attachment 344225 [details] pushed as 0cb8aaf - docs: Add missing XML files to the top-level documentation file Attachment 344227 [details] pushed as d02f56c - docs: Change UNRELEASED ‘Since’ tags to 3.23.1 for the next release Attachment 344228 [details] pushed as 7aaf923 - docs: Add a section overview for geocode-nominatim Attachment 344229 [details] pushed as 618b8c2 - docs: Document some GEOCODE_TYPE_* macros Attachment 344230 [details] pushed as 712def9 - docs: Ignore geocode-enum-types.h in the documentation