diff --git a/OWNERS b/OWNERS index 01304f83dc..587c130ed7 100644 --- a/OWNERS +++ b/OWNERS @@ -13,8 +13,5 @@ per-file AUTHORS=* per-file DEPS=* per-file pylintrc=mbonadei@webrtc.org per-file WATCHLISTS=* -per-file abseil-in-webrtc.md=danilchap@webrtc.org -per-file abseil-in-webrtc.md=mbonadei@webrtc.org -per-file style-guide.md=danilchap@webrtc.org per-file native-api.md=mbonadei@webrtc.org per-file *.lua=titovartem@webrtc.org diff --git a/README.md b/README.md index 0a7b5ea043..0b290fd17c 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ native API header files. * Samples and reference apps: https://github.com/webrtc * Mailing list: http://groups.google.com/group/discuss-webrtc * Continuous build: https://ci.chromium.org/p/webrtc/g/ci/console - * [Coding style guide](style-guide.md) + * [Coding style guide](g3doc/style-guide.md) * [Code of conduct](CODE_OF_CONDUCT.md) * [Reporting bugs](docs/bug-reporting.md) diff --git a/api/README.md b/api/README.md index 4cc799362d..7c1a27f512 100644 --- a/api/README.md +++ b/api/README.md @@ -1,6 +1,6 @@ # How to write code in the `api/` directory -Mostly, just follow the regular [style guide](../style-guide.md), but: +Mostly, just follow the regular [style guide](../g3doc/style-guide.md), but: * Note that `api/` code is not exempt from the “`.h` and `.cc` files come in pairs” rule, so if you declare something in `api/path/to/foo.h`, it should be @@ -17,7 +17,7 @@ it from a `.cc` file, so that users of our API headers won’t transitively For headers in `api/` that need to refer to non-public types, forward declarations are often a lesser evil than including non-public header files. The -usual [rules](../style-guide.md#forward-declarations) still apply, though. +usual [rules](../g3doc/style-guide.md#forward-declarations) still apply, though. `.cc` files in `api/` should preferably be kept reasonably small. If a substantial implementation is needed, consider putting it with our non-public diff --git a/g3doc/OWNERS b/g3doc/OWNERS index 050db7f933..9ece35c39b 100644 --- a/g3doc/OWNERS +++ b/g3doc/OWNERS @@ -1,2 +1,5 @@ titovartem@webrtc.org +per-file abseil-in-webrtc.md=danilchap@webrtc.org +per-file abseil-in-webrtc.md=mbonadei@webrtc.org +per-file style-guide.md=danilchap@webrtc.org diff --git a/abseil-in-webrtc.md b/g3doc/abseil-in-webrtc.md similarity index 96% rename from abseil-in-webrtc.md rename to g3doc/abseil-in-webrtc.md index 7bed46cd97..692ebe2b0b 100644 --- a/abseil-in-webrtc.md +++ b/g3doc/abseil-in-webrtc.md @@ -1,5 +1,8 @@ # Using Abseil in WebRTC + + + You may use a subset of the utilities provided by the [Abseil][abseil] library when writing WebRTC C++ code. Below, we list the explicitly *allowed* and the explicitly *disallowed* subsets of Abseil; if you diff --git a/g3doc/sitemap.md b/g3doc/sitemap.md index 51b27e178b..378333d5d8 100644 --- a/g3doc/sitemap.md +++ b/g3doc/sitemap.md @@ -1,6 +1,7 @@ * [Home](/g3doc/index.md) * How to contribute * Code + * [Style guide](/g3doc/style-guide.md) * [Documentation](/g3doc/how_to_write_documentation.md) * [Public C++ API](/api/g3doc/index.md) * [Threading](/api/g3doc/threading_design.md) diff --git a/style-guide.md b/g3doc/style-guide.md similarity index 99% rename from style-guide.md rename to g3doc/style-guide.md index 6c3ddef8af..f3b0e8869d 100644 --- a/style-guide.md +++ b/g3doc/style-guide.md @@ -1,5 +1,8 @@ # WebRTC coding style guide + + + ## General advice Some older parts of the code violate the style guide in various ways. diff --git a/style-guide/OWNERS b/g3doc/style-guide/OWNERS similarity index 100% rename from style-guide/OWNERS rename to g3doc/style-guide/OWNERS diff --git a/style-guide/h-cc-pairs.md b/g3doc/style-guide/h-cc-pairs.md similarity index 92% rename from style-guide/h-cc-pairs.md rename to g3doc/style-guide/h-cc-pairs.md index 1a24e49d09..bb85871260 100644 --- a/style-guide/h-cc-pairs.md +++ b/g3doc/style-guide/h-cc-pairs.md @@ -1,5 +1,8 @@ # `.h` and `.cc` files come in pairs + + + This is an overflow page for [this](../style-guide.md#h-cc-pairs) style rule.