aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMike Frysinger <vapier@chromium.org>2015-09-24 11:32:37 -0400
committerMike Frysinger <vapier@chromium.org>2015-09-24 11:32:37 -0400
commit08a727d8f000419bc770dbf5c324dd64ec7b3e38 (patch)
treebf4fc4a8ff7f6746fc9ce4bb0a3fc66fa87626ce /docs
parentUpdate configure to look for README.md instead of README (diff)
downloadbreakpad-08a727d8f000419bc770dbf5c324dd64ec7b3e38.tar.xz
[Docs] Add wiki content to Markdown docs
BUG=none R=vapier@chromium.org, mseaborn@chromium.org Review URL: https://codereview.chromium.org/1356253003 .
Diffstat (limited to 'docs')
-rw-r--r--docs/how_to_contribute.md26
-rw-r--r--docs/projects_using_lss.md5
2 files changed, 31 insertions, 0 deletions
diff --git a/docs/how_to_contribute.md b/docs/how_to_contribute.md
new file mode 100644
index 00000000..5a232cc5
--- /dev/null
+++ b/docs/how_to_contribute.md
@@ -0,0 +1,26 @@
+# How to get an LSS change committed
+
+## Review
+
+You get your change reviewed, you can upload it to
+http://codereview.chromium.org (Rietveld) using `git cl upload` from Chromium's
+`depot-tools`.
+
+## Testing
+
+Unfortunately, LSS has no automated test suite.
+
+You can test LSS by patching it into Chromium, building Chromium, and running
+Chromium's tests. (See [ProjectsUsingLSS](projects_using_lss.md).)
+
+You can compile-test LSS by running:
+
+ gcc -Wall -Wextra -Wstrict-prototypes -c linux_syscall_support.h
+
+## Rolling into Chromium
+
+If you commit a change to LSS, please also commit a Chromium change to update
+`lss_revision` in Chromium's DEPS file.
+
+This ensures that the LSS change gets tested, so that people who commit later
+LSS changes don't run into problems with updating `lss_revision`.
diff --git a/docs/projects_using_lss.md b/docs/projects_using_lss.md
new file mode 100644
index 00000000..f3eda6f0
--- /dev/null
+++ b/docs/projects_using_lss.md
@@ -0,0 +1,5 @@
+# Projects that use linux\_syscall\_support.h
+
+* Chromium
+* Breakpad (built as part of Chromium)
+* Native Client, in nacl\_bootstrap.c (also built as part of Chromium)