From 444d49d0246546896e0d79a1c7223984ad8e85a7 Mon Sep 17 00:00:00 2001
From: "P.Y. Laligand" <pylaligand@google.com>
Date: Thu, 18 Jan 2018 10:50:15 -0800
Subject: [PATCH] [build] Add documentation for the generation of GN build
 files.

TO-562

Change-Id: I159ee8ae73d05bbf42c3e64238b16ab82e2e634f
---
 .gitignore       |  3 ++-
 public/README.md | 12 ++++++++++++
 2 files changed, 14 insertions(+), 1 deletion(-)
 create mode 100644 public/README.md

diff --git a/.gitignore b/.gitignore
index 45de3e97917..dea1e7f3501 100644
--- a/.gitignore
+++ b/.gitignore
@@ -28,4 +28,5 @@ compile_commands.json
 /prebuilt/config.mk
 /prebuilt/config.mk.bak
 /AnalysisResult/
-/public/
+/public/lib/
+/public/sysroot/
diff --git a/public/README.md b/public/README.md
new file mode 100644
index 00000000000..f656ee9df74
--- /dev/null
+++ b/public/README.md
@@ -0,0 +1,12 @@
+GN integration for Zircon
+=========================
+
+This directory hosts generated GN files for Zircon. These files are created by
+`//build/zircon/create_gn_rules.py` and should never be manually edited.
+
+In order to expose a Zircon module to GN, set the `MODULE_PACKAGE` attribute in
+its `rules.mk` build file. The possible values are:
+ - `src`: the module's sources are published;
+ - `so`: the module is exposed as a precompiled shared library;
+ - `a`: the module is exposed as a precompiled static library;
+Note that this currently only applies to `ulib` modules.
-- 
GitLab