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)