Skip to content

Commit

Permalink
Update Mojo and services documentation
Browse files Browse the repository at this point in the history
This is a large update to all Mojo and services documentation in the
tree. Here are the changes in a nutshell:

- Images for Mojo docs are upstreamed instead of being pulled from
  docs.google.com
- Various minor updates, corrections, clarifications in core Mojo
  docs
- Consolidation of documents in the tree.
- Refresh of all service and Service Manager related documentation,
  removing lots of outdated information, adding clarifying definitions
  and examples of core concepts

As of this CL, the relevant documentation in the tree is pared down
to:

- The mojo/ subtree itself
- services/README.md - service guidelines
- services/service_manager/README.md - general service manager
  and service API documentation, examples, etc
- docs/mojo_and_services.md - intro to mojo & services for
  chromium developers
- docs/mojo_ipc_conversion.md - advice for converting legacy IPCs
  to mojo interfaces
- docs/servicification.md - advice for servicifying chromium
  features specifically

Specifically this wipes out content/public/common/services.md,
ipc/README.md, services/service_manager/service_manifests.md, and
services/api_standards.md. Any still-relevant content that was in
these docs has been merged into one of the docs listed above.

Finally, the presence in docs/README.md has been cleaned up a bit.
A new section for "Mojo & Services" is added with links to the above
list of documents.

Change-Id: I294a32025afdca62441d3605da51d714f3aebd00
TBR: jam@chromium.org
Reviewed-on: https://chromium-review.googlesource.com/c/1441640
Commit-Queue: Ken Rockot <rockot@google.com>
Reviewed-by: Oksana Zhuravlova <oksamyt@chromium.org>
Cr-Commit-Position: refs/heads/master@{#629384}
  • Loading branch information
krockot authored and Commit Bot committed Feb 6, 2019
1 parent bb00c14 commit ab03512
Show file tree
Hide file tree
Showing 21 changed files with 2,635 additions and 2,252 deletions.
65 changes: 0 additions & 65 deletions content/public/common/services.md

This file was deleted.

15 changes: 14 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,20 @@ used when committed.
install Chromium OS on VMWare.
* [User Data Directory](user_data_dir.md) - How the user data and cache
directories are determined on all platforms.
* [Mojo](../mojo/README.md) - IPC mechanism used by services.

### Mojo &amp; Services
* [Intro to Mojo &amp; Services](mojo_and_services.md) - Quick introduction
to Mojo and services in Chromium, with examples
* [Mojo API Reference](/mojo/README.md) - Detailed reference documentation for
all things Mojo
* [The Service Manager &amp; Services](/services/service_manager/README.md) -
Services system overview, API references, example services
* [Service Development Guidelines](/services/README.md) - Guidelines for
service development in the Chromium tree
* [Servicifying Chromium Features](servicification.md) - General advice for
integrating new and existing subsystems into Chromium as services
* [Converting Legacy IPC to Mojo](mojo_ipc_conversion.md) - Tips and common
patterns for practical IPC conversion work

### Probably Obsolete
* [TPM Quick Reference](tpm_quick_ref.md) - Trusted Platform Module notes.
Expand Down
Binary file added docs/images/mojo_binding_and_dispatch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/mojo_message.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/mojo_pipe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/mojo_stack.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/mojo_sync_call_deadlock.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/mojo_sync_call_flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit ab03512

Please sign in to comment.