The auto-generated sgml file has a role attribute for the api-index
entries.

gtkdoc-mkhtml does not understand the role attribute and skips the
generation of the api-index HTML files, which creates invalid links in
the final documentation.

Signed-off-by: Detlev Casanova <detlev.casanova@collabora.com>

gtk-doc won't let multiple docbook files be added to the main sgml file.
Merge them for simpler use.

Signed-off-by: Detlev Casanova <detlev.casanova@collabora.com>

This is necessary to allow the gtk-doc check to not fail.

The gtk-doc check is run at the check step to verify that everything is
documented. This is useful to avoid forgetting documentation when
modifying the code.

Signed-off-by: Detlev Casanova <detlev.casanova@collabora.com>

The documentation is parsed from the source files and converted to HTML
by gtk-doc.

Signed-off-by: Detlev Casanova <detlev.casanova@collabora.com>

Padiri Sivanandha Reddy authored 4 years ago and Ritesh Raj Sarraf committed 4 years ago

Rhosydd VSS implementation

VSS data model - review2 changes

When converting the D-Bus API to be autogenerated from XML, the signals were
left out.

When doing more strict checking, GCC will complain and fail the
compilation.

Signed-off-by: Simon McVittie <smcv@collabora.com>
Reviewed-by: Emanuele Aina <emanuele.aina@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D6640

Mathieu Duponchelle authored 8 years ago and Andrej Shadura committed 8 years ago

The following issue types were raised by hotdoc:

* Invalid plural links: hotdoc does not know how to pluralize
  symbols such as `#RsdSubscription`.

* Invalid inter-documentation links: hotdoc does not yet install
  symbol databases, links to other documentation symbols are only
  possible when the link target is documented by gtk-doc.

* Invalid function links, for example when referring to a
  user-provided `main()` function.

Signed-off-by: Mathieu Duponchelle <mathieu.duponchelle@opencreed.com>
Signed-off-by: Andrew Shadura <andrew.shadura@collabora.co.uk>
Reviewed-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D4490

+ Use the hotdoc autotools helpers

This requires using -Wno-portability in the call to AM_INIT_AUTOMAKE,
as discussed with Simon it's a reasonable requirement for using the
hotdoc.mk fragment Makefile.

The produced html is now cleanly installable and uninstallable.

+ Make documentation build parallel for croesor and rhosydd

The issue preventing this is fixed upstream, although in a
different manner than the linked github issue proposed.

+ Remove distribution of the generated documentation

Distributing build products in the source tarball is a bad practice,
and there's no compelling reason for doing this in Apertis libraries.

+ Use a sitemap

This means subpages do not need to be linked and updated in markdown
files.

+ Enable ‘smart index’

+ Enable devhelp books generation

+ Update the debian files

+ remove build-depends on hotdoc-dbus-extension, not sure why it
  was added in the first place.

Using this new feature of hotdoc means we no longer need to maintain
potentially huge lists of symbols in the markdown files.

As desired by Philip, we now pass the C sources to hotdoc in the
Makefile, which means the source list does not need updating.

However, combined with smart-index, this means every public symbol
is now exposed in the documentation.

Subsequent patches should filter out potentially undesirable files
or symbols, this requires more in-depth knowledge of the project
than I currently possess.

Signed-off-by: Mathieu Duponchelle <mathieu.duponchelle@opencreed.com>

Differential Revision: https://phabricator.apertis.org/D3784

Links to symbols use the following syntax: [](symbol-name), not
[symbol-name]().

Signed-off-by: Mathieu Duponchelle <mathieu.duponchelle@opencreed.com>

Differential Revision: https://phabricator.apertis.org/D3783

 • Replace UNRELEASED with 0.5.0 in documentation
 • Update symbols files to include all 0.5.0 symbols
 • Bump library SONAME, rename librhosydd package accordingly
 • libcroesor has not changed API at all
 • Update NEWS

Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>

Reviewed-by: Mathieu Duponchelle <mathieu.duponchelle@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3724

If any code is going to use this generically, it needs to be on the
interface, not on one of its implementations. It’s a sufficiently
general signal that having it on the interface is OK.

This is an API addition (RsdVehicle::invalidated), but not a break, as
RsdProxyVehicle still has the same signal (just provided by an interface
that it implements now, rather than by the class itself).

Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3722

If a VddAggregateVehicle has a fully-valid cache, but no subscriptions
to any attributes on backend vehicles (because no clients have
subscriptions to attributes on the aggregate vehicle), an incoming
request for an attribute will return a potentially stale value from the
cache, rather than querying the backends.

Fix this by invalidating the cache on incoming requests if suitable
subscriptions are not in place.

New API:
 • rsd_subscription_manager_has_subscription()

This adds an integration test for the failure seen in T2042.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3546

• Replace UNRELEASED with 0.4.0 in documentation
 • Update symbols files to include all 0.4.0 symbols
 • Bump library SONAME, rename packages accordingly
 • Update NEWS

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3534

Also fix the return type on one of the error paths to return a NULL
pointer instead of FALSE.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3521

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3520

Otherwise there is no way to free the memory inside an RsdAttribute
which is on the stack.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3517

Document that clients can expect to receive notifications about some
attributes which they have not subscribed to, if it is more efficient
for the server to emit those alongside attributes the client //has//
subscribed to.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3500

One of the test vectors below the comment tests timestamps.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3514

Eliminate a TODO.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3513

Make it a little clearer that they are logically two parts of the same
operation; an idempotent and a non-idempotent part.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3516

It does not make sense for a wildcard subscription to restrict its
signal emissions by period — a period criterion can only apply to a
single attribute, otherwise we can end up with pathological cases where
one attribute is emitted often enough to cause rate limiting; and all
other attributes are emitted rarely enough to be accidentally dropped on
one of the attribute emissions which is rate limited. RsdSubscription is
not set up to allow the emission rates for each attribute to be tracked
individually, which is what’s needed to implement period criteria for
wildcard attributes properly.

Instead, acknowledge that if the client has chosen to use a wildcard,
they aren’t particularly fussy about what attributes they receive, and
just give them everything, with no period limiting.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3509

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3504

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3503

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3491

It was never set anywhere. I think it’s a remnant from gnome-common.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3420

This will be used in a following commit.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3413

Merge the logging headers from the various parts of the codebase into a
single header in libinternal.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3408

Each vehicle has its own clock domain, which all timestamps for
attributes from that vehicle are relative to. This means that the
timestamps for two attributes from a given vehicle can be compared to
see which was updated more recently (and how much more recently, in
microseconds).

However, there was previously no way to compare timestamps between
vehicles, or to compare the timestamp for a given attribute to the
current time. Given that the clock domain for a vehicle could differ
arbitrarily from the system clock domain (g_get_monotonic_time()), this
meant that clients could never work out how long ago (in system clock
terms) an attribute was modified.

Fix that by exposing the current time in the vehicle’s clock domain with
the return value from each RsdVehicle getter which returns a property or
property metadata. This allows each attribute in those results to be
compared to the clock at the time of returning the results, to find out
how old that attribute value is, in microseconds.

This patch deliberately does not expose the current value of each
vehicle’s clock domain as a value by itself (for example, as a
get_current_time() method) as that would both tempt clients to poll it,
and would introduce unavoidable race conditions between getting the
current time and getting a set of attributes.

This breaks a lot of API.

The implementation in VddAggregateVehicle is worth paying attention to
when reviewing, as it needs to aggregate attributes from multiple
vehicles into a single aggregate vehicle. That means adjusting their
last-updated times to be in a single aggregate clock domain. This is
done by defining the aggregate clock domain to be g_get_monotonic_time()
and tracking the difference between that and each of the source
vehicles’ clocks with each value returned from those source vehicles.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3407

 • Replace UNRELEASED with 0.3.0 in documentation
 • Update symbols files to include all 0.3.0 symbols
 • Bump library SONAME, rename packages accordingly
 • Update NEWS

Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3183

For some of the upcoming code changes to consistently handle vehicles as
objects rather than sometimes as objects and sometimes as string IDs,
it’s necessary to have a construct-time ID for VddAggregateVehicle which
doesn’t depend on any of the aggregated vehicles.

The tidiest way to implement this is as a property on RsdVehicle, which
is then overridden by all implementations of RsdVehicle.

This breaks the API of vdd_aggregate_vehicle_new() (adding an `id`
parameter), and removes CsrVehicleService:vehicle-id in favour of the
overridden RsdVehicle:id property.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3181

The get_vehicle() function was returning a reference on the uncached
code path, but not returning one on the cached code path.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3179

These are wrappers around g_debug() and friends to simplify adding
G_STRFUNC.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3170

If there was an error in creating the object manager client,
self->client will be NULL, which doesn’t work so well when you try to
connect signal handlers to it.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Signed-off-by: Philip Withnall <philip.withnall@collabora.co.uk>
Differential Revision: https://phabricator.apertis.org/D3165