summaryrefslogtreecommitdiff
path: root/utils/codegen/ipc/mojo/public/tools/mojom/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'utils/codegen/ipc/mojo/public/tools/mojom/README.md')
-rw-r--r--utils/codegen/ipc/mojo/public/tools/mojom/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/utils/codegen/ipc/mojo/public/tools/mojom/README.md b/utils/codegen/ipc/mojo/public/tools/mojom/README.md
new file mode 100644
index 00000000..e5d17ab0
--- /dev/null
+++ b/utils/codegen/ipc/mojo/public/tools/mojom/README.md
@@ -0,0 +1,14 @@
+# The Mojom Parser
+
+The Mojom format is an interface definition language (IDL) for describing
+interprocess communication (IPC) messages and data types for use with the
+low-level cross-platform
+[Mojo IPC library](https://chromium.googlesource.com/chromium/src/+/main/mojo/public/c/system/README.md).
+
+This directory consists of a `mojom` Python module, its tests, and supporting
+command-line tools. The Python module implements the parser used by the
+command-line tools and exposes an API to help external bindings generators emit
+useful code from the parser's outputs.
+
+TODO(https://crbug.com/1060464): Fill out this documentation once the library
+and tools have stabilized.