Chromium Code Reviews| Index: components/README |
| diff --git a/components/README b/components/README |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..e8f6ff9b7a9163201ede9f7cf49f6eb157b206ec |
| --- /dev/null |
| +++ b/components/README |
| @@ -0,0 +1,32 @@ |
| +This directory is for components that have the Content Module as the |
| +uppermost layer they depend on. They may depend only on the Content |
| +API (content/public) and on lower layers (e.g. base/, net/, ipc/ |
| +etc.). |
| + |
| +Components that have bits of code that need to live in different |
| +processes (e.g. some code in the browser process, some in the renderer |
| +process, etc.) should separate the code into different subdirectories. |
| +Hence for a component named 'foo' you might end up with a structure |
| +like the following: |
| + |
| +components/foo - DEPS, OWNERS, foo.gypi |
| +components/foo/browser - code that needs the browser process |
| +components/foo/common - for e.g. IPC constants and such |
| +components/foo/renderer - code that needs renderer process |
| + |
| +These subdirectories should have DEPS files with the relevant |
| +restrictions in place, i.e. only components/*/browser should |
| +be allowed to #include from content/public/browser. |
| + |
| +Note that there may also be an 'android' subdir, with a Java source |
| +code structure underneath it where the package name is |
| +org.chromium.components.foo, and with subdirs after 'foo' |
| +to illustrate process, e.g. 'browser' or 'renderer': |
| + |
| +components/foo/android/OWNERS, DEPS |
| +components/foo/android/java/src/org/chromium/components/foo/browser/ |
| +components/foo/android/javatests/src/org/chromium/components/foo/browser/ |
| + |
| +The code in each component, or group of components, should be placed |
|
Jói
2012/12/19 14:35:20
Note: The previous decision, when content/compone
jam
2012/12/19 17:12:58
the convention for namespaces has been that every
Jói
2012/12/20 15:16:32
OK, let's go with components:: as the namespace.
|
| +in a namespace named for the component, e.g. a component |
| +components/foo might use the namespace foo::. |