New issue
Advanced search Search tips
Note: Color blocks (like or ) mean that a user may not be available. Tooltip shows the reason.

Issue 618411 link

Starred by 1 user

Issue metadata

Status: Fixed
Owner:
Last visit > 30 days ago
Closed: Jun 2016
Cc:
Components:
EstimatedDays: ----
NextAction: ----
OS: All
Pri: 3
Type: Bug



Sign in to add a comment

Document //services/shell

Project Member Reported by scheib@chromium.org, Jun 8 2016

Issue description

Add services/shell/README
Revisit 
services/shell/public/cpp/shell_client.h
services/shell/public/interfaces/shell.mojom
services/shell/shell.h class Shell
services/README.md

Describe terms 'shell', 'instance', and provide context and examples of subclasses demonstrating what these concepts mean.

There are loose design docs that should be referenced from the code. e.g. 
https://docs.google.com/document/d/1U7mcQ2o25KgXfEuJSIXQUpEF6Y9134ysaqSNUcmR-ZI/edit#heading=h.u4fykshye0eb

https://docs.google.com/document/d/15I7sQyQo6zsqXVNAlVd520tdGaS8FCicZHrN0yRu-oU/edit#heading=h.p37l9e7o0io5 
 

Comment 1 by jam@chromium.org, Jun 8 2016

Cc: jam@chromium.org
Owner: ben@chromium.org
Vincent: the mojo docs are at https://www.chromium.org/developers/design-documents/mojo

Ben: you wrote the shell doc, it should probably be on https://www.chromium.org/developers/design-documents/mojo right?

Comment 2 by ben@chromium.org, Jun 8 2016

Status: Fixed (was: Assigned)
I added a link to the Mojo Shell user guide from the mojo design doc page.

While there probably should be a design doc describing the implementation of the Shell itself, I consider that a lower priority right now given how little there is to it. I'll eventually get around to it.
Thanks, though I think the //services/ directory README warrants improvement.

Comment 4 by ben@chromium.org, Jun 8 2016

What's unclear?
Project Member

Comment 5 by bugdroid1@chromium.org, Jun 9 2016

The following revision refers to this bug:
  https://chromium.googlesource.com/chromium/src.git/+/3009e4ca38a82a09f8202c5dd86ad5a9179e0a1c

commit 3009e4ca38a82a09f8202c5dd86ad5a9179e0a1c
Author: jam <jam@chromium.org>
Date: Thu Jun 09 16:34:05 2016

Add pointers from README files in /services to documentation on the wiki and in docs.

BUG= 618411 

Review-Url: https://codereview.chromium.org/2049973002
Cr-Commit-Position: refs/heads/master@{#398906}

[modify] https://crrev.com/3009e4ca38a82a09f8202c5dd86ad5a9179e0a1c/services/README.md
[add] https://crrev.com/3009e4ca38a82a09f8202c5dd86ad5a9179e0a1c/services/shell/README.md

Project Member

Comment 6 by bugdroid1@chromium.org, Jun 15 2016

The following revision refers to this bug:
  https://chromium.googlesource.com/chromium/src.git/+/3009e4ca38a82a09f8202c5dd86ad5a9179e0a1c

commit 3009e4ca38a82a09f8202c5dd86ad5a9179e0a1c
Author: jam <jam@chromium.org>
Date: Thu Jun 09 16:34:05 2016

Add pointers from README files in /services to documentation on the wiki and in docs.

BUG= 618411 

Review-Url: https://codereview.chromium.org/2049973002
Cr-Commit-Position: refs/heads/master@{#398906}

[modify] https://crrev.com/3009e4ca38a82a09f8202c5dd86ad5a9179e0a1c/services/README.md
[add] https://crrev.com/3009e4ca38a82a09f8202c5dd86ad5a9179e0a1c/services/shell/README.md

Sign in to add a comment