| Summary: | auto-starting and SystemdService are not documented in the spec | ||
|---|---|---|---|
| Product: | dbus | Reporter: | Simon McVittie <smcv> |
| Component: | core | Assignee: | Simon McVittie <smcv> |
| Status: | RESOLVED FIXED | QA Contact: | D-Bus Maintainers <dbus> |
| Severity: | normal | ||
| Priority: | medium | CC: | bugzilla |
| Version: | git master | Keywords: | patch |
| Hardware: | Other | ||
| OS: | All | ||
| Whiteboard: | review? | ||
| i915 platform: | i915 features: | ||
| Bug Depends on: | |||
| Bug Blocks: | 98666 | ||
| Attachments: |
Spec: be clearer about what activation means
Spec: document what auto-starting is, and recommend it Spec: document systemd activation Spec: mostly use versioned interface and bus names Spec: be clearer about "starting" and "activation" being synonyms |
||
|
Description
Simon McVittie
2016-11-10 11:54:04 UTC
> Please review there if interested.
Interested. Reviewed there.
Created attachment 128107 [details] [review] Spec: be clearer about what activation means The spec previously mentioned that CORBA calls this activation, but did not explicitly say that D-Bus has copied this jargon term. It's 2016, and developers are probably more likely to be familiar with D-Bus than with CORBA at this point: explicitly say that *our* jargon term for this action is activation. --- This is mainly a response to the suggestion on Bug #98666 that the meaning of "activation" was insufficiently clear. Created attachment 128108 [details] [review] Spec: document what auto-starting is, and recommend it For something we recommend, that is important enough to have its own header flag, it doesn't have very good documentation. Redo the text to suggest that auto-starting is the normal thing and StartServiceByName is the oddity. That's usually a good principle to follow, since it dodges time-of-check/time-of-use issues, and the method call that you presumably wanted to do needs to handle errors anyway. --- Supersedes Attachment #127878 [details] Created attachment 128109 [details] [review] Spec: document systemd activation We didn't say that SystemdService existed. Now we do, together with enough context to make it make sense. --- Supersedes Attachment #127879 [details]. Philip already reviewed this one. Created attachment 128110 [details] [review] Spec: mostly use versioned interface and bus names Using versioned names here reinforces the advice given in <https://dbus.freedesktop.org/doc/dbus-api-design.html#api-versioning>. I haven't added versions to the sample parameters "com.example.tea" and "com.example.cappuccino" for methods that query information about names, on the basis that I assume they are more likely to be intended to represent an implementation than an API. --- As Philip suggested on Bug #98666. Comment on attachment 128107 [details] [review] Spec: be clearer about what activation means Review of attachment 128107 [details] [review]: ----------------------------------------------------------------- Looks good. Comment on attachment 128108 [details] [review] Spec: document what auto-starting is, and recommend it Review of attachment 128108 [details] [review]: ----------------------------------------------------------------- r+ Comment on attachment 128109 [details] [review] Spec: document systemd activation Review of attachment 128109 [details] [review]: ----------------------------------------------------------------- r+ as before. Comment on attachment 128110 [details] [review] Spec: mostly use versioned interface and bus names Review of attachment 128110 [details] [review]: ----------------------------------------------------------------- +1, all over the specification. Fixed in git for spec 0.30 (dbus 1.11.8). Thanks for reviewing. Reopening, one more patch... Created attachment 128143 [details] [review] Spec: be clearer about "starting" and "activation" being synonyms --- Philip, does this address your concern on Bug #98666 about it being insufficiently clear that "activation" and "starting" are the same thing? Comment on attachment 128143 [details] [review] Spec: be clearer about "starting" and "activation" being synonyms Review of attachment 128143 [details] [review]: ----------------------------------------------------------------- r+ Fixed (again) for spec 0.30, 1.11.8 |
Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.